Différences entre versions de « Plugin SPIP »

De Cliss XXI
Sauter à la navigation Sauter à la recherche
imported>SylvainBeucler
m
imported>SylvainBeucler
m
Ligne 1 : Ligne 1 :
 +
= Introduction =
 +
 
* [http://www.spip.net/rubrique205.html Le développement de SPIP et ses outils]: documentation officielle
 
* [http://www.spip.net/rubrique205.html Le développement de SPIP et ses outils]: documentation officielle
 
* [http://doc.spip.org/@Les-points-d-entree-pipelines Les points d’entrée (pipelines)]: les ''hooks'', quoi
 
* [http://doc.spip.org/@Les-points-d-entree-pipelines Les points d’entrée (pipelines)]: les ''hooks'', quoi
Ligne 5 : Ligne 7 :
 
** [http://www.spip.net/fr_article3800.html Les formulaires CVT de SPIP 2.0]
 
** [http://www.spip.net/fr_article3800.html Les formulaires CVT de SPIP 2.0]
 
* Le "SPIP_PATH", pour chercher les squelettes, dans l'ordre: <code>squelettes, (racine), squelettes-dist, prive, ecrire</code> (cf. <code>ecrire/inc/utils.php:_chemin()</code>)
 
* Le "SPIP_PATH", pour chercher les squelettes, dans l'ordre: <code>squelettes, (racine), squelettes-dist, prive, ecrire</code> (cf. <code>ecrire/inc/utils.php:_chemin()</code>)
 +
 +
= API =
 +
 +
http://doc.spip.org/ a pour but de documentation l'API de SPIP, une page par fonction, modifiable par tous.
 +
En pratique, peu de fonctions sont documentées. Qui plus est, cette documentation étant sensées être la documentation officielle, le code source se contente d'y faire référence, sans détailler ces fonctions - donc il n'y a pas plus d'informations dans les fichiers .php de <code>ecrire/</code>.
 +
 +
La meilleure source de documentation reste la lecture directe du code source, et l'étude d'autres plugins.
 +
 +
= Passer de 1.9 à 2.0 =
 +
 +
Certaines fonctions ont changé. Pour convertir le code de votre plugin, une bonne source d'information est <code>ecrire/inc/vieilles_defs.php</code> qui définit des anciennes fonctions avec la nouvelle API 2.0.
 +
 +
= Insérer une nouvelle page =
 +
 +
* Définir le préfixe de votre plugin (convention de nommage)
 +
* Créer plugins/votre_plugin/exec/prefix_mapage.php
 +
* Y définir prefix_mapage() (ou prefix_mapage_dist()?)
 +
* Corps de la fonction:
 +
$commencer_page = charger_fonction('commencer_page', 'inc');
 +
echo $commencer_page("Mon titre");
 +
# ...
 +
echo fin_page();

Version du 14 avril 2009 à 10:43

Introduction

API

http://doc.spip.org/ a pour but de documentation l'API de SPIP, une page par fonction, modifiable par tous. En pratique, peu de fonctions sont documentées. Qui plus est, cette documentation étant sensées être la documentation officielle, le code source se contente d'y faire référence, sans détailler ces fonctions - donc il n'y a pas plus d'informations dans les fichiers .php de ecrire/.

La meilleure source de documentation reste la lecture directe du code source, et l'étude d'autres plugins.

Passer de 1.9 à 2.0

Certaines fonctions ont changé. Pour convertir le code de votre plugin, une bonne source d'information est ecrire/inc/vieilles_defs.php qui définit des anciennes fonctions avec la nouvelle API 2.0.

Insérer une nouvelle page

  • Définir le préfixe de votre plugin (convention de nommage)
  • Créer plugins/votre_plugin/exec/prefix_mapage.php
  • Y définir prefix_mapage() (ou prefix_mapage_dist()?)
  • Corps de la fonction:
$commencer_page = charger_fonction('commencer_page', 'inc');
echo $commencer_page("Mon titre");
# ...
echo fin_page();