SPIP

Maintain a CHANGELOG

jack — 2026-04-29T09:44:29Z

CHANGELOG files follow the standard Keep a Changelog.

What is a changelog?

A changelog (change log) is a file that contains a chronological list of notable changes for each version of a project.

Why keep a changelog?

To allow users and contributors to see exactly what notable changes have been made between each release (or version) of a project.

More details at https://keepachangelog.com.

Each entry in the changelog must:

reference the ticket (or the PR if there is no corresponding ticket);
clearly and concisely describe the changes made by the PR;

For each version, indicate the version number followed by the date in YEAR-MONTH-DAY format.

Entries are grouped by category. Here are the categories used in SPIP.

Entry type	Meaning
Added	For new features
Changed	For changes to existing features
Deprecated	For features that will soon be removed
Removed	For features that have now been removed
Fixed	For bug fixes
Security	In case of vulnerabilities

Example of simple changelog

# Changelog ## 1.0.2 - 2023-07-25 ## Fixed - Ne pas afficher le texte du modèle `icone` et le mettre en `title` du lien ### Changed - mise à jour du README.md maintenant que la doc est sur contrib ## 1.0.1 - 2023-06-22 ### Added - ajout d'un CHANGELOG.md ### Changed - compatibilité SPIP 4.1+ - mise à jour de la documentation dans le README.md

Example of complete changelog

For a more comprehensive example, see SPIP.

_IFRAME_SAFE_DOMAINS

jack — 2026-04-29T09:43:55Z

As a matter of security, iframes are hidden in the private area from SPIP 4.4.8 onwards, except for domains explicitly authorised via a constant _IFRAME_SAFE_DOMAINS.
This constant must contain an array of regular expressions describing all authorised domains, without protocol, without path and without “/” at the end.
Example : define ('_IFRAME_SAFE_DOMAINS', [ 'en\.wikipedia.org', '.*\.spip\.net']);

- Variables and Constants for customisation / SPIP 4.4, _IFRAME_SAFE_DOMAINS

|propre

jack — 2026-04-29T09:43:37Z

This filter is applied by default by SPIP to long texts (#TEXT, #CHAPO, #PS, etc.).
It applies typographical processing and SPIP shortcuts (italics, bold, subheadings, etc.) to a text.
See also Filters

- Filters / propre

#_n:BALISE

jack — 2026-04-29T09:43:14Z

In case of embedded loops, it is sometimes useful to retrieve the content of a parent loop from the current loop using a tag. SPIP has a syntax for this (n being the identifier of the desired loop):

#_n:TAG

Example

Systematically display the section title along with the article title:

   #_rubs:TITRE - #TITRE

|balise_img_svg

jack — 2026-04-29T09:41:47Z

The balise_img_svg filter allows to insert a tag or an tag depending on whether its argument is an SVG file or another image format.

Indeed:

the balise_img filter inserts an tag regardless of the type of image received as an argument, including when it is an SVG file
the balise_svg filter always inserts an tag.

The balise_img_svg filter is therefore useful when applied to an image whose format is unknown in advance and when you want SVG images to be inserted with an tag.

This filter is applied to the relative URL of an image file or an already formed image tag. It accepts the following optional parameters:

alt: alternative text (or a null value to explicitly not have an alt tag on the image instead of an empty alt)
class: null by default
size: allows you to specify the size of the rendering (see syntax details: |balise_img)

Usage examples:

[(#LOGO_ARTICLE|balise_img_svg{'here application on an img tag', 'spip_logo'})] [(#FICHIER|balise_img_svg{'here application on a file', 'spip_doc'})] [(#CHEMIN{#GET{animage}}|balise_img_svg)]

Configuring a feature of your site or a plugin

jack — 2026-02-28T11:11:15Z

Configuring a feature or plugin involves defining values for their various parameters. To do this, you need to define a form and be able to access the parameter values anywhere in your templates.

CVT forms also make it easy to create a configuration page for a feature on your site or for configuring a plugin.

A configuration mode is built into SPIP.

Configuration Form

Suppose you have a ‘thing' feature to configure.

Create a CVT form whose name begins with ‘configure_', with just the HTML file and without the PHP (and therefore without defining the load, verify and process functions) [1].
create a page configure_thing.html in private/squelettes/contenu/, inside your plugin or your skeleton directory. Inside, call the form with simply #FORMULAIRE_CONFIGURER_THING

That's all!

Configuring a plugin

When a plugin has a configuration page, a ‘Configure' option leading to this page automatically appears next to this plugin in the plugin administration page.

This page is defined by the template prive/squelettes/contenu/configurer_prefixeplugin.html and most often uses a configuration form.

Example: for the “mediabox” plugin, the file prive/squelettes/contenu/configurer_mediabox.html contains:

[(#AUTORISER{configurer,mediabox}|oui) <:mediabox:titre_page_configurer_box:>
  #FORMULAIRE_CONFIGURER_MEDIABOX 
 ]

If you want an entry to also appear in the menus in the private area to give you direct access to this configuration page, add a

entry in the paquet.xml file.

Example :

To initialise the value of a configuration (e.g. the in_the_spotlight parameter) when creating or updating the plugin, add the following to the myplugin_upgrade() pipeline:

during creation:

$maj['create'] = array( array('ecrire_config','myplugin/in_the_spotlight', '3'), );

during an update:

$maj['0.1'] = array( array('ecrire_config','myplugin/in_the_spotlight', '3'), );

To clear the value when uninstalling the plugin, add the following to the pipeline: myplugin_vider_tables():

effacer_config("myplugin/in_the_spotlight");

Access configured values

In a template, the value of a configuration can be accessed using the #CONFIG tag (for example #CONFIG{myplugin/in_the_spotlight})

In PHP the values can be accessed in read mode using the lire_config function with lire_config(“myplugin/in_the_spotlight”).

When writing, use the ecrire_config function:
ecrire_config('myplugin/in_the_spotlight', 3)

Autorisations

Not all users have access to the configuration page. By default, only administrators have this option, but you can redefine access rights to your configuration form. To do this, use the php authorise API, as well as the #AUTHORISE tag and the otherwise_deny_access filter for your form template.

Example : [(#AUTORISER{configurer,mediabox}|sinon_interdire_acces)]

Customise treatments

Sometimes, other specific treatments are required when configuration values are changed. In this case, the usual traiter() function from the CVT API must be added, and the common function that handles configuration processing must be called:

function formulaires_configurer_myplugin_traiter_dist() { include_spip('inc/cvt_configurer'); $retours = array(); // The new configuration is saved. $trace = cvtconf_formulaires_configurer_enregistre('configurer_myplugin', array()); // Customised treatments // … $retours['message_ok'] = _T('config_info_enregistree') . $trace; $retours['editable'] = true; return $retours; }

Use another table to store the configured values

By default, the configured values are stored in the spip_meta table, and the entire table is loaded into memory with each hit. However, it is possible to use another table to store the configured values.

For example, to use the meta_myplugin table, add the following line to the configuration form:

Then, to access the values stored in this table, specify the table name prefixed with a / at the beginning of the lire_config argument:

ecrire_config('/meta_myplugin/description', 'blah'); lire_config('/meta_myplugin/argument');

In addition to _meta_table, the name of the table where the configured values are stored, there are three other useful variables to change where or how the configuration is saved:

_meta_casier: name of the ‘casier' in which to serialise (by default, this is the xx from formulaire_configurer_xx)
_meta_prefixe: prefix the meta (alternative to the casier) in the meta table (no default prefix)
_meta_stockage: use an external storage method. None are provided by the core.

[1] To further simplify the creation of this form, you can use the Entries plugin

#VIRTUEL

jack — 2026-02-28T09:34:16Z

This tag returns the value of the redirection field entered for an article (this entry is made in the navigation column of the article editing page).
This option must have been enabled in the ‘Site content' configuration page.

- Tags / BOUCLE(ARTICLES), #VIRTUEL

{virtuel}

jack — 2026-02-24T09:34:00Z

The {virtuel} criterion in an ARTICLES loop allows only virtual articles (which redirect to another URL) to be retained.

Conversely, with {virtuel=''} or {!virtuel}, the loop will only return items that have not been redirected.

See: #VIRTUEL

|wrap

jack — 2026-02-23T13:41:06Z

The |wrap{} filter wraps the tag to which it is applied with the HTML tag specified as a parameter.

Simple examples

[(#BALISE|wrap{})]

will display as HTML source:
blah blah

[(#TITRE|wrap{#TOTAL_BOUCLE|=={1}|?{,
}})]

will display as HTML source if the loop returns only one result:

The Title

but will display:
The Title Another Title
if the loop returns several results.

HTML tag sequences

It is also possible to pass a series of tags as arguments. The final tags will be calculated to produce a correct nesting. The tags specified as filter arguments may include attributes.

Example :

[(#BALISE|wrap{
})]

will display as HTML source:

blah blah

#PRODUIRE

Ricardo Porto — 2025-09-09T16:37:12Z

A tag #PRODUIRE (produzir) gera um ficheiro estático a partir de um template dinâmico de CSS (.css.html) ou de Javascript (.js.html). A partir do SPIP 4, os ficheiros que geram SVG (.svg.html), XML (.xml.html) e JSON (.json.html) também são levados em conta.

#PRODUIRE retorna o nome desse ficheiro estático, o que permite ao Apache servi-lo diretamente, sem passar por spip.php a cada hit.

A sintaxe dos argumentos da tag #PRODUIRE é a mesma de #INCLURE.

O formato do ficheiro é indicado pela pré-extensão do ficheiro: .css.html, .js.html, .xml.html, .json.html, .svg.html. Senão, é HTML.

Pode-se forçar o formato do ficheiro passando como argumento adicional format=css (ou format=js...)..

Nota: o resultado de #PRODUIRE inclui o timestamp do ficheiro template recebido como argumento.