Skip to content

[FR] Addon, introduction à la création

RemRem edited this page Apr 22, 2017 · 4 revisions

! Ce document est en cours de rédaction.


BlogoText propose un système d'addons (modules) permettant d'étendre les fonctionnalités du core afin de proposer des fonctionnalités en plus et de travailler sur les différents contenus (articles, liens...). Les addons disposent de leur propre GitHub, avant de vous lancer dans la création d'un addon, vérifiez qu'il n'existe pas déjà ;)

Nous allons créer ensemble un addon, le plus simple qui soit, qui affichera l'heure du serveur.

1. Trouver un nom pour votre addon et son tag

Il est préférable que le nom de votre addon soit suffisamment explicite et le tag doit être obligatoirement unique (cf. le GitHub des addons. Pour se faciliter la vie, il est d'usage que le tag soit raccord au nom de l'addon, dans notre cas, nous allons nommer notre addon "Affiche l'heure du serveur" et son tag sera "quel-heure-est-il")

2. Identifier ce que l'on veux faire

BlogoText propose pas mal de chose point de vue addon : un tag (celui du module) à insérer dans le template ou directement dans les articles, liens (...), un système de hook et quelques autres fonctionnalités. Pour notre exemple, nous n'allons pas modifier de template, ni utiliser le système de hook, nous allons laisser l'administrateur utiliser notre module comme il le souhaite dans ses articles, ses liens (...). Pour se faire, l'administrateur a juste besoin de connaître notre tag et à l'insérer dans son contenu. Pour connaître le tag de notre module, il sera affiché dans l'administration automatiquement, donc pour notre module, rien de particulier à faire

3. Créer notre addon

Il ne faut pas grand chose pour créer un addon blogotext :

  • Créez un dossier et nommez le d’après notre tag quel-heure-est-il
  • Dans ce dossier, créez un fichier quel-heure-est-il.php, ce fichier doit être en UTF-8 sans BOM.
  • Éditez ce fichier avec votre éditeur préféré (dans mon cas, notepad++)
  • Définissez la configuration de votre addon [TODO]