Le fichier mes_options.php

Le fichier mes_options.php offre la possibilité de modifier la configuration par défaut de SPIP.

Quelles options ?

Il est possible de :

  • définir des "constantes" PHP : en effet, une fois définie, une constante PHP ne peut plus être changée dans la session ;
  • adapter les variables de personnalisation (globales) ;
  • définir des fonctions dépendant du mécanisme xxx_dist() ou plus généralement chargées par charger_fonction().

Voir la liste complète des constantes et des variables de personnalisation dans le glossaire.

Créer le fichier mes_options.php

Par défaut, SPIP ne fourni pas ce fichier. Il est donc à créer dans le répertoire config/ [1].

mes_options.php étant un fichier PHP, il doit commencer par <?php (soyez extrêmement vigilant : il ne doit y avoir aucun caractère ni espace ni ligne vierge avant la balise ouvrante <?php).
SPIP adopte les conventions PHP récentes, il est donc recommandé de ne plus indiquer de balise fermante ?>.

Exemple

…de fichier mes_options.php :

<?php

// sécurité
if (!defined('_ECRIRE_INC_VERSION')) {
    return;
}

// Définir une constante
// interdire l'upload de documents de plus de 500 Ko
define('_DOC_MAX_SIZE', 500);


// Adapter une variable de personnalisation
// forcer l’affichage d’un menu déroulant à partir de 2010 pour
// le champ "Date de première publication"
$GLOBALS['debut_date_publication'] = '2010';

Usage avancé

Il est possible dans ce fichier personnel d’invoquer la fonction spip_initialisation() pour définir les répertoires de données et, par exemple, disposer ainsi de plusieurs sites sous SPIP utilisant une seule distribution (l’appel standard de cette fonction, plus loin dans inc_version.php, sera automatiquement neutralisé).
Voir à ce propos le Mécanismes de fabrication des pages publiques et privées

Avertissement sur la performance

Lorsqu’il existe, ce fichier est chargé à chaque affichage de page (espace privée comme espace publique) ; il doit donc être le plus léger et économe possible.

Voir aussi

Sur le site programmer.spip.net

Notes

[1dans les versions de SPIP antérieures à 1.9.2, ce fichier était placé dans le répertoire ecrire/

Auteur denisb Publié le : Mis à jour : 26/10/18

Traductions : català, English, français, Nederlands