Documentation du code de SPIP et de ses plugins

SPIP

balises.php

Table of Contents

Constants

CODE_PAGINATION  = '%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))'
Code de compilation pour la balise `#PAGINATION`

Functions

interprete_argument_balise()  : string|null
Retourne le code PHP d'un argument de balise s'il est présent
balise_NOM_SITE_SPIP_dist()  : Champ
Compile la balise `#NOM_SITE_SPIP` retournant le nom du site
balise_EMAIL_WEBMASTER_dist()  : Champ
Compile la balise `#EMAIL_WEBMASTER` retournant l'adresse courriel du webmestre
balise_DESCRIPTIF_SITE_SPIP_dist()  : Champ
Compile la balise `#DESCRIPTIF_SITE_SPIP` qui retourne le descriptif du site !
balise_CHARSET_dist()  : Champ
Compile la balise `#CHARSET` qui retourne le nom du jeu de caractères utilisé par le site tel que `utf-8`
balise_LANG_LEFT_dist()  : Champ
Compile la balise `#LANG_LEFT` retournant 'left' si la langue s'écrit de gauche à droite, sinon 'right'
balise_LANG_RIGHT_dist()  : Champ
Compile la balise `#LANG_RIGHT` retournant 'right' si la langue s'écrit de gauche à droite, sinon 'left'
balise_LANG_DIR_dist()  : Champ
Compile la balise `#LANG_DIR` retournant 'ltr' si la langue s'écrit de gauche à droite, sinon 'rtl'
balise_PUCE_dist()  : Champ
Compile la balise `#PUCE` affichant une puce
balise_DATE_dist()  : Champ
Compile la balise `#DATE` qui retourne la date de mise en ligne
balise_DATE_REDAC_dist()  : Champ
Compile la balise `#DATE_REDAC` qui retourne la date de première publication
balise_DATE_MODIF_dist()  : Champ
Compile la balise `#DATE_MODIF` qui retourne la date de dernière modification
balise_DATE_NOUVEAUTES_dist()  : Champ
Compile la balise `#DATE_NOUVEAUTES` indiquant la date de dernier envoi du mail de nouveautés
balise_DOSSIER_SQUELETTE_dist()  : Champ
Compile la balise `#DOSSIER_SQUELETTE` retournant le chemin vers le répertoire du fichier squelette dans lequel elle est appelee (comme __DIR__ en php)
balise_SQUELETTE_dist()  : Champ
Compile la balise `#SQUELETTE` retournant le chemin du squelette courant
balise_SPIP_VERSION_dist()  : Champ
Compile la balise `#SPIP_VERSION` qui affiche la version de SPIP
balise_NOM_SITE_dist()  : Champ
Compile la balise `#NOM_SITE` qui affiche le nom du site.
balise_NOTES_dist()  : Champ
Compile la balise `#NOTE` qui affiche les notes de bas de page
balise_RECHERCHE_dist()  : Champ
Compile la balise `#RECHERCHE` qui retourne le terme de recherche demandé
balise_COMPTEUR_BOUCLE_dist()  : Champ|null
Compile la balise `#COMPTEUR_BOUCLE` qui retourne le numéro de l’itération actuelle de la boucle
balise_TOTAL_BOUCLE_dist()  : Champ
Compile la balise `#TOTAL_BOUCLE` qui retourne le nombre de résultats affichés par la boucle
balise_POINTS_dist()  : Champ
Compile la balise `#POINTS` qui affiche la pertinence des résultats
balise_POPULARITE_ABSOLUE_dist()  : Champ
Compile la balise `#POPULARITE_ABSOLUE` qui affiche la popularité absolue
balise_POPULARITE_SITE_dist()  : Champ
Compile la balise `#POPULARITE_SITE` qui affiche la popularité du site
balise_POPULARITE_MAX_dist()  : Champ
Compile la balise `#POPULARITE_MAX` qui affiche la popularité maximum parmis les popularités des articles
balise_VALEUR_dist()  : Champ
Compile la balise `#VALEUR` retournant le champ `valeur`
balise_EXPOSE_dist()  : Champ
Compile la balise `#EXPOSE` qui met en évidence l'élément sur lequel la page se trouve
calculer_balise_expose()  : Champ
Calcul de la balise expose
balise_INTRODUCTION_dist()  : Champ
Compile la balise `#INTRODUCTION`
balise_LANG_dist()  : Champ
Compile la balise `#LANG` qui affiche la langue de l'objet (ou d'une boucle supérieure), et à defaut la langue courante
balise_LESAUTEURS_dist()  : Champ
Compile la balise `#LESAUTEURS` chargée d'afficher la liste des auteurs d'un objet
balise_RANG_dist()  : Champ
Compile la balise `#RANG` chargée d'afficher le numéro de l'objet
balise_POPULARITE_dist()  : Champ
Compile la balise `#POPULARITE` qui affiche la popularité relative.
balise_PAGINATION_dist()  : Champ
Compile la balise `#PAGINATION` chargée d'afficher une pagination
balise_ANCRE_PAGINATION_dist()  : Champ
Compile la balise `#ANCRE_PAGINATION` chargée d'afficher l'ancre de la pagination
balise_GRAND_TOTAL_dist()  : Champ
Compile la balise `#GRAND_TOTAL` qui retourne le nombre total de résultats d'une boucle
balise_SELF_dist()  : Champ
Compile la balise `#SELF` qui retourne l’URL de la page appelée.
balise_CHEMIN_dist()  : Champ
Compile la balise `#CHEMIN` qui cherche un fichier dans les chemins connus de SPIP et retourne son chemin complet depuis la racine
balise_CHEMIN_IMAGE_dist()  : Champ
Compile la balise `#CHEMIN_IMAGE` qui cherche une image dans le thème de l'espace privé utilisé par SPIP et retourne son chemin complet depuis la racine
balise_ENV_dist()  : Champ
Compile la balise `#ENV` qui permet de récupérer le contexte d'environnement transmis à un squelette.
balise_CONFIG_dist()  : Champ
Compile la balise `#CONFIG` qui retourne une valeur de configuration
balise_CONNECT_dist()  : Champ
Compile la balise `#CONNECT` qui retourne le nom du connecteur de base de données
balise_SESSION_dist()  : Champ
Compile la balise `#SESSION` qui permet d’accéder aux informations liées au visiteur authentifié et de différencier automatiquement le cache en fonction du visiteur.
balise_SESSION_SET_dist()  : Champ
Compile la balise `#SESSION_SET` qui d’insérer dans la session des données supplémentaires
balise_EVAL_dist()  : Champ
Compile la balise `#EVAL` qui évalue un code PHP
balise_CHAMP_SQL_dist()  : Champ
Compile la balise `#CHAMP_SQL` qui renvoie la valeur d'un champ SQL
balise_VAL_dist()  : Champ
Compile la balise `#VAL` qui retourne simplement le premier argument qui lui est transmis
balise_REM_dist()  : Champ
Compile la balise `#REM` servant à commenter du texte
balise_NULL_dist()  : mixed
Une balise #NULL quand on a besoin de passer un argument null sur l'appel d'un filtre ou formulaire (evite un #EVAL{null})
balise_HTTP_HEADER_dist()  : Champ
Compile la balise `#HTTP_HEADER` envoyant des entêtes de retour HTTP
balise_FILTRE_dist()  : Champ|null
Compile la balise `#FILTRE` qui exécute un filtre à l'ensemble du squelette une fois calculé.
balise_CACHE_dist()  : Champ
Compile la balise `#CACHE` definissant la durée de validité du cache du squelette
balise_INSERT_HEAD_dist()  : Champ
Compile la balise `#INSERT_HEAD` permettant d'insérer du contenu dans le `<head>` d'une page HTML
balise_INSERT_HEAD_CSS_dist()  : Champ
Compile la balise `#INSERT_HEAD_CSS` homologue de `#INSERT_HEAD` pour les CSS
balise_INCLUDE_dist()  : Champ
Compile la balise `#INCLUDE` alias de `#INCLURE`
balise_INCLURE_dist()  : Champ
Compile la balise `#INCLURE` qui inclut un résultat de squelette
balise_MODELE_dist()  : Champ
Compile la balise `#MODELE` qui inclut un résultat de squelette de modèle
balise_SET_dist()  : Champ
Compile la balise `#SET` qui affecte une variable locale au squelette
balise_GET_dist()  : Champ
Compile la balise `#GET` qui récupère une variable locale au squelette
balise_DOUBLONS_dist()  : Champ
Compile la balise `#DOUBLONS` qui redonne les doublons enregistrés
balise_PIPELINE_dist()  : Champ
Compile la balise `#PIPELINE` pour permettre d'insérer des sorties de pipeline dans un squelette
balise_EDIT_dist()  : Champ
Compile la balise `#EDIT` qui ne fait rien dans SPIP
balise_TOTAL_UNIQUE_dist()  : Champ
Compile la balise `#TOTAL_UNIQUE` qui récupère le nombre d'éléments différents affichés par le filtre `unique`
balise_ARRAY_dist()  : Champ
Compile la balise `#ARRAY` créant un tableau PHP associatif
balise_LISTE_dist()  : Champ
Compile la balise `#LISTE` qui crée un tableau PHP avec les valeurs, sans préciser les clés
balise_AUTORISER_dist()  : Champ
Compile la balise `#AUTORISER` qui teste une autorisation
balise_PLUGIN_dist()  : Champ
Compile la balise `#PLUGIN` qui permet d’afficher les informations d'un plugin actif
balise_AIDER_dist()  : Champ
Compile la balise `#AIDER` qui permet d’afficher l’icone de l’aide au sein des squelettes.
balise_ACTION_FORMULAIRE()  : Champ
Compile la balise `#ACTION_FORMULAIRE` qui insère le contexte des formulaires charger / vérifier / traiter avec les hidden de l'URL d'action
balise_BOUTON_ACTION_dist()  : Champ
Compile la balise `#BOUTON_ACTION` qui génère un bouton d'action en post, ajaxable
balise_SLOGAN_SITE_SPIP_dist()  : Champ
Compile la balise `#SLOGAN_SITE_SPIP` qui retourne le slogan du site
balise_HTML5_dist()  : Champ
Compile la balise `#HTML5` indiquant si l'espace public peut utiliser du HTML5
balise_TRI_dist()  : Champ
Compile la balise `#TRI` permettant d'afficher un lien de changement d'ordre de tri d'une colonne de la boucle
balise_SAUTER_dist()  : Champ
Compile la balise `#SAUTER{n}` qui permet de sauter en avant n resultats dans une boucle
balise_PUBLIE_dist()  : Champ
Compile la balise `#PUBLIE` qui indique si un objet est publié ou non
balise_PRODUIRE_dist()  : Champ
Compile la balise `#PRODUIRE` qui génère un fichier statique à partir d'un squelette SPIP
balise_LARGEUR_ECRAN_dist()  : Champ
Compile la balise `#LARGEUR_ECRAN` qui définit la largeur d'écran dans l'espace privé
balise_CONST_dist()  : Champ
Compile la balise `#CONST` qui retourne la valeur de la constante passée en argument

Constants

CODE_PAGINATION

Code de compilation pour la balise `#PAGINATION`

public mixed CODE_PAGINATION = '%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))'

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.

Functions

interprete_argument_balise()

Retourne le code PHP d'un argument de balise s'il est présent

interprete_argument_balise(int $n, Champ $p) : string|null
Parameters
$n : int

Numéro de l'argument

$p : Champ

Pile au niveau de la balise

Tags
uses
calculer_liste()
example
// Retourne le premier argument de la balise
// #BALISE{premier,deuxieme}
$arg = interprete_argument_balise(1,$p);
Return values
string|null

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

balise_NOM_SITE_SPIP_dist()

Compile la balise `#NOM_SITE_SPIP` retournant le nom du site

balise_NOM_SITE_SPIP_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4622
Return values
Champ

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

balise_EMAIL_WEBMASTER_dist()

Compile la balise `#EMAIL_WEBMASTER` retournant l'adresse courriel du webmestre

balise_EMAIL_WEBMASTER_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4586
Return values
Champ

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

balise_DESCRIPTIF_SITE_SPIP_dist()

Compile la balise `#DESCRIPTIF_SITE_SPIP` qui retourne le descriptif du site !

balise_DESCRIPTIF_SITE_SPIP_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4338
Return values
Champ

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

balise_CHARSET_dist()

Compile la balise `#CHARSET` qui retourne le nom du jeu de caractères utilisé par le site tel que `utf-8`

balise_CHARSET_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4331
example
<meta http-equiv="Content-Type" content="text/html; charset=#CHARSET" />
Return values
Champ

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

balise_LANG_LEFT_dist()

Compile la balise `#LANG_LEFT` retournant 'left' si la langue s'écrit de gauche à droite, sinon 'right'

balise_LANG_LEFT_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
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
link
https://www.spip.net/4625
see
lang_dir()
see
balise_LANG_RIGHT_dist()
see
balise_LANG_DIR_dist()
see
direction_css()
Return values
Champ

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

balise_LANG_DIR_dist()

Compile la balise `#LANG_DIR` retournant 'ltr' si la langue s'écrit de gauche à droite, sinon 'rtl'

balise_LANG_DIR_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4625
see
lang_dir()
see
balise_LANG_LEFT_dist()
see
balise_LANG_RIGHT_dist()
example
<html dir="#LANG_DIR" lang="#LANG"
    xmlns="http://www.w3.org/1999/xhtml"
    xml:lang="#LANG" class="[(#LANG_DIR)][ (#LANG)] no-js">
Return values
Champ

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

balise_PUCE_dist()

Compile la balise `#PUCE` affichant une puce

balise_PUCE_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4628
see
definir_puce()
Return values
Champ

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

balise_DATE_dist()

Compile la balise `#DATE` qui retourne la date de mise en ligne

balise_DATE_dist(Champ $p) : Champ

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.

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
link

Balise DATE

link

La gestion des dates

example
<td>[(#DATE|affdate_jourcourt)]</td>
Return values
Champ

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

balise_DOSSIER_SQUELETTE_dist()

Compile la balise `#DOSSIER_SQUELETTE` retournant le chemin vers le répertoire du fichier squelette dans lequel elle est appelee (comme __DIR__ en php)

balise_DOSSIER_SQUELETTE_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
link
https://www.spip.net/4627
Return values
Champ

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

balise_SQUELETTE_dist()

Compile la balise `#SQUELETTE` retournant le chemin du squelette courant

balise_SQUELETTE_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
link
https://www.spip.net/4027
Return values
Champ

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

balise_SPIP_VERSION_dist()

Compile la balise `#SPIP_VERSION` qui affiche la version de SPIP

balise_SPIP_VERSION_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
see
spip_version()
example
[<meta name="generator" content="SPIP (#SPIP_VERSION|header_silencieux)" />]
Return values
Champ

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

balise_NOM_SITE_dist()

Compile la balise `#NOM_SITE` qui affiche le nom du site.

balise_NOM_SITE_dist(Champ $p) : Champ

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.

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
see
calculer_url()
example
<a href="#URL_SITE">#NOM_SITE</a>
Return values
Champ

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

balise_NOTES_dist()

Compile la balise `#NOTE` qui affiche les notes de bas de page

balise_NOTES_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/3964
see
calculer_notes()
Return values
Champ

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

balise_RECHERCHE_dist()

Compile la balise `#RECHERCHE` qui retourne le terme de recherche demandé

balise_RECHERCHE_dist(Champ $p) : Champ

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

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
example
<h3>Recherche de : #RECHERCHE</h3>
Return values
Champ

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

balise_COMPTEUR_BOUCLE_dist()

Compile la balise `#COMPTEUR_BOUCLE` qui retourne le numéro de l’itération actuelle de la boucle

balise_COMPTEUR_BOUCLE_dist(Champ $p) : Champ|null
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4333
see
balise_TOTAL_BOUCLE_dist()
Return values
Champ|null

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

balise_POINTS_dist()

Compile la balise `#POINTS` qui affiche la pertinence des résultats

balise_POINTS_dist(Champ $p) : Champ

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

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link

boucles et balises de recherche

see
critere_recherche_dist()
Return values
Champ

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

balise_POPULARITE_MAX_dist()

Compile la balise `#POPULARITE_MAX` qui affiche la popularité maximum parmis les popularités des articles

balise_POPULARITE_MAX_dist(Champ $p) : Champ

Cela correspond à la popularité quotidienne de l'article

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link

La popularité

see
balise_POPULARITE_ABSOLUE_dist()
see
balise_POPULARITE_dist()
see
balise_POPULARITE_SITE_dist()
Return values
Champ

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

balise_VALEUR_dist()

Compile la balise `#VALEUR` retournant le champ `valeur`

balise_VALEUR_dist(Champ $p) : Champ

Utile dans une boucle DATA pour retourner une valeur.

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link

#CLE et #VALEUR

see
table_valeur()
example
#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}
Return values
Champ

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

balise_EXPOSE_dist()

Compile la balise `#EXPOSE` qui met en évidence l'élément sur lequel la page se trouve

balise_EXPOSE_dist(Champ $p) : Champ

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.

Parameters
$p : Champ

Pile au niveau de la balise

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

Exposer un article

uses
calculer_balise_expose()
Return values
Champ

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

calculer_balise_expose()

Calcul de la balise expose

calculer_balise_expose(Champ $p, string $on, string $off) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

$on : string

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

$off : string

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

Tags
see
calcul_exposer()
used-by
balise_EXPOSE_dist()
Return values
Champ

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

balise_INTRODUCTION_dist()

Compile la balise `#INTRODUCTION`

balise_INTRODUCTION_dist(Champ $p) : Champ

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.

Parameters
$p : Champ

Pile au niveau de la balise

Tags
see
filtre_introduction_dist()
example
#INTRODUCTION : coupe au nombre par défaut, suite par défaut
#INTRODUCTION{300} : coupe à 300, suite par défaut
#INTRODUCTION{300, ...} : coupe à 300, suite '...'
#INTRODUCTION{...} : coupe au nombre par défaut, suite '...'
balise
link
http://www.spip.net/@introduction
uses
generer_objet_introduction()
Return values
Champ

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

balise_LANG_dist()

Compile la balise `#LANG` qui affiche la langue de l'objet (ou d'une boucle supérieure), et à defaut la langue courante

balise_LANG_dist(Champ $p) : Champ

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.

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/3864
Return values
Champ

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

balise_LESAUTEURS_dist()

Compile la balise `#LESAUTEURS` chargée d'afficher la liste des auteurs d'un objet

balise_LESAUTEURS_dist(Champ $p) : Champ
  • 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.
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link

Description de la balise

link

Description de la boucle ARTICLES

link

Description de la boucle SYNDIC_ARTICLES

Return values
Champ

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

balise_RANG_dist()

Compile la balise `#RANG` chargée d'afficher le numéro de l'objet

balise_RANG_dist(Champ $p) : Champ

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

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/5495
Return values
Champ

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

balise_POPULARITE_dist()

Compile la balise `#POPULARITE` qui affiche la popularité relative.

balise_POPULARITE_dist(Champ $p) : Champ

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

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link

La popularité

see
balise_POPULARITE_ABSOLUE_dist()
see
balise_POPULARITE_MAX_dist()
see
balise_POPULARITE_SITE_dist()
Return values
Champ

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

balise_PAGINATION_dist()

Compile la balise `#PAGINATION` chargée d'afficher une pagination

balise_PAGINATION_dist(Champ $p[, string $liste = 'true' ]) : Champ

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.

Parameters
$p : Champ

Pile au niveau de la balise

$liste : string = '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.
Tags
balise
link

Le système de pagination

see
filtre_pagination_dist()
see
critere_pagination_dist()
see
balise_ANCRE_PAGINATION_dist()
example
[<nav role="navigation" class="pagination">(#PAGINATION{prive})</nav>]
Return values
Champ

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

balise_ANCRE_PAGINATION_dist()

Compile la balise `#ANCRE_PAGINATION` chargée d'afficher l'ancre de la pagination

balise_ANCRE_PAGINATION_dist(Champ $p) : Champ

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.

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link

Le système de pagination

link

Balise ANCRE_PAGINATION

see
critere_pagination_dist()
see
balise_PAGINATION_dist()
Return values
Champ

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

balise_GRAND_TOTAL_dist()

Compile la balise `#GRAND_TOTAL` qui retourne le nombre total de résultats d'une boucle

balise_GRAND_TOTAL_dist(Champ $p) : Champ

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.

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
see
balise_GRAND_TOTAL_dist()
Return values
Champ

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

balise_SELF_dist()

Compile la balise `#SELF` qui retourne l’URL de la page appelée.

balise_SELF_dist(Champ $p) : Champ

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

Parameters
$p : Champ

Pile au niveau de la balise

Tags
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
link
https://www.spip.net/4574
example
<a href="[(#SELF|parametre_url{id_mot,#ID_MOT})]">...
Return values
Champ

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

balise_CHEMIN_dist()

Compile la balise `#CHEMIN` qui cherche un fichier dans les chemins connus de SPIP et retourne son chemin complet depuis la racine

balise_CHEMIN_dist(Champ $p) : Champ

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

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

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4332
see
find_in_path()

Recherche de chemin

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

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

balise_CHEMIN_IMAGE_dist()

Compile la balise `#CHEMIN_IMAGE` qui cherche une image dans le thème de l'espace privé utilisé par SPIP et retourne son chemin complet depuis la racine

balise_CHEMIN_IMAGE_dist(Champ $p) : Champ

Signature : #CHEMIN_IMAGE{image.png}

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

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
see
chemin_image()
example
#CHEMIN_IMAGE{article-24.png}
Return values
Champ

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

balise_ENV_dist()

Compile la balise `#ENV` qui permet de récupérer le contexte d'environnement transmis à un squelette.

balise_ENV_dist(Champ $p[, array<string|int, mixed> $src = null ]) : Champ

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)]

Parameters
$p : Champ

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

$src : array<string|int, mixed> = null

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

Return values
Champ

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

balise_CONFIG_dist()

Compile la balise `#CONFIG` qui retourne une valeur de configuration

balise_CONFIG_dist(Champ $p) : Champ

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

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
link
https://www.spip.net/4335
Return values
Champ

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

balise_CONNECT_dist()

Compile la balise `#CONNECT` qui retourne le nom du connecteur de base de données

balise_CONNECT_dist(Champ $p) : Champ

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.

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
Return values
Champ

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

balise_SESSION_dist()

Compile la balise `#SESSION` qui permet d’accéder aux informations liées au visiteur authentifié et de différencier automatiquement le cache en fonction du visiteur.

balise_SESSION_dist(Champ $p) : Champ

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

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
link
https://www.spip.net/3979
see
balise_AUTORISER_dist()
see
balise_SESSION_SET_dist()
example
#SESSION{nom}
Return values
Champ

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

balise_SESSION_SET_dist()

Compile la balise `#SESSION_SET` qui d’insérer dans la session des données supplémentaires

balise_SESSION_SET_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
link
https://www.spip.net/3984
see
balise_AUTORISER_dist()
see
balise_SESSION_SET_dist()
example
#SESSION_SET{x,y} ajoute x=y dans la session du visiteur
Return values
Champ

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

balise_EVAL_dist()

Compile la balise `#EVAL` qui évalue un code PHP

balise_EVAL_dist(Champ $p) : Champ

À utiliser avec précautions !

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
link
https://www.spip.net/4587
example
#EVAL{6+9}
#EVAL{'date("Y-m-d")'}
#EVAL{$_SERVER['REQUEST_URI']}
#EVAL{'str_replace("r","z", "roger")'}  (attention les "'" sont interdits)
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)

Return values
Champ

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

balise_CHAMP_SQL_dist()

Compile la balise `#CHAMP_SQL` qui renvoie la valeur d'un champ SQL

balise_CHAMP_SQL_dist(Champ $p) : Champ

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 !

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4041
see
champ_sql()
example
#CHAMP_SQL{notes}
Return values
Champ

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

balise_VAL_dist()

Compile la balise `#VAL` qui retourne simplement le premier argument qui lui est transmis

balise_VAL_dist(Champ $p) : Champ

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

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4026
example
#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)]
Return values
Champ

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

balise_REM_dist()

Compile la balise `#REM` servant à commenter du texte

balise_REM_dist(Champ $p) : Champ

Retourne toujours une chaîne vide.

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4578
example
[(#REM)
  Ceci est une remarque ou un commentaire,
  non affiché dans le code généré
]
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).

Return values
Champ

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

balise_NULL_dist()

Une balise #NULL quand on a besoin de passer un argument null sur l'appel d'un filtre ou formulaire (evite un #EVAL{null})

balise_NULL_dist(Champ $p) : mixed
Parameters
$p : Champ

balise_HTTP_HEADER_dist()

Compile la balise `#HTTP_HEADER` envoyant des entêtes de retour HTTP

balise_HTTP_HEADER_dist(Champ $p) : Champ

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

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4631
example
#HTTP_HEADER{Content-Type: text/csv; charset=#CHARSET}
Return values
Champ

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

balise_FILTRE_dist()

Compile la balise `#FILTRE` qui exécute un filtre à l'ensemble du squelette une fois calculé.

balise_FILTRE_dist(Champ $p) : Champ|null

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 |

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4894
example
#FILTRE{compacte_head}
#FILTRE{supprimer_tags|filtrer_entites|trim}
Return values
Champ|null

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

balise_CACHE_dist()

Compile la balise `#CACHE` definissant la durée de validité du cache du squelette

balise_CACHE_dist(Champ $p) : Champ

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)
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
see

ecrire/public/cacher.php

link
https://www.spip.net/4330
example
#CACHE{24*3600}
#CACHE{24*3600, cache-client}
#CACHE{0} pas de cache
note

En absence de cette balise la durée est du cache est donné par la constante _DUREE_CACHE_DEFAUT

Return values
Champ

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

balise_INSERT_HEAD_dist()

Compile la balise `#INSERT_HEAD` permettant d'insérer du contenu dans le `<head>` d'une page HTML

balise_INSERT_HEAD_dist(Champ $p) : Champ

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.

Parameters
$p : Champ

Pile au niveau de la balise

Tags
link
https://www.spip.net/4629
see
balise_INSERT_HEAD_CSS_dist()
Return values
Champ

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

balise_INSERT_HEAD_CSS_dist()

Compile la balise `#INSERT_HEAD_CSS` homologue de `#INSERT_HEAD` pour les CSS

balise_INSERT_HEAD_CSS_dist(Champ $p) : Champ

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

Parameters
$p : Champ

Pile au niveau de la balise

Tags
link
https://www.spip.net/4605
see
balise_INSERT_HEAD_dist()
Return values
Champ

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

balise_INCLUDE_dist()

Compile la balise `#INCLUDE` alias de `#INCLURE`

balise_INCLUDE_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
see
balise_INCLURE_dist()
Return values
Champ

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

balise_INCLURE_dist()

Compile la balise `#INCLURE` qui inclut un résultat de squelette

balise_INCLURE_dist(Champ $p) : Champ

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

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
example
[(#INCLURE{fond=inclure/documents,id_article, env})]
Return values
Champ

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

balise_MODELE_dist()

Compile la balise `#MODELE` qui inclut un résultat de squelette de modèle

balise_MODELE_dist(Champ $p) : Champ

#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})]

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
see
balise_INCLURE_dist()
example
#MODELE{article_traductions}
Return values
Champ

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

balise_SET_dist()

Compile la balise `#SET` qui affecte une variable locale au squelette

balise_SET_dist(Champ $p) : Champ

Signature : #SET{cle,valeur}

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link

Balises #SET et #GET

see
balise_GET_dist()
example
#SET{nb,5}
#GET{nb} // affiche 5
Return values
Champ

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

balise_GET_dist()

Compile la balise `#GET` qui récupère une variable locale au squelette

balise_GET_dist(Champ $p) : Champ

Signature : #GET{cle[,defaut]}

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

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link

Balises #SET et #GET

see
balise_SET_dist()
example
#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}
Return values
Champ

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

balise_DOUBLONS_dist()

Compile la balise `#DOUBLONS` qui redonne les doublons enregistrés

balise_DOUBLONS_dist(Champ $p) : Champ
  • #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)
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4123
Return values
Champ

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

balise_PIPELINE_dist()

Compile la balise `#PIPELINE` pour permettre d'insérer des sorties de pipeline dans un squelette

balise_PIPELINE_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
see
pipeline()
example
#PIPELINE{nom}
#PIPELINE{nom,données}
#PIPELINE{boite_infos,#ARRAY{data,'',args,#ARRAY{type,rubrique,id,#ENV{id_rubrique}}}}
Return values
Champ

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

balise_EDIT_dist()

Compile la balise `#EDIT` qui ne fait rien dans SPIP

balise_EDIT_dist(Champ $p) : Champ

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

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4584
example
[<div class="#EDIT{texte} texte">(#TEXTE)</div>]
Return values
Champ

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

balise_TOTAL_UNIQUE_dist()

Compile la balise `#TOTAL_UNIQUE` qui récupère le nombre d'éléments différents affichés par le filtre `unique`

balise_TOTAL_UNIQUE_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4374
see
unique()
example
#TOTAL_UNIQUE affiche le nombre de #BALISE|unique
#TOTAL_UNIQUE{famille} afiche le nombre de #BALISE|unique{famille}
Return values
Champ

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

balise_ARRAY_dist()

Compile la balise `#ARRAY` créant un tableau PHP associatif

balise_ARRAY_dist(Champ $p) : Champ

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

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/4009
example
#ARRAY{key1,val1,key2,val2 ...} retourne
array( key1 => val1, key2 => val2, ...)
Return values
Champ

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

balise_LISTE_dist()

Compile la balise `#LISTE` qui crée un tableau PHP avec les valeurs, sans préciser les clés

balise_LISTE_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/5547
example
#LISTE{a,b,c,d,e}
Return values
Champ

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

balise_AUTORISER_dist()

Compile la balise `#AUTORISER` qui teste une autorisation

balise_AUTORISER_dist(Champ $p) : Champ

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]]]}

Parameters
$p : Champ

Pile au niveau de la balise

Tags
note

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

balise
link
https://www.spip.net/3896
see
autoriser()
see
sinon_interdire_acces()
example
[(#AUTORISER{modifier,rubrique,#ID_RUBRIQUE}) ... ]
[(#AUTORISER{voir,rubrique,#ID_RUBRIQUE}|sinon_interdire_acces)]
Return values
Champ

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

balise_PLUGIN_dist()

Compile la balise `#PLUGIN` qui permet d’afficher les informations d'un plugin actif

balise_PLUGIN_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
see
filtre_info_plugin_dist()
link
https://www.spip.net/4591
example
#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)
Return values
Champ

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

balise_AIDER_dist()

Compile la balise `#AIDER` qui permet d’afficher l’icone de l’aide au sein des squelettes.

balise_AIDER_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
see
inc_aide_dist()
link
https://www.spip.net/4733
example
#AIDER{raccourcis}
Return values
Champ

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

balise_ACTION_FORMULAIRE()

Compile la balise `#ACTION_FORMULAIRE` qui insère le contexte des formulaires charger / vérifier / traiter avec les hidden de l'URL d'action

balise_ACTION_FORMULAIRE(Champ $p) : Champ

Accèpte 2 arguments optionnels :

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

Pile au niveau de la balise

Tags
balise
see
form_hidden()
example
<form method='post' action='#ENV{action}'><div>
#ACTION_FORMULAIRE
Return values
Champ

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

balise_BOUTON_ACTION_dist()

Compile la balise `#BOUTON_ACTION` qui génère un bouton d'action en post, ajaxable

balise_BOUTON_ACTION_dist(Champ $p) : Champ

Cette balise s'utilise à la place des liens action_auteur, sous la forme #BOUTON_ACTION{libelle[,url[,class[,confirm[,title[,callback]]]]]}

  • libelle : texte du bouton
  • url : URL d’action sécurisée
  • class : Classes à ajouter au bouton, à l'exception de ajax qui est placé sur le formulaire. Pour d'autres classes sur le formulaire, utiliser le filtre ajouter_class
  • confirm : message de confirmation oui/non avant l'action
  • title : attribut title à ajouter au bouton
  • callback : callback js a appeler lors de l'évènement action et avant execution de l'action (ou après confirmation éventuelle si $confirm est non vide). Si la callback renvoie false, elle annule le déclenchement de l'action.
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
uses
bouton_action()
link
https://www.spip.net/4583
example
[(#AUTORISER{reparer,base}|oui)
   [(#BOUTON_ACTION{
       <:bouton_tenter_recuperation:>,
       #URL_ECRIRE{base_repair},
       "ajax btn_large",
   })]
]
Return values
Champ

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

balise_SLOGAN_SITE_SPIP_dist()

Compile la balise `#SLOGAN_SITE_SPIP` qui retourne le slogan du site

balise_SLOGAN_SITE_SPIP_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
example
[<p id="slogan">(#SLOGAN_SITE_SPIP)</p>]
Return values
Champ

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

balise_HTML5_dist()

Compile la balise `#HTML5` indiquant si l'espace public peut utiliser du HTML5

balise_HTML5_dist(Champ $p) : Champ

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

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
uses
html5_permis()
example
[(#HTML5) required="required"]
<input[ (#HTML5|?{type="email",type="text"})] ... />
Return values
Champ

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

balise_TRI_dist()

Compile la balise `#TRI` permettant d'afficher un lien de changement d'ordre de tri d'une colonne de la boucle

balise_TRI_dist(Champ $p[, string $liste = 'true' ]) : Champ

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)

Parameters
$p : Champ

Pile au niveau de la balise

$liste : string = 'true'

Inutilisé

Tags
balise
example
<th>[(#TRI{titre,<:info_titre:>,ajax})]</th>
Return values
Champ

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

balise_SAUTER_dist()

Compile la balise `#SAUTER{n}` qui permet de sauter en avant n resultats dans une boucle

balise_SAUTER_dist(Champ $p) : Champ

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

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
Return values
Champ

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

balise_PUBLIE_dist()

Compile la balise `#PUBLIE` qui indique si un objet est publié ou non

balise_PUBLIE_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
link
https://www.spip.net/5545
see
objet_test_si_publie()
example
#PUBLIE : porte sur la boucle en cours
[(#PUBLIE{article, 3}|oui) ... ] : pour l'objet indiqué
Return values
Champ

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

balise_PRODUIRE_dist()

Compile la balise `#PRODUIRE` qui génère un fichier statique à partir d'un squelette SPIP

balise_PRODUIRE_dist(Champ $p) : Champ

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.

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
see
balise_INCLURE_dist()
link
https://www.spip.net/5505
example
<link rel="stylesheet" type="text/css" href="#PRODUIRE{fond=css/macss.css,couleur=ffffff}" />
Return values
Champ

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

balise_LARGEUR_ECRAN_dist()

Compile la balise `#LARGEUR_ECRAN` qui définit la largeur d'écran dans l'espace privé

balise_LARGEUR_ECRAN_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
example
#LARGEUR_ECRAN{pleine_largeur}
Return values
Champ

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

balise_CONST_dist()

Compile la balise `#CONST` qui retourne la valeur de la constante passée en argument

balise_CONST_dist(Champ $p) : Champ
Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
example

#CONST{_DIR_IMG}

Return values
Champ

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


        
On this page

Search results