Documentation

All Documentation

Menu

menu_flat menu_ids menu_is_visible menu_expand menu_rsc menu_subtree menu_trail

menu

Show a page menu.

menu_expand

Takes a menu, or a menu resource id, and adds all haspart objects connected to the menu ids.

menu_flat

Flattens the rsc menu structure for use in a template loop.

menu_ids

Returns all resource ids in a menu. Could return invisible and non existing resource ids. The returned ids are a flat…

menu_is_visible

Filters a list of menu items on visibility and existance. Only top-level menu items that are both visible and exist are…

menu_rsc

Return the menu to be displayed with a resource.

menu_rsc

Fetch the menu id belonging to a certain resource

menu_save

Save the menu tree of a menu resource

menu_subtree

Get the subtree of an id in a menu (if any).

menu_trail

Return a breadcrumb navigation trail for the given id.

merge_tags

A mail-merge like filter where tag-expressions in a text are replaced with the value of their evaluation.

m_facebook

Not yet documented.

m_filestore

The filestore uses two tables for its administration.

m_fileuploader

Model to start uploads, upload a block and delete uploads.

m_hierarchy

The category hierarchy tables have been replaced by m_hierarchy . This model defines named hierarchies of resources…

middleware

Delegates the request processing.

m_identity

The m_identity model manages usernames and other user identities. mod_authentication uses it to store and check salted…

m_image_edit

Manages the medium_edit_settings property for non destructive image editing.

m_import_csv_data

Not yet documented.

min

Take the minimum of the filter value and its first argument.

minmax

Force the given value in the given range.

Miscellaneous

gravatar_code ip2country ip2geo is_letsencrypt_valid_hostname format_dispatch_controller_option…

m_l10n

Not yet documented.

m_linkedin

Not yet documented.

m_log

Not yet documented.

m_log_email

Not yet documented.

m_log_ui

Not yet documented.

m_mailinglist

Not yet documented.

m_media

Access to data about uploaded files and other media.

m_microsoft

Check with useauth if the authentication using the Microsoft identity platform is enabled and configured.

m_modules

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

m_mqtt_ticket

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

m_oauth2

Not yet documented.

m_oauth2_consumer

Not yet documented.

m_oauth2_service

Not yet documented.

mod_acl_mock

Mocking module for access control during tests.

mod_acl_user_groups

This module adds rule-based access control.

mod_admin

Extending the admin menu See m_admin_menu on how to extend the admin menu.

mod_admin_category

Add support for editing Categories in the admin, by presenting an editable category tree at http://yoursite.com/admin…

mod_admin_config

Add support for editing the site’s configuration values, as accessed through m_config.

mod_admin_frontend

Adds editing of resources, menu-trees and collections for non-admin users.

mod_admin_identity

Provides identity management in the admin - for example the storage of usernames and passwords.

mod_admin_merge

Adds functonality to merge two pages together into a single page.

mod_admin_modules

Adds support in the admin for activating and deactivating modules.

mod_admin_predicate

Add support for editing predicates in the admin, by presenting a list of all defined predicates on http://yoursite.com…

mod_artwork

This module contains many useful icons and images.

mod_audio

Adds support for viewing and handling audio medium items.

mod_authentication

This module contains the main Zotonic authentication mechanism. It contains the logon and logoff controllers, and…

mod_backup

mod_backup serves two different purposes: it makes a nightly backup of your files and database, and can also backup…

mod_base

mod_base is the base module, which acts as a container module holding most of Zotonic basic dispatch rules, Actions and…

mod_bootstrap

Adds support for the Twitter Bootstrap CSS / JavaScript framework.

mod_clamav

Uses clamd to scan all uploaded files for viruses.

mod_comment

Implements a basic commenting system, enabling commenting on resources.

mod_contact

Implements a basic contact form, which gets emailed to the configuration value mod_contact.email , when submitted.

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_cron

Provides periodic events.

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

Enables the Zotonic site to relay emails for the site’s users to their real email addresses.

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 systen 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.

mod_linkedin

The mod_linkedin module plugs into the authentication systen 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_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_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_activate

A module has been activated and started.