Ecrire un plugin

Avant de continuer la lecture, vous devez être conscient qu'écrire un plugin nécessite un bon nombre de connaissances… que vous soyez accommodé avec le fonctionnement interne de fr.eelinker3, que vous ayez des connaissances en php, des connaissances en programmation dite “objet”, et que vos plugins respectent la convention de codage.

fr.eelinker3 est un projet écrit en objet (Poo) et inclus une suite d'outil afin de structurer et faciliter son extension via des plugins. Afin de structurer au maximum la gestion de ces extensions, nous les avons séparé en trois groupes.

• Des plugins du type admin. Il sont destiné à être utilisé dans le panneau d'administration de fr.eelinker.
• Des plugins du type public, qui sont censé apporter une fonctionnalité sur le site lui même.
• Des plugins du type mixed. Ces plugins sont à la fois du type public et du type admin.

Le premiere chose à définir est le nom du plugin, duquel vous allez déduire le préfix. Dans un soucis d'internationalisation, il sera préférable de choisir un nom anglophone. Tout cela parait compliqué, c'est en réalité très simple à comprendre en suivant l'exemple ci-dessous.

Admettons que vous voulez créer un plugin qui permette de mettre le titre des freesites en majuscule, sans exceptions, sur toutes les pages de votre site. Le nom adéquate du plugin sera alors Title uppercase ou pourquoi pas Title uppercaser.

Bon… vous avez choisis Title uppercase, le prefix de votre plugin (qui est en soit un identifiant unique, sans majuscule, sans espace, avec au maximum une dizaine de caractères) sera alors titleup. Pensez à vérifier si ce préfix n'est pas déjà pris par un autre plugin… rapellez vous, un préfix est unique.

Vous avez votre préfix (titleup) unique, vous pouvez commencer par créer un dossier ayant ce nom dans le répertoire plugins/. La structure du répertoire ressemblera à ceci:

• plugins/
  • titleup/

La tâche suivante consiste à créer les fichiers de votre plugin. Ils seront à mettre dans le répertoire de ce dernier. Par défaut, un plugin doit contenir deux fichiers obligatoires, auquel cas, votre plugin ne fonctionnera pas.

• plugins/
  • titleup/
    • plugin.xml - Ce fichier contient les diverses informations de votre plugin.
    • plugin.php - Ce fichier contient le code php.

Voilà, la structure de fichier de votre template est terminé. Vous pouvez maintenant commencer à renseigner le fichier de définition de plugin (plugin.xml). Une fois cette tâche effectué, vous pouvez passer au code dans le fichier de définition de plugin (plugin.php)

Document annexe: Gestion des plugins