Reference
All Reference
Model to access the localStorage on the client (browser).
Model to access the sessionStorage on the client (browser).
Accesses comments on a page.
Zotonic has two places where a site’s configuration is kept:
Site configuration parameter was changed
Site configuration parameter was changed
Not yet documented.
Not yet documented.
Not yet documented.
Translates a string to a md5 hex value.
Not yet documented.
Access information about page connections.
Show embed, video or audio media.
Filter a list of media items by their medium_language property, return the best matching with the current or given…
Try to find a filename extension for a mime type (example: “.jpg”)
Try to identify a file, returning a map with file properties.
Notification to translate or map a file after upload, before insertion into the database Used in mod_video to queue…
Notification to import a medium record from external source. This is called for non-file medium records, for example…
Notification to translate or map a file after upload, before insertion into the database Used in mod_video to queue…
media_identify_extension media_identify_file media_import media_import_medium media_preview_options media_import_props…
Modify the options for an image preview url or tag. This is called for every image url generation, except if the…
Notification that a medium file has been changed (notify) The id is the resource id, medium contains the medium’s…
See if there is a ‘still’ image preview of a media item. (eg posterframe of a movie) Return:: {ok, ResourceId} or…
Media update done notification. action is ‘insert’, ‘update’ or ‘delete’
Notification to translate or map a file after upload, before insertion into the database Used in mod_video to queue…
Notification that a medium file has been uploaded. This is the moment to change properties, modify the file etc. The…
Notification that a medium file has been uploaded. This is the moment to change resource properties, modify the file…
Request to generate a HTML media viewer for a resource
Optionally wrap HTML with external content so that it adheres to the cookie/privacy settings of the current site…
Not yet documented.
DomainKeys Identified Mail Signatures (RFC 6376) is a method to add a signature to outgoing emails. This enables…
Not yet documented.
Tracks the send/bounce/error status of all outgoing emails.
Finds a value in a list.
Show a page menu.
menu_flat menu_ids menu_is_visible menu_expand menu_rsc menu_subtree menu_trail
Takes a menu, or a menu resource id, and adds all haspart objects connected to the menu ids.
Flattens the rsc menu structure for use in a template loop.
Returns all resource ids in a menu. Could return invisible and non existing resource ids. The returned ids are a flat…
Filters a list of menu items on visibility and existance. Only top-level menu items that are both visible and exist are…
Return the menu to be displayed with a resource.
Fetch the menu id belonging to a certain resource
Save the menu tree of a menu resource
Get the subtree of an id in a menu (if any).
Return a breadcrumb navigation trail for the given id.
Not yet documented.
The filestore uses two tables for its administration.
Model to start uploads, upload a block and delete uploads.
The category hierarchy tables have been replaced by m_hierarchy . This model defines named hierarchies of resources…
Delegates the request processing.
The m_identity model manages usernames and other user identities. mod_authentication uses it to store and check salted…
Manages the medium_edit_settings property for non destructive image editing.
Not yet documented.
Take the minimum of the filter value and its first argument.
Force the given value in the given range.
gravatar_code ip2country ip2geo is_letsencrypt_valid_hostname format_dispatch_controller_option…
Not yet documented.
Not yet documented.
Not yet documented.
Not yet documented.
Not yet documented.
Not yet documented.
Access to data about uploaded files and other media.
Check with useauth if the authentication using the Microsoft identity platform is enabled and configured.
Access information about which modules are installed and which ones are active.
A ticketing system for out of band MQTT posts via HTTP.
Not yet documented.
Not yet documented.
Not yet documented.
Mocking module for access control during tests.
This module adds rule-based access control.
Extending the admin menu See m_admin_menu on how to extend the admin menu.
Add support for editing Categories in the admin, by presenting an editable category tree at http://yoursite.com/admin…
Add support for editing the site’s configuration values, as accessed through m_config.
Adds editing of resources, menu-trees and collections for non-admin users.
Provides identity management in the admin - for example the storage of usernames and passwords.
Adds functonality to merge two pages together into a single page.
Adds support in the admin for activating and deactivating modules.
Add support for editing predicates in the admin, by presenting a list of all defined predicates on http://yoursite.com…
This module contains many useful icons and images.
Adds support for viewing and handling audio medium items.
This module contains the main Zotonic authentication mechanism. It contains the logon and logoff controllers, and…
mod_backup serves two different purposes: it makes a nightly backup of your files and database, and can also backup…
mod_base is the base module, which acts as a container module holding most of Zotonic basic dispatch rules, Actions and…
Adds support for the Twitter Bootstrap CSS / JavaScript framework.
Uses clamd to scan all uploaded files for viruses.
Implements a basic commenting system, enabling commenting on resources.
Implements a basic contact form, which gets emailed to the configuration value mod_contact.email , when submitted.
Wrap external content in such a way that it is only loaded if the user consented to the inclusion of the content (and…
Provides periodic events.
Enables redirects from unknown hosts and paths to other locations. The other location can be a known path or another…
Presents various tools for development.
Adds wysiwyg tinyMCE editors to the admin.
Signs outgoing e-mails with DomainKeys Identified Mail Signatures ( RFC 6376).
Enables the Zotonic site to receive emails for the site’s users. The user’s email address is username@hostname , where…
Enables the Zotonic site to relay emails for the site’s users to their real email addresses.