La création d’un plugin sur WordPress est relativement simple tant ce CMS est bien conçu et bien documenté. Il est tout aussi facile d’ajouter un plugin sur l’annuaire des plugins sur le site WordPress.org. Cet article explique comment ajouter une bannière sur la page de son plugin, une fonctionnalité peu documenté mais pourtant très intéressante.
A qui est destiné ce tutoriel
Ce tutoriel est réservé à un plugin de développeurs qui ont déjà fabriqué un plugin WordPress. Le but de cet article consiste à comprendre comment ajouter la bannière sur le site WordPress.org.
Exemple de page d’un plugin avant/après l’ajout d’une bannière
Le plugin Copyright Footer RSS de WordPress va servir d’exemple illustrer pour mieux comprendre l’objectif de ce petit tutoriel. Voici l’aperçu de sa page sur WordPress.org avant d’ajouter une bannière:
Page du plugin Copyright Footer RSS avant la bannière
La page est certes élégantes, mais il manque le petit « plus » qui permet de vraiment accrocher. Maintenant, voici la même page avec une bannière:
Page du plugin Copyright Footer RSS après la bannière
Cette page est tout de suite plus attrayante et donne envie de télécharger le plugin pour l’installer sur son blog WordPress.
Création de la bannière
La première étape consiste à créer l’image qui servira de bannière. L’essentiel est de faire une image jpeg ou PNG (pas de gif) d’une largeur de 772 pixels de large et d’une hauteur de 250 pixels. Lors de la conception, n’oubliez pas qu’il y aura le titre du plugin qui sera affiché au dessus de cette bannière. Pour être précis, le titre fait 52 pixels de haut et est placé à 30 pixels du bord gauche et à 20 pixels du bord bas (la largeur est variable, selon le nom de votre plugin).
Il convient ensuite de renommer l’image avec le nom « banner-772×250.png » ou « banner-772×250.jpg ».
Ajouter le dossier dans son SVN
Il faut ensuite créer un dossier « assets » (attention au pluriel) à la racine de son plugin (attention : en dehors du dossier trunk). L’image doit ensuite être ajouté dans le dossier « assets ». La hiérarchie des fichiers doit ainsi ressembler à ceci:
/svn/
– /assets/
– – banner-772×250.png
– /trunk/
– – mon-fichier.php
– – readme.txt
– /branches/
– /tags/
(dans cet exemple, il n’y a qu’un seul fichier PHP dans trunk, c’est juste un exemple).
Ajout sur le dépot SVN
La dernière étape consiste à envoyer l’image sur le dépot de WordPress.org. Il faut donc effectuer les commandes suivantes dans SVN:
svn add assets/
svn add assets/*
svn ci -m ‘add banner image’
Et hop, c’est terminé. Il faut maintenant atteindre quelques minutes (1 à 15 minutes environ). N’hésitez pas à indiquer si cette petite astuce à améliorer le taux de téléchargement de votre plugin.