Reference

All Reference

mod_cookie_consent

Wrap external content in such a way that it is only loaded if the user consented to the inclusion of the content (and…

mod_copyright

Module for copyright metadata, rights statements, and attribution helpers.

mod_cron

Provides periodic tick notifications and module-defined cron job scheduling.

mod_custom_redirect

Enables redirects from unknown hosts and paths to other locations. The other location can be a known path or another…

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_receive

Enables the Zotonic site to receive emails for the site’s users. The user’s email address is username@hostname, where…

mod_email_relay

This module supports relaying email between Zotonic servers.

mod_email_status

This module tracks for all outgoing email addresses:

mod_export

Provides a generic framework to export resources.

mod_facebook

The mod_facebook module plugs into the authentication system to enable Facebook login on your site.

mod_filestore

Support for storing uploaded and generated images and documents on external services.

mod_fileuploader

Upload files using a parallel web worker.

mod_geoip

Used to map IP addresses to geographical locations.

mod_image_edit

Non destructive edits of images.

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. Localization module providing locale, country

mod_linkedin

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

mod_logging

Logs messages to the database and adds log views to the admin.

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

Create nested navigation menus for your site.

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_oauth2

OAuth2 provider module for app/client/token management and authorization flows.

mod_oembed

Makes media resources from embeddable URLs through the OEmbed protocol.

mod_ratelimit

Implements rate limiting for various resources.

mod_search

mod_search implements various ways of searching through the main resource table using m_search.

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

The mod_ssl_ca module adds support for using SSL certificates bought from a Certificate Authority.

mod_ssl_letsencrypt

Request certificates from Let’s Encrypt.

mod_survey

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

mod_syslog

Syslog integration module for forwarding Zotonic log events to external syslog services.

mod_tkvstore

Simple (type,key)/value store. Stores data in the store with minimal latency and (local) serialization of get/put…

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

Adds support for viewing and handling video medium items.

mod_video_embed

This module, if activated, checks the pasted URLs in the create media / page dialog of the admin. It will show an embed…

mod_wires

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

mod_zotonic_site_management

Site management module for creating, configuring, and controlling managed Zotonic sites.

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

A validator to check whether a resource’s name is unique:

ne_day

Tests if two dates are not equal.

normalize_email

Normalize an email address, used in the identity management.

Notifications

alert confirm growl

now

See also

nthtail

Fetch the nth tail of a list.

Numbers

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

numericality

Numerical input and range check.

oauth2

Model for OAuth2 app/client/token administration and user token listings.

oauth2_consumer

Model for OAuth2 consumer configuration and token access, including consumer lists and per-consumer token retrieval.

oauth2_service

Model for OAuth2 service flow helpers, including redirect URL generation and oauth redirect processing.

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