SPIP Code

Documentation du code de SPIP et de ses plugins

SPIP

loading.php

Table of Contents

Functions

charger_fonction()  : string
Cherche une fonction surchargeable et en retourne le nom exact, après avoir chargé le fichier la contenant si nécessaire.
include_once_check()  : bool
Inclusion unique avec verification d'existence du fichier + log en crash sinon
include_spip()  : string|bool
Inclut un fichier PHP (en le cherchant dans les chemins)
require_spip()  : string|bool
Requiert un fichier PHP (en le cherchant dans les chemins)
include_fichiers_fonctions()  : mixed
Raccourci pour inclure mes_fonctions.php et tous les fichiers _fonctions.php des plugin quand on a besoin dans le PHP de filtres/fonctions qui y sont definis
charger_fonction_url()  : string
Charger la fonction de gestion des urls si elle existe
trouve_modele()  : string
Trouve un squelette dans le repertoire modeles/
trouver_fond()  : array<string|int, mixed>|string
Trouver un squelette dans le chemin on peut specifier un sous-dossier dans $dir si $pathinfo est a true, retourne un tableau avec les composantes du fichier trouve + le chemin complet sans son extension dans fond
aider()  : Lien
Retourne un lien vers une aide
tester_url_ecrire()  : string
Teste, pour un nom de page de l'espace privé, s'il est possible de générer son contenu.

Functions

charger_fonction()

Cherche une fonction surchargeable et en retourne le nom exact, après avoir chargé le fichier la contenant si nécessaire.

charger_fonction(string $nom[, string $dossier = 'exec' ][, bool $continue = false ]) : string

Charge un fichier (suivant les chemins connus) et retourne si elle existe le nom de la fonction homonyme $dir_$nom, ou suffixé $dir_$nom_dist

Peut être appelé plusieurs fois, donc optimisé.

Parameters
$nom : string

Nom de la fonction (et du fichier)

$dossier : string = 'exec'

Nom du dossier conteneur

$continue : bool = false

true pour ne pas râler si la fonction n'est pas trouvée

Tags
uses
include_spip()

Pour charger le fichier

example 
$envoyer_mail = charger_fonction('envoyer_mail', 'inc');
$envoyer_mail($email, $sujet, $texte);
used-by
auth_administrer()
Return values
string —

Nom de la fonction, ou false.

include_once_check()

Inclusion unique avec verification d'existence du fichier + log en crash sinon

include_once_check(string $file) : bool
Parameters
$file : string
Return values
bool

include_spip()

Inclut un fichier PHP (en le cherchant dans les chemins)

include_spip(string $f[, bool $include = true ]) : string|bool
Parameters
$f : string

Nom du fichier (sans l'extension)

$include : bool = true
  • true pour inclure le fichier,
  • false ne fait que le chercher
Tags
uses
find_in_path()
example 
include_spip('inc/texte');
used-by
charger_fonction()

Pour charger le fichier

Return values
string|bool —
  • false : fichier introuvable
  • string : chemin du fichier trouvé

require_spip()

Requiert un fichier PHP (en le cherchant dans les chemins)

require_spip(string $f) : string|bool
Parameters
$f : string

Nom du fichier (sans l'extension)

Tags
uses
find_in_path()
see
include_spip()
example 
require_spip('inc/texte');
Return values
string|bool —
  • false : fichier introuvable
  • string : chemin du fichier trouvé

include_fichiers_fonctions()

Raccourci pour inclure mes_fonctions.php et tous les fichiers _fonctions.php des plugin quand on a besoin dans le PHP de filtres/fonctions qui y sont definis

include_fichiers_fonctions() : mixed

charger_fonction_url()

Charger la fonction de gestion des urls si elle existe

charger_fonction_url(string $quoi[, string $type = '' ]) : string
Parameters
$quoi : string

'page' 'objet' 'decoder' ou objet spip pour lequel on cherche la fonction url par defaut (si type==='defaut')

$type : string = ''

type des urls (par defaut la meta type_urls) ou 'defaut' pour trouver la fonction par defaut d'un type d'objet

Return values
string

trouve_modele()

Trouve un squelette dans le repertoire modeles/

trouve_modele( $nom) : string
Parameters
$nom :
Return values
string

trouver_fond()

Trouver un squelette dans le chemin on peut specifier un sous-dossier dans $dir si $pathinfo est a true, retourne un tableau avec les composantes du fichier trouve + le chemin complet sans son extension dans fond

trouver_fond(string $nom[, string $dir = '' ][, bool $pathinfo = false ]) : array<string|int, mixed>|string
Parameters
$nom : string
$dir : string = ''
$pathinfo : bool = false
Return values
array<string|int, mixed>|string

aider()

Retourne un lien vers une aide

aider([string $aide = '' ][, bool $distante = false ]) : Lien

Aide, aussi depuis l'espace privé à présent. Surchargeable mais pas d'erreur fatale si indisponible.

Parameters
$aide : string = ''

Cle d'identification de l'aide desiree

$distante : bool = false

Generer une url locale (par defaut) ou une url distante [directement sur spip.net]

Return values
Lien —

sur une icone d'aide

tester_url_ecrire()

Teste, pour un nom de page de l'espace privé, s'il est possible de générer son contenu.

tester_url_ecrire(string $nom) : string

Dans ce cas, on retourne la fonction d'exécution correspondante à utiliser (du répertoire ecrire/exec). Deux cas particuliers et prioritaires : fond est retourné si des squelettes existent.

  • fond : pour des squelettes de prive/squelettes/contenu ou pour des objets éditoriaux dont les squelettes seront échaffaudés
Parameters
$nom : string

Nom de la page

Return values
string —

Nom de l'exec, sinon chaîne vide.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results