Models

m_acl
The m_acl model gives access the id of the currently logged in user, and provides a mechanism to do basic access control checks.
m_acl_rule
Not yet documented.
m_acl_user_group
Not yet documented.
m_admin
This model exposes some meta-information for the use in mod_admin templates.
m_admin_blocks
Not yet documented.
m_admin_config
Not yet documented.
m_admin_identity
Not yet documented.
m_admin_menu
This model holds the admin menu, which is built up by calling each module to add items to the menu.
m_admin_status
Not yet documented.
m_auth2fa
Not yet documented.
m_authentication
Not yet documented.
m_backup
Not yet documented.
m_backup_revision
Not yet documented.
m_category
This model can retrieve information about the resource category hierarchy in different ways.
m_client_local_storage
Model to access the localStorage on the client (browser).
m_client_session_storage
Model to access the sessionStorage on the client (browser).
m_comment
Accesses comments on a page.
m_config
Zotonic has two places where a site’s configuration is kept:
m_content_group
Not yet documented.
m_custom_redirect
Not yet documented.
m_development
Not yet documented.
m_edge
Access information about page connections.
m_editor_tinymce
Not yet documented.
m_email_dkim
DomainKeys Identified Mail Signatures (RFC 6376) is a method to add a signature to outgoing emails. This enables recipients to check who sent an email and if…
m_email_receive_recipient
Not yet documented.
m_email_status
Tracks the send/bounce/error status of all outgoing emails.
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 (pages).
m_identity
The m_identity model manages usernames and other user identities. mod_authentication uses it to store and check salted passwords, but also provides a safe…
m_image_edit
Manages the medium_edit_settings property for non destructive image editing.
m_import_csv_data
Not yet documented.
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.
m_predicate
Retrieve information about predicates. Predicates are the labels on edges (connections between resources) that give meaning to an edge. An example is the…
m_ratelimit
Not yet documented.
m_req
This model gives access to the request variables from within a template.
m_rsc
The main resource model, which is the central part of the Zotonic data model. This model provides an interface to all resource (“page”) information. It also…
m_rsc_gone
This model tracks deleted resources (see m_rsc). Its primary goal is to be able to determine if a resource never existed, has been deleted or has been replaced…
m_search
The m_search model provides access to different kinds of search queries for searching through models.
m_seo
Not yet documented.
m_seo_sitemap
Not yet documented.
m_server_storage
Model to access the server side storage of data.
m_signup
Exported APIs:
m_site
Retrieve information that is stored in the site configuration. If you want to query values from the config table instead, you should use m_config.
m_site_update
Model for checking if a site has version control enabled.
m_ssl_letsencrypt
Not yet documented.
m_survey
Not yet documented.
m_sysconfig
Gives access to the Zotonic system configuration from the zotonic.config file(s).
m_template
m_tkvstore
Simple read-only interface to the typed key-value store of mod_tkvstore. To get a value from the store: use m.tkvstore.type.key , like this:
m_translation
The m_translation model gives easy access to language and translation related information.
m_twitter
Not yet documented.

Global template variables Reference Validators

All Models

m_acl

The m_acl model gives access the id of the currently logged in user, and provides a mechanism to do basic access…

m_acl_rule

Not yet documented.

m_acl_user_group

Not yet documented.

m_admin

This model exposes some meta-information for the use in mod_admin templates.

m_admin_blocks

Not yet documented.

m_admin_config

Not yet documented.

m_admin_identity

Not yet documented.

m_admin_menu

This model holds the admin menu, which is built up by calling each module to add items to the menu.

m_admin_status

Not yet documented.

m_auth2fa

Not yet documented.

m_authentication

Not yet documented.

m_backup

Not yet documented.

m_backup_revision

Not yet documented.

m_category

This model can retrieve information about the resource category hierarchy in different ways.

m_client_local_storage

Model to access the localStorage on the client (browser).

m_client_session_storage

Model to access the sessionStorage on the client (browser).

m_comment

Accesses comments on a page.

m_config

Zotonic has two places where a site’s configuration is kept:

m_content_group

Not yet documented.

m_custom_redirect

Not yet documented.

m_development

Not yet documented.

m_edge

Access information about page connections.

m_editor_tinymce

Not yet documented.

m_email_dkim

DomainKeys Identified Mail Signatures (RFC 6376) is a method to add a signature to outgoing emails. This enables…

m_email_receive_recipient

Not yet documented.

m_email_status

Tracks the send/bounce/error status of all outgoing emails.

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…

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.

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.

m_predicate

Retrieve information about predicates. Predicates are the labels on edges (connections between resources) that give…

m_ratelimit

Not yet documented.

m_req

This model gives access to the request variables from within a template.

m_rsc

The main resource model, which is the central part of the Zotonic data model. This model provides an interface to all…

m_rsc_gone

This model tracks deleted resources (see m_rsc). Its primary goal is to be able to determine if a resource never…

m_search

The m_search model provides access to different kinds of search queries for searching through models.

m_seo

Not yet documented.

m_seo_sitemap

Not yet documented.

m_server_storage

Model to access the server side storage of data.

m_signup

Exported APIs:

m_site

Retrieve information that is stored in the site configuration. If you want to query values from the config table…

m_site_update

Model for checking if a site has version control enabled.

m_ssl_letsencrypt

Not yet documented.

m_survey

Not yet documented.

m_sysconfig

Gives access to the Zotonic system configuration from the zotonic.config file(s).

m_tkvstore

Simple read-only interface to the typed key-value store of mod_tkvstore. To get a value from the store: use m.tkvstore.

m_translation

The m_translation model gives easy access to language and translation related information.

m_twitter

Not yet documented.