SPIP Code

Documentation du code de SPIP et de ses plugins

SPIP

Presentation

Table of Contents

Functions

inc_commencer_page_dist()  : string
Débute une page HTML pour l'espace privé
init_entete()  : string
Envoi du DOCTYPE et du `<head><title> </head>`
init_head()  : string
Retourne le code HTML du head (intégration des JS et CSS) de l'espace privé
init_body()  : string
Fonction envoyant la double série d'icônes de rédac
init_body_class()  : string
Calcule les classes CSS à intégrer à la balise `<body>` de l'espace privé
auteurs_recemment_connectes()  : string
Afficher la liste des auteurs connectés à l'espace privé
debut_cadre()  : mixed
fin_cadre()  : mixed
debut_cadre_relief()  : mixed
fin_cadre_relief()  : mixed
debut_cadre_enfonce()  : mixed
fin_cadre_enfonce()  : mixed
debut_cadre_sous_rub()  : mixed
fin_cadre_sous_rub()  : mixed
debut_cadre_couleur()  : mixed
fin_cadre_couleur()  : mixed
debut_cadre_trait_couleur()  : mixed
fin_cadre_trait_couleur()  : mixed
debut_boite_alerte()  : mixed
fin_boite_alerte()  : mixed
debut_boite_info()  : mixed
fin_boite_info()  : mixed
gros_titre()  : string
Affiche le titre d’une page de l’interface privée. Utilisée par la plupart des fichiers `exec/xx.php`.
bloc_des_raccourcis()  : mixed
debut_onglet()  : mixed
fin_onglet()  : mixed
onglet()  : mixed
icone_verticale()  : string
Crée un lien précédé d'une icone au dessus du texte
icone_horizontale()  : string
Crée un lien précédé d'une icone horizontale

Functions

inc_commencer_page_dist()

Débute une page HTML pour l'espace privé

inc_commencer_page_dist([string $titre = '' ][, string $rubrique = 'accueil' ][, string $sous_rubrique = 'accueil' ][, string $id_rubrique = '' ][, bool $menu = true ][, bool $minipres = false ][, bool $alertes = true ]) : string

Préferer l'usage des squelettes prive/squelettes/.

Parameters
$titre : string = ''

Titre de la page

$rubrique : string = 'accueil'

?

$sous_rubrique : string = 'accueil'

?

$id_rubrique : string = ''

?

$menu : bool = true

?

$minipres : bool = false

?

$alertes : bool = true

?

Tags
uses
init_entete()
uses
init_body()
example 
$commencer_page = charger_fonction('commencer_page','inc');
echo $commencer_page($titre);
Return values
string —

Code HTML

init_head()

Retourne le code HTML du head (intégration des JS et CSS) de l'espace privé

init_head([string $titre = '' ][, int $dummy = 0 ][, bool $minipres = false ]) : string

Code HTML récupéré du squelette prive/squelettes/head/dist

Parameters
$titre : string = ''
$dummy : int = 0
$minipres : bool = false
Tags
used-by
init_entete()
Return values
string

init_body()

Fonction envoyant la double série d'icônes de rédac

init_body([string $rubrique = 'accueil' ][, string $sous_rubrique = 'accueil' ][, int $id_rubrique = '' ][, bool $menu = true ]) : string
Parameters
$rubrique : string = 'accueil'
$sous_rubrique : string = 'accueil'
$id_rubrique : int = ''
$menu : bool = true
Tags
uses
init_body_class()
uses
inc_bandeau_dist()
pipeline_appel

body_prive

global

mixed $connect_id_auteur

global

mixed $auth_can_disconnect

used-by
inc_commencer_page_dist()
Return values
string

init_body_class()

Calcule les classes CSS à intégrer à la balise `<body>` de l'espace privé

init_body_class() : string

Les classes sont calculées en fonction des préférences de l'utilisateur, par exemple s'il choisit d'avoir ou non les icônes.

Tags
used-by
init_body()
Return values
string —

Classes CSS (séparées par des espaces)

auteurs_recemment_connectes()

Afficher la liste des auteurs connectés à l'espace privé

auteurs_recemment_connectes(int $id_auteur) : string
Parameters
$id_auteur : int
Return values
string

debut_cadre()

debut_cadre(mixed $style[, mixed $icone = '' ][, mixed $fonction = '' ][, mixed $titre = '' ][, mixed $id = '' ][, mixed $class = '' ][, mixed $padding = true ]) : mixed
Parameters
$style : mixed
$icone : mixed = ''
$fonction : mixed = ''
$titre : mixed = ''
$id : mixed = ''
$class : mixed = ''
$padding : mixed = true

debut_cadre_relief()

debut_cadre_relief([mixed $icone = '' ][, mixed $dummy = '' ][, mixed $fonction = '' ][, mixed $titre = '' ][, mixed $id = '' ][, mixed $class = '' ]) : mixed
Parameters
$icone : mixed = ''
$dummy : mixed = ''
$fonction : mixed = ''
$titre : mixed = ''
$id : mixed = ''
$class : mixed = ''

debut_cadre_enfonce()

debut_cadre_enfonce([mixed $icone = '' ][, mixed $dummy = '' ][, mixed $fonction = '' ][, mixed $titre = '' ][, mixed $id = '' ][, mixed $class = '' ]) : mixed
Parameters
$icone : mixed = ''
$dummy : mixed = ''
$fonction : mixed = ''
$titre : mixed = ''
$id : mixed = ''
$class : mixed = ''

debut_cadre_sous_rub()

debut_cadre_sous_rub([mixed $icone = '' ][, mixed $dummy = '' ][, mixed $fonction = '' ][, mixed $titre = '' ][, mixed $id = '' ][, mixed $class = '' ]) : mixed
Parameters
$icone : mixed = ''
$dummy : mixed = ''
$fonction : mixed = ''
$titre : mixed = ''
$id : mixed = ''
$class : mixed = ''

debut_cadre_couleur()

debut_cadre_couleur([mixed $icone = '' ][, mixed $dummy = '' ][, mixed $fonction = '' ][, mixed $titre = '' ][, mixed $id = '' ][, mixed $class = '' ]) : mixed
Parameters
$icone : mixed = ''
$dummy : mixed = ''
$fonction : mixed = ''
$titre : mixed = ''
$id : mixed = ''
$class : mixed = ''

debut_cadre_trait_couleur()

debut_cadre_trait_couleur([mixed $icone = '' ][, mixed $dummy = '' ][, mixed $fonction = '' ][, mixed $titre = '' ][, mixed $id = '' ][, mixed $class = '' ]) : mixed
Parameters
$icone : mixed = ''
$dummy : mixed = ''
$fonction : mixed = ''
$titre : mixed = ''
$id : mixed = ''
$class : mixed = ''

gros_titre()

Affiche le titre d’une page de l’interface privée. Utilisée par la plupart des fichiers `exec/xx.php`.

gros_titre(string $titre[, string $ze_logo = '' ]) : string
Parameters
$titre : string

Le titre en question

$ze_logo : string = ''

Une image de logo

Return values
string —

Code PHP.

bloc_des_raccourcis()

bloc_des_raccourcis(mixed $bloc) : mixed
Parameters
$bloc : mixed

onglet()

onglet(mixed $texte, mixed $lien, mixed $onglet_ref, mixed $onglet[, mixed $icone = '' ]) : mixed
Parameters
$texte : mixed
$lien : mixed
$onglet_ref : mixed
$onglet : mixed
$icone : mixed = ''
Tags
used-by
barre_onglets()

icone_verticale()

Crée un lien précédé d'une icone au dessus du texte

icone_verticale(string $texte, string $lien, string $fond[, string $fonction = '' ][, string $align = '' ][, string $javascript = '' ]) : string
Parameters
$texte : string

texte du lien

$lien : string

URL du lien

$fond : string

Objet avec ou sans son extension et sa taille (article, article-24, article-24.png)

$fonction : string = ''

Fonction du lien (edit, new, del)

$align : string = ''

Classe CSS, tel que left, right pour définir un alignement

$javascript : string = ''

Javascript ajouté sur le lien

Tags
uses
icone_base()
see
filtre_icone_verticale_dist()

Pour l'usage en tant que filtre

example 
$icone = icone_verticale(_T('sites:info_sites_referencer'),
    generer_url_ecrire('site_edit', "id_rubrique=$id_rubrique"),
    "site-24.png", "new", 'right')
Return values
string —

Code HTML du lien

icone_horizontale()

Crée un lien précédé d'une icone horizontale

icone_horizontale(string $texte, string $lien, string $fond[, string $fonction = '' ][, string $dummy = '' ][, string $javascript = '' ]) : string
Parameters
$texte : string

texte du lien

$lien : string

URL du lien

$fond : string

Objet avec ou sans son extension et sa taille (article, article-24, article-24.png)

$fonction : string = ''

Fonction du lien (edit, new, del)

$dummy : string = ''

Inutilisé

$javascript : string = ''

Javascript ajouté sur le lien

Tags
uses
icone_base()
see
filtre_icone_horizontale_dist()

Pour l'usage en tant que filtre

Return values
string —

Code HTML du lien


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results