Documentation du code de SPIP et de ses plugins

SPIP

installer.php

Gestion de l'installation des plugins

Table of Contents

Functions

plugins_installer_dist()  : array<string|int, mixed>|bool
Installe ou retire un plugin
spip_plugin_install()  : bool|void
Fonction standard utilisée par defaut pour install/desinstall
liste_plugin_actifs()  : array<string|int, mixed>
Retourne un tableau des plugins activés sur le site

Functions

plugins_installer_dist()

Installe ou retire un plugin

plugins_installer_dist(string $plug, string $action[, string $dir_type = '_DIR_PLUGINS' ]) : array<string|int, mixed>|bool

Permet d'installer ou retirer un plugin en incluant les fichiers associés et en lançant les fonctions spécifiques.

  1. d'abord sur l'argument test,
  2. ensuite sur l'action demandée si le test repond false
  3. enfin sur l'argument test à nouveau.

L'index install_test du tableau résultat est un tableau formé :

  • du résultat 3
  • des echo de l'étape 2
Parameters
$plug : string

Nom du plugin

$action : string

Nom de l'action (install|uninstall)

$dir_type : string = '_DIR_PLUGINS'

Répertoire du plugin

Tags
note

La fonction quitte (retourne false) si le plugin n'a pas de version d'installation définie (information schema dans le paquet.xml)

used-by
action_desinstaller_plugin_dist()
used-by
plugin_installes_meta()
Return values
array<string|int, mixed>|bool
  • False si le plugin n'a pas d'installation,
  • true si déjà installé,
  • le tableau de get_infos sinon

spip_plugin_install()

Fonction standard utilisée par defaut pour install/desinstall

spip_plugin_install(string $action, array<string|int, mixed> $infos, string $version_cible) : bool|void
Parameters
$action : string

Nom de l'action (install|uninstall)

$infos : array<string|int, mixed>

Tableau des informations du XML du plugin complété par le nom et la table meta

$version_cible : string

Référence de la version du schéma de données cible

Return values
bool|void

liste_plugin_actifs()

Retourne un tableau des plugins activés sur le site

liste_plugin_actifs() : array<string|int, mixed>

Retourne la meta plugin désérialisée. Chaque élément du tableau est lui-même un tableau contenant les détails du plugin en question : répertoire et version.

Tags
note

Si le contenu de la meta n’est pas un tableau, cette fonction transforme l’ancien format en tableau sérialisé pour être conforme au nouveau fonctionnement (SPIP >= 1.9.2)

used-by
filtre_info_plugin_dist()

pour connaître les informations affichables

used-by
liste_chemin_plugin_actifs()
Return values
array<string|int, mixed>

Tableau des plugins actifs


        
On this page

Search results