Creando un plugin para WordPress

Creando un plugin para WordPress parte 5: Subida al Repositorio

Hasta aquí hemos visto las buenas prácticas para desarrollar un plugin. El siguiente paso sería revisarlo y revisarlo de nuevo (como te aconsejan en el codex) para que no se pase ningún fallo. Ahora si lo quieres subir al repositorio de WordPress debes seguir estos pasos.

 

Readme.txt

Crea un archivo readme.txt en la raíz del plugin. Este archivo tiene un marcado específico, debemos seguir las reglas y el formato para que nuestro plugin se muestre correctamente en WordPress

El marcado específico de este archivo contempla reglas como:

  • En la primera línea escribe el nombre del plugin entre tres signos igual (=== Plugin Name ===)
  • Establece el nombre de autor o autores del plugin (contributors), link de donación (donate link), etiquetas (tags), descrición, etc…
  • Crea secciones de información, las que aparecerán como pestañas en la página oficial del plugin, con el nombre entre etiquetas con dos signos igual (== Description ==, == Instalation ==, etc…)
  • Usa 1., 2., 3. para listas ordenadas y * para listas desordenadas
  • Puedes ver cómo es un archivo readme.txt aquí.
  • Una vez que lo tengas, lo puedes validar aquí.

 

Envía el plugin a revisión

Haz un zip de tu plugin completo y envíalo a revisión rellenando el siguiente formulario. Cuando lo rellenes podrás ver cuantos plugins hay pendientes de revisión en cola, y si tu plugin es validado recibirás un mail en unos días para que puedas continuar con el proceso de subida.

subir plugin repositorio

Si nos aprueban el plugin nos envían un mail y nos dan acceso al repositorio de Subversion, concretamente a una carpeta con el nombre del plugin. Ahí podremos subir los archivos del plugin con nuestro usuario y contraseña de WordPress.org

plugin subversion

 

Súbelo al repositorio

Para trabajar con subversión lo podremos hacer a través de línea de comandos o con clientes subversión como por ejemplo Tortoise. Una vez enlazado con subversión, subiremos las imágenes de nuestro plugin a la carpeta assets, siguiendo una nomenclatura concreta:

  • banner-772×250.(jpg|png)
  • banner-1544×500.(jpg|png) (alta resolución, retina)
  • icon-128×128.(jpg|png)
  • icon-256×256.(jpg|png) (alta resolución, retina)
  • screenshot-(1, 2…N).png

 


En trunk/ subiremos todos los archivos de nuestro plugin, y lo enviaremos al repositorio:

  1. Abre un Terminal
  2. Crea en local una carpeta para tus plugins
        $ mkdir my-plugin
  3. Enlaza con tu repositorio
        $ svn co https://plugins.svn.wordpress.org/my-plugin my-plugin
  4. Añade todos los archivos de tu plugin a la carpeta trunk/ y las imágenes a la carpeta assets/
  5. Añade los archivos al repositorio
        $ cd my-plugin/
        $ svn add trunk/*
        $ svn add assets/*
        $ svn ci -m ‘Subiendo la primera versión de my-plugin’

 

Ya está en el repositorio!! Con esto concluyo esta serie de posts sobre buenas prácticas a la hora de desarrollar un plugin. Termino agradeciendo y otorgando la mitad del mérito a David Navia con quien tuve el placer de compartir ponencia en la WordCamp Bilbao 2016.


¿Me invitas a un café?
Si te ha gustado el blog o algún artículo en concreto te ha ayudado a resolver una duda o problema que tenías…¿me invitas a un café?

Puede que también te interese

Seguridad WordPress: backups
Tener un backup es imprescindible en cualquier desarrollo web. Es el plan B para cuando algo falla. Si todo funciona correctamente nunca recurriremos a él,…
Cómo cambiar el título del meta box de la imagen destacada en WordPress
En algunas ocasiones puede resultar de utilidad cambiar o renombrar el texto o título que aparece en el meta box de Imagen destacada. Por ejemplo…
Cómo mostrar los posts más vistos o populares en WordPress
Probablemente en alguna ocasión te hayas encontrado con la necesidad de mostrar un listado de los posts más vistos o más populares de tu sitio.…
Evitar la enumeración de usuarios en WordPress: bola extra
Hace unos meses escribí en dos entradas cómo evitar la enumeración de usuarios (parte 1 y parte 2). Ahora viene la bola extra: Evitar la enumeración…