web-dev-qa-db-fra.com

Comment ajouter un plugin à WordPress Repository?

Je viens de faire mon premier plugin et il a été approuvé par WordPress. Bonne nouvelle pour moi, mais maintenant quoi? Les "instructions" sur le Codex sont tout sauf claires pour moi. J'ai trouvé un article sur Dig WP et j'ai réussi à accéder à la 3ème ligne de code. Après cela, pas de joie.

Est-ce que quelqu'un ici a un ensemble d'instructions claires sur la façon de faire cela sans avoir besoin de lire un livre entier? Je suis sûr qu'il y a des gens très expérimentés ici qui font ce genre de choses tout le temps ...

Merci d'avance!

11
user2015

Étape 1 - Assurez-vous que les choses sont formatées correctement

WordPress lui-même dépend des en-têtes en haut de votre fichier de plugin principal. Dans de nombreux cas, si votre plugin est "My Cool Plugin", ce fichier est my-cool-plugin.php dans le répertoire principal de votre dossier. Assurez-vous que la partie supérieure du fichier respecte ce format:

<?php
/*
=== [Plugin Name] ===

Plugin Name: [Plugin name]
Plugin URI: [Website where plugin information can be found - your blog, maybe]
Description: [Short description of your plugin]
Author URI: [Your website]
Author: [Your name]
Version: [This version number]
*/

Le référentiel WordPress.org dépend de votre fichier readme.txt pour créer une description et une page de téléchargement. Assurez-vous donc que votre fichier readme.txt correspond au format suivant:

=== [Plugin Name] ===
Contributors: [Your WordPress.org username]
Donate link: [A site people can go to to give you money]
Tags: [Search terms related to your plugin]
Requires at least: [Minimum version of WordPress required]
Tested up to: [Newest version of WordPress you've tested with]
Stable tag: [This version number]

[Short, one-sentence description of your plugin]

== Description ==

[Long description of your plugin]

== Installation ==

[Steps required to install the plugin]

== Frequently Asked Questions ==

= [A question] =

[An answer]

= [Another question] =

[Another answer]

== Screenshots ==

== Changelog ==

== Upgrade Notice ==

Il existe un readme validator sur WordPress.org que vous pouvez utiliser pour vous assurer que votre fichier Lisez-moi possède tout ce dont il a besoin. Il suffit de copier/coller pour vérifier que toutes les sections sont présentes et que vous êtes prêt à partir.

Étape 2 - Consultez le référentiel SVN

C'est une bonne idée de garder votre version de développement séparée du référentiel de plugins WordPress.org. Oui, SVN est utilisé pour le contrôle de version, mais WordPress l’utilise davantage pour la gestion des versions. Si vous commencez à valider chaque ensemble de modifications dans le référentiel, vous risquez de rencontrer des problèmes. Une chose que beaucoup de développeurs font est de développer localement en utilisant Git, puis de transférer vos fichiers dans le référentiel Subversion lorsque vous êtes prêt à publier.

Ces instructions supposent que vous utilisez un ordinateur Windows. Si vous êtes sur un Mac, vous pouvez utiliser SCPlugin au lieu de TortoiseSVN. Les étapes à suivre seront les mêmes. Seuls les menus contextuels et les captures d'écran différeront légèrement en raison de l'interface utilisateur. Je n'ai pas de Mac, donc je ne peux pas créer de captures d'écran pour vous guider à travers un tutoriel ... mais croyez-moi, c'est le même processus.

Installez TortoiseSVN si vous ne l'avez pas déjà.

TortoiseSVN est une interface graphique à source ouverte Subversion pour Windows. Faites-moi confiance, utiliser l'interface graphique est infiniment plus facile que d'essayer de faire les choses à partir de la ligne de commande. Vous aurez aussi moins de problèmes.

Découvrez votre référentiel SVN hébergé par WordPress

Trouvez un endroit où vous souhaitez stocker la version de votre plugin hébergée par WordPress. Par défaut, j'utilise /My Documents/WordPress/ pour tout mon travail de développement hébergé. Cliquez avec le bouton droit de la souris sur le dossier et sélectionnez "SVN Checkout" dans le menu déroulant.

TortoiseSVN Contextual Menu

Dans la boîte de dialogue qui apparaît, entrez votre URL de référentiel de plug-in WordPress.org (j'utilise l'une des miennes à des fins de démonstration) et choisissez le sous-dossier que vous souhaitez créer.

Checkout Dialog

Tortoise va réfléchir un peu, puis il va extraire le référentiel de WordPress.org. Le dossier nouvellement créé aura tous les dossiers requis déjà configurés pour vous. Maintenant, il suffit de copier-coller et de commettre ... une étape à la fois.

Copiez votre dernière version dans /tags

C'est là que je fais les choses à l'envers de la plupart des tutoriels. Tout le monde vous dira de commettre d'abord /trunk, mais souvenez-vous que WordPress n'utilise rien dans /trunk sauf le fichier Lisez-moi quand on regarde les plugins. Donc, si vous mettez votre plugin dans /trunk et perdez votre connexion réseau (ou quelque chose d'autre va mal) avant de valider une balise, vous aurez des problèmes.

Dans le dossier /tags, créez un dossier portant le même nom que la version que vous publiez pour votre plug-in. Donc, si vous publiez la version 0.1, créez un dossier /tags/0.1.

Repository Tags Folder

Copiez l'intégralité de votre plugin dans ce dossier.

Maintenant, faites un clic droit dans le dossier et sélectionnez "SVN Commit" dans le menu déroulant.

Vous verrez une fenêtre pop-up qui affiche toutes vos modifications (vous devriez voir tous vos nouveaux fichiers marqués comme "non-versionnés").

Commit Window

Cochez la case en regard de tous les fichiers de votre plugin (ou cliquez sur "Tout sélectionner" pour les sélectionner tous).

Dans la zone située en haut, entrez un message de validation. Puisque vous validez une balise, vous devriez probablement utiliser quelque chose comme:

Marquage de la version 0.1 de [Mon plugin].

Cliquez sur OK.

Encore une fois, Tortoise réfléchira quelques minutes, puis vous demandera votre nom d’utilisateur et votre mot de passe WordPress afin de s’engager sur le serveur. Donnez-leur, attendez que les choses se passent et dites "Succès", puis passez à l'étape suivante.

Copiez votre dernière version dans /trunk

Naviguez maintenant dans le dossier /trunk du référentiel, puis copiez-collez votre plugin dans ce dossier. Suivez les mêmes étapes ci-dessus pour sélectionner vos fichiers et préparer la validation. Mais pour un message, utilisez quelque chose qui explique ce que fait la nouvelle version:

La version 0.1 de [My Plugin] - ajoute le support pour OpenID.

Une fois que tout est passé, il ne vous reste plus qu'à attendre que les serveurs de WordPress.org rattrapent leur retard. Ils peuvent être plus lents certains jours que d’autres, mais dans une heure environ, vous devriez voir votre nouvelle version dans le référentiel.

Mise à jour d'un plugin vers une nouvelle version

Une fois que votre plugin est dans la nature, préparer une mise à jour est relativement facile.

Commencez par utiliser la commande SVN Update pour vous assurer que vous disposez de la dernière version du référentiel. Si vous êtes le seul développeur, vous devriez déjà le faire, mais c'est une bonne pratique de mettre à jour avant de vous engager de toute façon.

Suivez ensuite le processus ci-dessus pour créer un nouveau sous-dossier dans /tags pour votre nouvelle version. Dites, /tags/0.2. Ne touchez pas l'ancien dossier /0.1. Il existe pour une raison et vous ne le toucherez plus jamais.

Commettez votre nouvelle balise, puis allez dans le dossier /trunk. Remplacez tout ce qui est dans /trunk par votre nouvelle version et validez comme ci-dessus. Une fois les serveurs mis à jour, ils commenceront à parler de la nouvelle version plutôt que de l’ancienne.

12
EAMann