Fichier ecrire/public/balises.php

Ce fichier regroupe la quasi totalité des définitions de #BALISES de SPIP.

Pour chaque balise, il est possible de surcharger, dans son fichier mes_fonctions.php, la fonction balise_TOTO_dist() par une fonction balise_TOTO() respectant la même API : elle reçoit en entrée un objet de classe Champ, le modifie et le retourne. Cette classe est définie dans public/interfaces.

Des balises dites «dynamiques» sont également déclarées dans le répertoire ecrire/balise/

Source

Proposer une amélioration

Liste des constantes

Le code produit est trompeur, car les modèles ne fournissent pas Pile[0]. On produit un appel à _request si on ne l'a pas, mais c'est inexact: l'absence peut-être due à une faute de frappe dans le contexte inclus.

Valeur

  • '%s($Numrows["%s"]["grand_total"], %s, isset($Pile[0][%4$s])?$Pile[0][%4$s]:intval(_request(%4$s)), %5$s, %6$s, %7$s, %8$s, array(%9$s))'

Package

Liste des fonctions

Accèpte 2 arguments optionnels :

  • L'url de l'action (par défaut #ENV{action}
  • Le nom du formulaire (par défaut #ENV{form}
\Champ balise_ACTION_FORMULAIRE( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • <form method='post' action='#ENV{action}'><div>
    #ACTION_FORMULAIRE

Voir également

Package

Balise

  • ACTION_FORMULAIRE
Proposer une amélioration
\Champ balise_AIDER_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #AIDER{titre}

Voir également

Package

Balise

  • AIDER
Proposer une amélioration

Cette ancre peut ainsi être placée au-dessus la liste des éléments de la boucle alors qu'on mettra les liens de pagination en-dessous de cette liste paginée.

Cette balise nécessite le critère pagination sur la boucle où elle est utilisée.

\Champ balise_ANCRE_PAGINATION_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Balise

  • ANCRE_PAGINATION
Proposer une amélioration

Crée un array PHP à partir d'arguments calculés. Chaque paire d'arguments représente la clé et la valeur du tableau.

\Champ balise_ARRAY_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #ARRAY{key1,val1,key2,val2 ...} retourne
    array( key1 => val1, key2 => val2, ...)

Package

Balise

  • ARRAY
Proposer une amélioration

Appelle la fonction autoriser() avec les mêmes arguments, et renvoie un espace ' ' si OK (l'action est autorisée), sinon une chaine vide '' (l'action n'est pas autorisée).

Cette balise créée un cache par session.

Signature : #AUTORISER{faire[,type[,id[,auteur[,options]]]}

\Champ balise_AUTORISER_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  •  [(#AUTORISER{modifier,rubrique,#ID_RUBRIQUE}) ... ]
    [(#AUTORISER{voir,rubrique,#ID_RUBRIQUE}|sinon_interdire_acces)]

Package

Note

  • La priorité des opérateurs exige && plutot que AND

Balise

  • AUTORISER
Proposer une amélioration

Cette balise s'utilise à la place des liens action_auteur, sous la forme

  • #BOUTON_ACTION{libelle,url}
  • ou #BOUTON_ACTION{libelle,url,ajax} pour que l'action soit ajax comme un lien class='ajax'
  • ou #BOUTON_ACTION{libelle,url,ajax,message_confirmation} pour utiliser un message de confirmation
  • ou encore #BOUTON_ACTION{libelle[,url[,ajax[,message_confirmation[,title[,callback]]]]]}
\Champ balise_BOUTON_ACTION_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • [(#AUTORISER{reparer,base})
       [(#BOUTON_ACTION{<:bouton_tenter_recuperation:>,#URL_ECRIRE{base_repair}})]
    ]

Package

Balise

  • BOUTON_ACTION
Proposer une amélioration

Signature : #CACHE{duree[,type]}

Le premier argument est la durée en seconde du cache. Le second (par défaut statique) indique le type de cache :

  • cache-client autorise gestion du IF_MODIFIED_SINCE
  • statique ne respecte pas l'invalidation par modif de la base (mais s'invalide tout de même à l'expiration du delai)
\Champ balise_CACHE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #CACHE{24*3600}
    #CACHE{24*3600, cache-client}
    #CACHE{0} pas de cache

Voir également

Package

Balise

  • CACHE

Note

  • En absence de cette balise la durée est du cache est donné par la constante _DUREE_CACHE_DEFAUT
Proposer une amélioration

Signature : #CHAMP_SQL{champ}

Cette balise permet de récupérer par exemple un champ notes dans une table SQL externe (impossible avec la balise #NOTES qui est une balise calculée).

Ne permet pas de passer une expression comme argument, qui ne peut être qu'un texte statique !

\Champ balise_CHAMP_SQL_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #CHAMP_SQL{notes}

Voir également

Package

Balise

  • CHAMP_SQL
Proposer une amélioration
\Champ balise_CHARSET_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • <meta http-equiv="Content-Type" content="text/html; charset=#CHARSET" />

Package

Balise

  • CHARSET
Proposer une amélioration

Signature : #CHEMIN{chemin/vers/fichier.ext}

Retourne une chaîne vide si le fichier n'est pas trouvé.

\Champ balise_CHEMIN_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • [<script type="text/javascript" src="(#CHEMIN{javascript/jquery.flot.js})"></script>]
    [<link rel="stylesheet" href="(#CHEMIN{css/perso.css}|direction_css)" type="text/css" />]

Package

Balise

  • CHEMIN
Proposer une amélioration

Signature : #CHEMIN_IMAGE{image.png}

Retourne une chaîne vide si le fichier n'est pas trouvé.

\Champ balise_CHEMIN_IMAGE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #CHEMIN_IMAGE{article-24.png}

Voir également

Package

Balise

  • CHEMIN_IMAGE
Proposer une amélioration
\Champ balise_COMPTEUR_BOUCLE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Voir également

Package

Balise

  • COMPTEUR_BOUCLE
Proposer une amélioration

Cette balise appelle la fonction lire_config() pour obtenir les configurations du site.

Par exemple #CONFIG{gerer_trad} donne 'oui ou 'non' selon le réglage.

Le 3ème argument permet de contrôler la sérialisation du résultat (mais ne sert que pour le dépot meta) qui doit parfois désérialiser, par exemple avec |in_array{#CONFIG{toto,#ARRAY,1}}. Ceci n'affecte pas d'autres dépots et |in_array{#CONFIG{toto/,#ARRAY}} sera équivalent.

Òn peut appeler d'autres tables que spip_meta avec un #CONFIG{/infos/champ,defaut} qui lit la valeur de champ dans une table des meta qui serait spip_infos

\Champ balise_CONFIG_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

    Pile completée du code PHP d'exécution de la balise

Package

Balise

  • CONFIG
Proposer une amélioration

Retourne le nom du connecteur de base de données utilisé (le nom du fichier config/xx.php sans l'extension, utilisé pour calculer les données du squelette).

Retourne NULL si le connecteur utilisé est celui par défaut de SPIP (connect.php), sinon retourne son nom.

\Champ balise_CONNECT_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

    Pile completée du code PHP d'exécution de la balise

Package

Balise

  • CONNECT
Proposer une amélioration
\Champ balise_CONST_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #CONST{_DIR_IMG}

Package

Balise

  • CONST
Proposer une amélioration

Cette balise retourne soit le champ date d'une table si elle est utilisée dans une boucle, sinon la date de calcul du squelette.

\Champ balise_DATE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

    Pile completée du code PHP d'exécution de la balise

Exemples

  • <td>[(#DATE|affdate_jourcourt)]</td>

Package

Balise

  • DATE
Proposer une amélioration

Cette balise retourne le champ date_modif d'une table

\Champ balise_DATE_MODIF_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

    Pile completée du code PHP d'exécution de la balise

Voir également

Package

Balise

  • DATE_MODIF
Proposer une amélioration
\Champ balise_DATE_NOUVEAUTES_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

    Pile completée du code PHP d'exécution de la balise

Voir également

Package

Balise

  • DATE_NOUVEAUTES
Proposer une amélioration

Cette balise retourne le champ date_redac d'une table

\Champ balise_DATE_REDAC_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

    Pile completée du code PHP d'exécution de la balise

Voir également

Package

Balise

  • DATE_REDAC
Proposer une amélioration
\Champ balise_DESCRIPTIF_SITE_SPIP_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Balise

  • DESCRIPTIF_SITE_SPIP
Proposer une amélioration
  • #DOUBLONS{mots} ou #DOUBLONS{mots,famille} donne l'état des doublons (MOTS) à cet endroit sous forme de tableau d'id_mot comme array(1,2,3,...)

  • #DOUBLONS tout seul donne la liste brute de tous les doublons
  • #DOUBLONS*{mots} donne la chaine brute ,1,2,3,... (changera si la gestion des doublons evolue)
\Champ balise_DOUBLONS_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Balise

  • DOUBLONS
Proposer une amélioration

Cette balise ne retourne rien mais permet d'indiquer, pour certains plugins qui redéfinissent cette balise, le nom du champ SQL (ou le nom d'un contrôleur) correspondant à ce qui est édité. Cela sert particulièrement au plugin Crayons. Ainsi en absence du plugin, la balise est toujours reconnue (mais n'a aucune action).

\Champ balise_EDIT_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • [<div class="#EDIT{texte} texte">(#TEXTE)</div>]

Package

Balise

  • EDIT
Proposer une amélioration
\Champ balise_EMAIL_WEBMASTER_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Balise

  • EMAIL_WEBMASTER
Proposer une amélioration

La syntaxe #ENV{toto, valeur par defaut} renverra valeur par defaut si $toto est vide.

La recherche de la clé s'appuyant sur la fonction table_valeur il est possible de demander un sous élément d'un tableau : #ENV{toto/sous/element, valeur par defaut} retournera l'équivalent de #ENV{toto}|table_valeur{sous/element} c'est-à-dire en quelque sorte $env['toto']['sous']['element'] s'il existe, sinon la valeur par défaut.

Si le tableau est vide on renvoie '' (utile pour #SESSION)

Enfin, la balise utilisée seule #ENV retourne le tableau complet de l'environnement. À noter que ce tableau est retourné sérialisé.

En standard est appliqué le filtre entites_html, mais si l'étoile est utilisée pour désactiver les filtres par défaut, par exemple avec [(#ENV*{toto})] , il faut s'assurer de la sécurité anti-javascript, par exemple en filtrant avec safehtml : [(#ENV*{toto}|safehtml)]

\Champ balise_ENV_dist( \Champ $p , array $src = null )

Paramètres

  1. \Champ $p

    Pile ; arbre de syntaxe abstrait positionné au niveau de la balise.

  2. array $src = null

    Tableau dans lequel chercher la clé demandée en paramètre de la balise. Par defaut prend dans le contexte du squelette.

Retour

  • \Champ

    Pile completée du code PHP d'exécution de la balise

Package

Balise

  • ENV
Proposer une amélioration

À utiliser avec précautions !

\Champ balise_EVAL_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

    Pile completée du code PHP d'exécution de la balise

Exemples

  • #EVAL{6+9}
    #EVAL{'date("Y-m-d")'}
    #EVAL{$_SERVER['REQUEST_URI']}
    #EVAL{'str_replace("r","z", "roger")'}  (attention les "'" sont interdits)

Package

Balise

  • EVAL

Note

  • #EVAL{code} produit eval('return code;') mais si le code est une expression sans balise, on se dispense de passer par une construction si compliquée, et le code est passé tel quel (entre parenthèses, et protégé par interdire_scripts)
Proposer une amélioration

Expose dans une boucle l'élément de la page sur laquelle on se trouve, en retournant on si l'élément correspond à la page, une chaîne vide sinon.

On peut passer les paramètres à faire retourner par la balise.

\Champ balise_EXPOSE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • <a href="#URL_ARTICLE"[ class="(#EXPOSE)"]>
    <a href="#URL_ARTICLE"[ class="(#EXPOSE{actif})"]>
    <a href="#URL_ARTICLE"[ class="(#EXPOSE{on,off})"]>

Package

Balise

  • EXPOSE
Proposer une amélioration

Le filtrage se fait au niveau du squelette, sans s'appliquer aux <INCLURE>. Plusieurs filtres peuvent être indiqués, séparés par des barres verticales |

\Champ balise_FILTRE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #FILTRE{compacte_head}
    #FILTRE{supprimer_tags|filtrer_entites|trim}

Package

Balise

  • FILTRE
Proposer une amélioration

Signature : #GET{cle[,defaut]}

La clé peut obtenir des sous clés séparés par des /

\Champ balise_GET_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  •     #SET{nb,5}
        #GET{nb} affiche 5
        #GET{nb,3} affiche la valeur de nb, sinon 3
    
        #SET{nb,#ARRAY{boucles,3}}
        #GET{nb/boucles} affiche 3, équivalent à #GET{nb}|table_valeur{boucles}

Voir également

Package

Balise

  • GET
Proposer une amélioration

Cette balise set équivalente à #TOTAL_BOUCLE sauf pour les boucles paginées. Dans ce cas elle indique le nombre total d'éléments répondant aux critères hors pagination.

\Champ balise_GRAND_TOTAL_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Voir également

Package

Balise

  • GRAND_TOTAL
Proposer une amélioration

Renvoie ' ' si le webmestre souhaite que SPIP génère du code (X)HTML5 sur le site public, et '' si le code doit être strictement compatible HTML4

\Champ balise_HTML5_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • [(#HTML5) required="required"]
    <input[ (#HTML5|?{type="email",type="text"})] ... />

Utilise

Package

Balise

  • HTML5
Proposer une amélioration

Doit être placée en tête de fichier et ne fonctionne pas dans une inclusion.

\Champ balise_HTTP_HEADER_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #HTTP_HEADER{Content-Type: text/csv; charset=#CHARSET}

Package

Balise

  • HTTP_HEADER
Proposer une amélioration
\Champ balise_INCLUDE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Voir également

Package

Balise

  • INCLUDE
Proposer une amélioration

Signature : [(#INCLURE{fond=nom_du_squelette, argument, argument=xx})]

L'argument env permet de transmettre tout l'environnement du squelette en cours au squelette inclus.

On parle d’inclusion « statique » car le résultat de compilation est ajouté au squelette en cours, dans le même fichier de cache. Cette balise est donc différente d’une inclusion « dynamique » avec <INCLURE.../> qui, elle, crée un fichier de cache séparé (avec une durée de cache qui lui est propre).

L'inclusion est realisée au calcul du squelette, pas au service ainsi le produit du squelette peut être utilisé en entrée de filtres à suivre. On peut faire un #INCLURE{fichier} sans squelette (Incompatible avec les balises dynamiques).

\Champ balise_INCLURE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • [(#INCLURE{fond=inclure/documents,id_article, env})]

Package

Balise

  • INCLURE
Proposer une amélioration

Et par extension pour le JS inline qui doit préférentiellement être inséré avant les CSS car bloquant sinon.

\Champ balise_INSERT_HEAD_CSS_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Voir également

Package

Balise

  • INSERT_HEAD_CSS
Proposer une amélioration

La balise permet aux plugins d'insérer des styles, js ou autre dans l'entête sans modification du squelette. Les css doivent être inserées de préférence par #INSERT_HEAD_CSS pour en faciliter la surcharge.

On insère ici aussi un morceau de PHP qui verifiera à l'exécution que le pipeline insert_head_css a bien été vu et dans le cas contraire l'appelera. Ceal permet de ne pas oublier les css de #INSERT_HEAD_CSS même si cette balise n'est pas presente.

Il faut mettre ce php avant le insert_head car le compresseur y mets ensuite un php du meme type pour collecter CSS et JS, et on ne veut pas qu'il rate les css insérées en fallback par insert_head_css_conditionnel.

\Champ balise_INSERT_HEAD_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Balise

  • INSERT_HEAD
Proposer une amélioration

Retourne une introduction d'un objet éditorial, c'est à dire les 600 premiers caractères environ du champ 'texte' de l'objet ou le contenu indiqué entre <intro> et </intro> de ce même champ.

Pour les articles, l'introduction utilisée est celle du champ descriptif s'il est renseigné, sinon il est pris dans les champs chapo et texte et est par défaut limité à 500 caractères.

Pour les rubriques, l'introduction utilisée est celle du champ descriptif s'il est renseigné, sinon du champ texte.

La balise accèpte 1 paramètre indiquant la longueur en nombre de caractères de l'introduction.

\Champ balise_INTRODUCTION_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #INTRODUCTION
    #INTRODUCTION{300}

Voir également

Package

Balise

  • INTRODUCTION
Proposer une amélioration
\Champ balise_LANG_DIR_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • <html dir="#LANG_DIR" lang="#LANG"
        xmlns="http://www.w3.org/1999/xhtml"
        xml:lang="#LANG" class="[(#LANG_DIR)][ (#LANG)] no-js">

Package

Balise

  • LANG_DIR
Proposer une amélioration

La langue courante est celle du site ou celle qui a été passée dans l'URL par le visiteur. L'étoile #LANG* n'affiche rien si aucune langue n'est trouvée dans le SQL ou le contexte.

\Champ balise_LANG_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Balise

  • LANG
Proposer une amélioration
\Champ balise_LANG_LEFT_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Note

  • Peut servir à l'écriture de code CSS dans un squelette, mais pour inclure un fichier css, il vaut mieux utiliser le filtre direction_css si on le souhaite sensible à la langue utilisé.

Balise

  • LANG_LEFT
Proposer une amélioration
\Champ balise_LANG_RIGHT_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Balise

  • LANG_RIGHT
Proposer une amélioration
\Champ balise_LARGEUR_ECRAN_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #LARGEUR_ECRAN{pleine_largeur}

Package

Balise

  • LARGEUR_ECRAN
Proposer une amélioration
  • Soit le champ lesauteurs existe dans la table et à ce moment là, la balise retourne son contenu,

  • soit la balise appelle le modele lesauteurs.html en lui passant le couple objet et id_objet dans son environnement.
\Champ balise_LESAUTEURS_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Balise

  • LESAUTEURS
Proposer une amélioration
\Champ balise_LISTE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  •  #LISTE{a,b,c,d,e}

Package

Balise

  • LISTE
Proposer une amélioration

#MODELE{nom} insère le résultat d’un squelette contenu dans le répertoire modeles/. L’identifiant de la boucle parente est transmis par défaut avec le paramètre id à cette inclusion.

Des arguments supplémentaires peuvent être transmis : [(#MODELE{nom, argument=xx, argument})]

\Champ balise_MODELE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #MODELE{article_traductions}

Voir également

Package

Balise

  • MODELE
Proposer une amélioration

Affiche le nom du site ou sinon l'URL ou le titre de l'objet Utiliser #NOM_SITE* pour avoir le nom du site ou rien.

Cette balise interroge les colonnes nom_site ou url_site dans la boucle la plus proche.

\Champ balise_NOM_SITE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • <a href="#URL_SITE">#NOM_SITE</a>

Voir également

Package

Balise

  • NOM_SITE
Proposer une amélioration
\Champ balise_NOM_SITE_SPIP_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Balise

  • NOM_SITE_SPIP
Proposer une amélioration
\Champ balise_NOTES_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Voir également

Package

Balise

  • NOTES
Proposer une amélioration

Elle charge le modèle pagination.html (par défaut), mais un paramètre permet d'indiquer d'autres modèles. #PAGINATION{nom} utilisera le modèle pagination_nom.html.

Cette balise nécessite le critère pagination sur la boucle où elle est utilisée.

\Champ balise_PAGINATION_dist( \Champ $p , string $liste = 'true' )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

  2. string $liste = 'true'

    Afficher ou non les liens de pagination (variable de type string car code à faire écrire au compilateur) :

    • true pour les afficher
    • false pour afficher uniquement l'ancre.

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  •  [<p class="pagination">(#PAGINATION{prive})</p>]

Package

Balise

  • PAGINATION
Proposer une amélioration
\Champ balise_PIPELINE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #PIPELINE{nom}
    #PIPELINE{nom,données}
    #PIPELINE{boite_infos,#ARRAY{data,'',args,#ARRAY{type,rubrique,id,#ENV{id_rubrique}}}}

Voir également

Package

Balise

  • PIPELINE
Proposer une amélioration
\Champ balise_PLUGIN_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #PLUGIN Retourne la liste sérialisée des préfixes de plugins actifs
    #PLUGIN{prefixe} Renvoie true si le plugin avec ce préfixe est actif
    #PLUGIN{prefixe, x} Renvoie l'information x du plugin (s'il est actif)
    #PLUGIN{prefixe, tout} Renvoie toutes les informations du plugin (s'il est actif)

Voir également

Package

Balise

  • PLUGIN
Proposer une amélioration

Retourne le calcul points réalisé par le critère recherche. Cette balise nécessite donc la présence de ce critère.

\Champ balise_POINTS_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Voir également

Package

Balise

  • POINTS
Proposer une amélioration

Cela correspond à la popularité quotidienne de l'article

\Champ balise_POPULARITE_ABSOLUE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Balise

  • POPULARITE_ABSOLUE
Proposer une amélioration

C'est à dire le pourcentage de la fréquentation de l'article (la popularité absolue) par rapport à la popularité maximum.

\Champ balise_POPULARITE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Balise

  • POPULARITE
Proposer une amélioration

Cela correspond à la popularité quotidienne de l'article

\Champ balise_POPULARITE_MAX_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Balise

  • POPULARITE_MAX
Proposer une amélioration

La popularité du site est la somme de toutes les popularités absolues.

\Champ balise_POPULARITE_SITE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Balise

  • POPULARITE_SITE
Proposer une amélioration

Le format du fichier sera extrait de la pre-extension du squelette (typo.css.html, messcripts.js.html) ou par l'argument format=css ou format=js passé en argument.

S'il n'y a pas de format détectable, on utilise .html, comme pour les squelettes.

La syntaxe de la balise est la même que celle de #INCLURE.

\Champ balise_PRODUIRE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • <link rel="stylesheet" type="text/css" href="#PRODUIRE{fond=css/macss.css,couleur=ffffff}" />

Voir également

Package

Balise

  • PRODUIRE
Proposer une amélioration
\Champ balise_PUBLIE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #PUBLIE : porte sur la boucle en cours
    [(#PUBLIE{article, 3}|oui) ... ] : pour l'objet indiqué

Voir également

Package

Balise

  • PUBLIE
Proposer une amélioration
\Champ balise_PUCE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Voir également

Package

Balise

  • PUCE
Proposer une amélioration

Affiche le « numero de l'objet ». Soit 1 quand on a un titre 1. Premier article.

Ceci est transitoire afin de préparer une migration vers un vrai système de tri des articles dans une rubrique (et plus si affinités). La balise permet d'extraire le numero masqué par le filtre supprimer_numero.

La balise recupère le champ declaré dans la définition table_titre de l'objet, ou à defaut du champ titre

Si un champ rang existe, il est pris en priorité.

\Champ balise_RANG_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Balise

  • RANG
Proposer une amélioration

Retourne un terme demandé en recherche, en le prenant dans _request() sous la clé recherche.

\Champ balise_RECHERCHE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • <h3>Recherche de : #RECHERCHE</h3>

Package

Balise

  • RECHERCHE
Proposer une amélioration

Retourne toujours une chaîne vide.

\Champ balise_REM_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • [(#REM)
      Ceci est une remarque ou un commentaire,
      non affiché dans le code généré
    ]

Package

Balise

  • REM

Note

  • La balise #REM n'empêche pas l'exécution des balises SPIP contenues dedans (elle ne sert pas à commenter du code pour empêcher son exécution).
Proposer une amélioration

La balise modifie le compteur courant de la boucle, mais pas les autres champs qui restent les valeurs de la boucle avant le saut. Il est donc preferable d'utiliser la balise juste avant la fermeture </BOUCLE>

L'argument n doit être supérieur à zéro sinon la balise ne fait rien

\Champ balise_SAUTER_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Balise

  • SAUTER
Proposer une amélioration

Cette URL est nettoyée des variables propres à l’exécution de SPIP tel que var_mode.

\Champ balise_SELF_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • <a href="[(#SELF|parametre_url{id_mot,#ID_MOT})]">...

Package

Note

  • Attention dans un INCLURE() ou une balise dynamique, on n'a pas le droit de mettre en cache #SELF car il peut correspondre à une autre page (attaque XSS) (Dans ce cas faire <INCLURE{self=#SELF}> pour différencier les caches.)

Balise

  • SELF
Proposer une amélioration

Cette balise est un tableau des données du visiteur (nom, email etc). Si elle est invoquée, elle lève un drapeau dans le fichier cache, qui permet à public/cacher de créer un cache différent par visiteur

\Champ balise_SESSION_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

    Pile completée du code PHP d'exécution de la balise

Exemples

  • #SESSION{nom}

Package

Balise

  • SESSION
Proposer une amélioration
\Champ balise_SESSION_SET_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

    Pile completée du code PHP d'exécution de la balise

Exemples

  • #SESSION_SET{x,y} ajoute x=y dans la session du visiteur

Package

Balise

  • SESSION_SET
Proposer une amélioration

Signature : #SET{cle,valeur}

\Champ balise_SET_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #SET{nb,5}
    #GET{nb} // affiche 5

Voir également

Package

Balise

  • SET
Proposer une amélioration
\Champ balise_SLOGAN_SITE_SPIP_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • [<p id="slogan">(#SLOGAN_SITE_SPIP)</p>]

Package

Balise

  • SLOGAN_SITE_SPIP
Proposer une amélioration
\Champ balise_SPIP_VERSION_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

    Pile completée du code PHP d'exécution de la balise

Exemples

  • <meta name="generator" content="SPIP[ (#SPIP_VERSION)]" />

Voir également

Package

Balise

  • SPIP_VERSION
Proposer une amélioration
\Champ balise_SQUELETTE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

    Pile completée du code PHP d'exécution de la balise

Package

Balise

  • SQUELETTE
Proposer une amélioration
\Champ balise_TOTAL_BOUCLE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Package

Balise

  • TOTAL_BOUCLE
Proposer une amélioration
\Champ balise_TOTAL_UNIQUE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #TOTAL_UNIQUE affiche le nombre de #BALISE|unique
    #TOTAL_UNIQUE{famille} afiche le nombre de #BALISE|unique{famille}

Voir également

Package

Balise

  • TOTAL_UNIQUE
Proposer une amélioration

La balise #TRI{champ[,libelle]} champ prend > ou < pour afficher le lien de changement de sens croissant ou decroissant (> < indiquent un sens par une flèche)

\Champ balise_TRI_dist( \Champ $p , string $liste = 'true' )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

  2. string $liste = 'true'

    Inutilisé

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • <th>[(#TRI{titre,<:info_titre:>,ajax})]</th>

Package

Balise

  • TRI
Proposer une amélioration

Cela permet d'appliquer un filtre à une chaîne de caractère

\Champ balise_VAL_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #VAL retourne ''
    #VAL{x} retourne 'x'
    #VAL{1,2} renvoie '1' (2 est considéré comme un autre paramètre)
    #VAL{'1,2'} renvoie '1,2'
    [(#VAL{a_suivre}|bouton_spip_rss)]

Package

Balise

  • VAL
Proposer une amélioration

Utile dans une boucle DATA pour retourner une valeur.

\Champ balise_VALEUR_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • #VALEUR renvoie le champ valeur
    #VALEUR{x} renvoie #VALEUR|table_valeur{x},
       équivalent à #X (si X n'est pas une balise spécifique à SPIP)
    #VALEUR{a/b} renvoie #VALEUR|table_valeur{a/b}

Voir également

Package

Balise

  • VALEUR
Proposer une amélioration
\Champ calculer_balise_expose( \Champ $p , string $on , string $off )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

  2. string $on

    Texte à afficher si l'élément est exposé (code à écrire tel que "'on'")

  3. string $off

    Texte à afficher si l'élément n'est pas exposé (code à écrire tel que "''")

Retour

  • \Champ

    Pile complétée par le code à générer

Voir également

Utilisé par

Package

Proposer une amélioration
string | null interprete_argument_balise( integer $n , \Champ $p )

Paramètres

  1. integer $n

    Numéro de l'argument

  2. \Champ $p

    Pile au niveau de la balise

Retour

  • string | null

    Code PHP si cet argument est présent, sinon null

Exemples

  • // Retourne le premier argument de la balise
    // #BALISE{premier,deuxieme}
    $arg = interprete_argument_balise(1,$p);

Package

Proposer une amélioration

Dépréciées

\Champ balise_DOSSIER_SQUELETTE_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise.

Retour

  • \Champ

    Pile completée du code PHP d'exécution de la balise

Voir également

Package

Balise

  • DOSSIER_SQUELETTE

Deprecated

  • Utiliser #CHEMIN
Proposer une amélioration

Alias pour regler #948. Ne plus utiliser.

\Champ balise_NOOP_dist( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Voir également

Package

Balise

  • NOOP

Deprecated

  • Utiliser #VAL
Proposer une amélioration