Référence

Référence de l'API

Toutes les fonctions publiques du thème. Celles qui produisent de l'affichage retournent une valeur déjà échappée, sauf mention contraire.

Champs d'une page

Fonction Arguments Retour
iron_field chemin, page La valeur échappée
iron_has chemin, page Booléen
iron_image chemin, format, attributs, page Balise image, ou vide
iron_image_url chemin, format, page Adresse échappée, ou vide
iron_link chemin, attributs, page Balise de lien, ou vide
iron_field_raw chemin, page La valeur non échappée

L'argument page est toujours facultatif : par défaut, la page en cours d'affichage.

Listes répétables

Fonction Arguments Retour
iron_rows chemin, page Un tableau de lignes
iron_option_rows chemin Un tableau de lignes
iron_row ligne, clé La valeur échappée
iron_row_has ligne, clé Booléen
iron_row_image ligne, clé, format, attributs Balise image, ou vide
iron_row_image_url ligne, clé, format Adresse échappée, ou vide
iron_row_link ligne, clé, attributs Balise de lien, ou vide

Réglages du site

Fonction Arguments Retour
iron_option chemin La valeur échappée
iron_option_has chemin Booléen
iron_option_image chemin, format, attributs Balise image, ou vide
iron_option_image_url chemin, format Adresse échappée, ou vide
iron_option_link chemin, attributs Balise de lien, ou vide
iron_option_raw chemin La valeur non échappée

Sections désactivables

Fonction Arguments Retour
iron_is_enabled groupe, page Faux si la section est masquée
iron_option_is_enabled groupe Faux si la section est masquée

Toujours vrai pour un groupe qui ne déclare pas d'interrupteur : ces fonctions peuvent être appelées sans condition.

Mise en page

Fonction Rôle
iron_header Ouvre le document : en-tête, balise main
iron_footer Ferme le document : pied de page, scripts

Filtres

Filtre Ce qu'il permet
iron_field_types Ajouter ou modifier un type de champ
iron_revisioned_meta_keys Ajouter des clés au mécanisme de révisions
iron_client_capabilities Ajuster les droits du rôle Client
iron_client_allowed_menus Ouvrir des entrées de menu au client
iron_client_removed_meta_boxes Choisir les boîtes retirées de l'écran d'édition

Fonctions internes

Elles ne sont normalement pas nécessaires pour construire un site, mais servent si vous étendez le moteur.

Fonction Rôle
iron_field_types Les types disponibles
iron_get_post_schema Le schéma normalisé d'une page
iron_get_options_schema Le schéma normalisé des réglages
iron_flatten_schema Les champs indexés par chemin
iron_get_field_definition La définition d'un champ
iron_sanitize_field_value Le nettoyage typé d'une valeur
iron_get_raw_value La valeur brute d'un champ de page
iron_save_raw_value Nettoyage puis écriture
iron_user_is_client Vrai si l'utilisateur courant a le rôle Client