Site de documentation destiné aux développeurs de plugins pour SPIP.
Ce site est né de la rencontre entre :
- Marcimat, ayant envie d’écrire cette documentation, mais n’en ayant pas les moyens financiers
- Jacques Pyrat, qui avait les moyens de financer cette entreprise
- Pascal qui a lui aussi contribué
N’hésitez pas à contribuer vous aussi !
Articles syndiqués tirés de ce site
- Documenter l’utilisation du plugin avec un README.md
-
8 juin, par erational, JLuc
La balise ’documentation’ du paquet.xml de votre plugin contient un lien vers la documentation. - Documenter le code
- La fonction
_T -
31 mai, par JLuc
La fonction _T fait correspondre à une référence de chaîne de langue sa valeur traduite dans la langue du contexte. Son premier argument contient l’identifiant de la chaîne, et le 2e argument contient, si nécessaire, le tableau des arguments requis pour l’évaluation de la chaîne. Fonction (…)
- renseigner_document_distant
-
20 avril, par JLuc
Un plugin peut avec le pipeline renseigner_document_distant renseigner les informations fichier et mode avant l’analyse et traitement par ce plugin. Exemples d’usage : – dans le plugin oembed : https://git.spip.net/spip-contrib-extensions/oembed/-/blob/master/oembed_pipelines.php?ref_type=heads#L1
- Déclarer une tâche hors plugin
-
7 janvier, par JLuc, Maïeul
Il est également possible de déclarer une tâche hors plugin, si jamais vous n’avez pas défini de plugin maison pour le squelette de votre site : 1) Créez un dossier ’genie’ dans votre dossier squelettes 2) Ajoutez y un fichier PHP contenant la fonction de votre tâche, nommé comme la fonction. (…)
- Créer une aide en ligne pour un plugin
-
Octobre 2025, par JLuc, Thrax
1. Déclarer l’usage du plugin aide et de son pipeline Le plugin aide est fourni avec la distribution de SPIP (plugins-dist/aide/). Il est de bonne pratique de déclarer son utilisation dans le paquet de votre plugin de façon à ce que l’on sache qu’il est utilisé, au cas où la distribution (…)
- get_spip_doc
-
Juillet 2025, par RastaPopoulos
La fonction get_spip_doc permet à SPIP de s’assurer d’avoir toujours le bon chemin vers un fichier, qu’il soit en absolu avec une URL complète, ou venant de SPIP (normalement du dossier IMG). Cette fonction est appelée presque à chaque fois que SPIP doit afficher un document, image ou autre. Le (…)
- auth_identifier_login
-
Mai 2025, par JLuc
La fonction auth_identifier_login essaie les différentes sources d’authenfication déclarées et met le résultat dans visiteur_session[’auth’]. Elle reçoit comme arguments le login, le mot de passe, le serveur et un booléen qui indique si on accepte l’authentification php (false par défaut). (…)
- image_extensions_logos
-
Février 2025, par Maïeul
Indiquer les extensions de logo autorisées. - Liste des pipelines
- Authentification http
-
Août 2024, par JLuc
Lorsque le mécanisme d’authentification HTTP Basic du serveur a authentifié l’utilisateur courant, alors les variables PHP $_SERVER[’PHP_AUTH_USER’] et $_SERVER[’PHP_AUTH_PW’] sont définies et valent son identifiant et mot de passe http. SPIP vérifie alors si ces valeurs correspondent au login (…)
- API de gestion des objets éditoriaux (
editer_objet) -
Mai 2024, par cerdic, JLuc
L’ajout, la modification et la publication des instances d’objets éditoriaux sont simplifiés par une interface de programmation (ou API) constituée de 3 fonctions génériques qui peuvent servir pour manipuler tous les objets de SPIP. Insérer Une nouvelle instance d’un objet éditorial est créée (…)