Reference

All Reference

mod_development

Presents various tools for development.

mod_editor_tinymce

Adds wysiwyg tinyMCE editors to the admin.

mod_email_dkim

Signs outgoing e-mails with DomainKeys Identified Mail Signatures ( RFC 6376).

mod_email_status

This module tracks for all outgoing email addresses:

mod_export

Provides a generic framework to export resources.

mod_fileuploader

Upload files using a parallel web worker.

mod_geoip

Used to map IP addresses to geographical locations.

mod_import_csv

Module which adds “import CSV” button to the admin status screen.

mod_import_wordpress

Import WordPress .wxr files in your site.

mod_l10n

Localization of Zotonic. Provides lookups for country, month, week names.

mod_linkedin

The mod_linkedin module plugs into the authentication systen to enable LinkedIn login on your site.

mod_logging

See also

mod_mailinglist

This module implements a mailing list system. You can make as many mailing lists as you like and send any page to any…

mod_media_exif

When uploading a file, this module extracts properties from the uploaded media and sets them in the resource.

mod_menu

See also

mod_microsoft

Adds logon using the Microsoft identity platform.

mod_mqtt

MQTT is a machine-to-machine (M2M)/“Internet of Things” connectivity protocol. It was designed as an extremely…

mod_oembed

See also

mod_ratelimit

Implements rate limiting for various resources.

mod_search

See also

mod_seo

Adds basic search engine optimization to the base templates and provides an admin interface for configuring SEO options…

mod_seo_sitemap

Creates a sitemap.xml file for your site, containing links to all publicly accessible pages.

mod_server_storage

Server side storage for the client (aka browser) and server.

mod_signup

This module presents an interface for letting users register themselves.

mod_site_update

This module pulls updates of a site‘s code from a remote version control system. The supported version control systems…

mod_ssl_ca

See also

mod_survey

Adds the concept of survey resources: user-definable forms which can be created in the admin interface and filled out…

mod_translation

This module provides support for dealing with multiple languages.

module_rescan

Rescans all modules, to find all templates, lib files, dispatch rules, etc. again.

modules

Access information about which modules are installed and which ones are active.

Modules (Admin)

module_rescan module_toggle

module_toggle

Activate/deactivate a module in the module manager in the admin interface.

mod_video

See also

mod_wires

Actions, tags (also known as screen components), and javascript for user interfaces using wires .

moreresults

Show more results of the current search query inline on the page.

move

Move an element to another place, appending it to the target. The element is given by id with the element argument, or…

mqtt_ticket

A ticketing system for out of band MQTT posts via HTTP.

name_unique

See also

ne_day

See also

normalize_email

Normalize an email address, used in the identity management.

Notifications

alert confirm growl

now

See also

nthtail

See also

Numbers

filesizeformat format_duration format_integer format_number format_price is_even is_number max min minmax rand round…

oauth2

Not yet documented.

oauth2_consumer

Not yet documented.

oauth2_service

Not yet documented.

observe_acl_collab_groups_modify/3

Modify the list of collaboration groups of a user. Called internally by the ACL modules when fetching the list of…

observe_acl_context_authenticated/2

Set the context to a typical authenticated user. Used by m_acl.erl

observe_acl_is_allowed/2

Check if a user is authorized to perform an operation on a an object (some resource or module). Observe this…

observe_acl_is_allowed_prop/2

Check if a user is authorizded to perform an action on a property. Defaults to true .

observe_acl_is_owner/2

Check if a user is the owner of a resource. id is the resource id.

observe_acl_logoff/2

Clear the associated access policy for the context.

observe_acl_logon/2

Initialize context with the access policy for the user.

observe_acl_user_groups/2

Return the groups for the current user.

observe_acl_user_groups_modify/3

Modify the list of user groups of a user. Called internally by the ACL modules when fetching the list of user groups a…

observe_action_event_type/2

Render the javascript for a custom action event type. The custom event type must be a tuple, for example: `{% wire…

observe_activity/2

An activity in Zotonic. When this is handled as a notification then return a list of patterns matching this activity.

observe_activity_send/2

Push a list of activities via a ‘channel’ (eg ‘email’) to a recipient. The activities are a list of

observe_admin_edit_blocks/3

Used in the admin to fetch the possible blocks for display

observe_admin_menu/3

Used for fetching the menu in the admin.

observe_admin_rscform/3

Used in the admin to process a submitted resource form

observe_auth_checked/2

Notify after logon of user with username, communicates valid or invalid password

observe_auth_client_logon_user/2

Send a request to the client to login a user. The zotonic.auth.worker.js will

observe_auth_client_switch_user/2

Send a request to the client to switch users. The zotonic.auth.worker.js will

observe_auth_confirm/3

Confirm a user id.

observe_auth_confirm_done/2

A user id has been confirmed.

observe_auth_identity_types/3

Return the list of identity types that allow somebody to logon and become an active user of the system. Defaults to […

observe_auth_logoff/3

User is about to log off. Modify (if needed) the logoff request context.

observe_auth_logon/3

User logs on. Add user-related properties to the logon request context.

observe_auth_options_update/3

Update the given (accumulator) authentication options with the request options.

observe_auth_postcheck/2

First for logon of user with username, called after successful password check.

observe_auth_precheck/2

First for logon of user with username, check for ratelimit, blocks etc.

observe_auth_reset/2

First to check for password reset forms, return undefined, ok, or \{error, Reason\}.

observe_auth_validate/2

First to validate a password. Return \{ok, RscId\} or \{error, Reason\}.

observe_auth_validated/2

Authentication against some (external or internal) service was validated

observe_category_hierarchy_save/2

Save (and update) the complete category hierarchy

observe_comment_insert/2

Notification to signal an inserted comment. ‘comment_id’ is the id of the inserted comment, ‘id’ is the id of the…

observe_content_security_header(Default, Acc, Context)

Check and possibly modify the http response security headers All headers are in lowercase.

observe_content_types_dispatch/3

Get available content types and their dispatch rules Example: \{\{<<”text”>>, <<”html”>>, [\]\}, page\} A special…

observe_cors_headers/2

Set CORS headers on the HTTP response.

observe_custom_pivot/2

Add custom pivot fields to a resource’s search index (map) Result is a single tuple or list of tuples `{pivotname

observe_debug/2

Push some information to the debug page in the user-agent. Will be displayed with io_lib:format(“~p: ~p~n”, [What

observe_dispatch/2

Final try for dispatch, try to match the request. Called when the site is known, but no match is found for the path

observe_dispatch_host/2

Try to find the site for the request Called when the request Host doesn’t match any active site.

observe_dispatch_rewrite/3

Rewrite a URL before it will be dispatched using the z_sites_dispatcher

observe_dropbox_file/2

Handle a new file received in the ‘files/dropbox’ folder of a site. Unhandled files are deleted after an hour. If the…