Cómo subir un plugin propio a WordPress (1/5)

Hoy empezamos una serie de cinco entradas en el blog sobre como subir un plugin propio a WordPress. Algo que parece sencillo a priori, pero que tiene bastantes puntos a tener en cuenta, que si no se conocen, puede convertirse en una pesadilla.

Al finalizar esta semana, publicaremos toda esta información en formato guía PDF para que podáis descargarla directamente.

 

Hemos desarrollado ya varios plugins y es muy interesante subirlos al repositorio de plugins de WordPress, ya que allí van a tener mucha visibilidad y sobre todo van a estar disponibles a través de las búsquedas de plugins dentro de las instalaciones de WordPress. OJO: Solo se pueden subir plugins gratuitos, pero esto se puede solucionar fácilmente subiendo una versión gratuita con funcionalidades reducidas y vendiendo el plugin con todas las funcionalidades en una web externa a WordPress.

 

¿Qué hay que tener en cuenta a la hora de crear un plugin de WordPress?

No vamos a entrar en la programación del plugin en si, sino en todo lo relacionado con subir y promocionar este plugin en WordPress. O sea, que una vez que hayamos comprobado en instalaciones propias y subiendo el plugin a mano que funciona correctamente, aquí vamos a ver el siguiente paso que es el de hacer accesible el plugin a todo el mundo a través del repositorio de plugins de WordPress.

El archivo readme.txt

Lo más importante es el archivo readme.txt, que será la base para la información del plugin en la página de plugins de WordPress. WordPress lee el contenido de ese archivo y crea la información sobre el plugin a partir de su contenido. Por esta razón este archivo debe seguir la estructura estándar que marca WordPress, que se puede encontrar aquí y comprobar aquí.

Dentro del archivo readme.txt, lo más importante es:

• El nombre del plugin «Plugin Name» (que luego será la base para la carpeta de repositorio de plugins de WordPress).
• Los que han contribuido al plugin «Contributors» (los nombres de usuarios de WordPress que han contribuido al plugin y que aparecen enlazados en el plugin).
• Las etiquetas «tags» (las etiquetas dentro de las cuales va a aparecer el plugin de WordPress en las búsquedas).
• Y la descripción breve del plugin «short description of the plugin» (menos de 150 caracteres).

 

¿Cómo le pongo el nombre a mi plugin?

Para el nombre del plugin recomendamos hacer una búsqueda dentro de los plugins de WordPress por el nombre que queramos ponerle, para ver que aparece.

Otra comprobación interesante es ir al repositorio de plugins de WordPress en Subversion y mirar el nombre de las carpetas (nombre de la carpeta = nombre del plugin) para ver que hay disponible y como nos interesa llamar a nuestro plugin. Esto también haya que tenerlo en cuenta porque nos va a afectar al marketing que podamos hacer del plugin

En el nombre del plugin hay que incluir las palabras clave por las cuales queremos que el plugin esté posicionado y luego nos puedan encontrar.

 

Las imágenes de encabezado de los plugins

Desde hace algún tiempo, a los plugins se les puede añadir una imagen de cabecera, que después aparece dentro del repositorio de plugins de WordPress y llama mucho la atención a las personas que realizan una búsqueda y llegan a la página de información del plugin.

Estas imágenes tienen un tamaño de 772×250 píxeles (tamaño normal) y 1544×500 píxeles (tamaño pantallas retina). Solo se permiten imágenes JPG y PNG, que tienen que seguir la siguiente nomenclatura de nombres: «banner-772×250.png» o «banner-772×250.jpg» para los tamaños normales y «banner-1544×500.png» o «banner-1544×500.jpg» para los tamaños retina.

OJO: Una vez que hayamos subido el plugin a WordPress, estas imágenes hay que subirlas a una carpeta llamada ASSETS que tenemos que crear a mano en el repositorio.

Es importante que tengamos en cuenta que una vez subidos los banners, no aparecen enseguida en la página del plugin, sino que puede tardar varios minutos en ser procesado.

 

¿Dónde ponemos los pantallazos («Screenshots»)?

Antes de septiembre 2012 los pantallazos de ejemplo de los plugins se incluían dentro del directorio raíz del plugin y al instalar el plugin en distintos WordPress, automáticamente se bajaban también los pantallazos (lo cual no tenía mucho sentido y usaba ancho de banda).

En septiembre de 2012 se introdujeron las imágenes de encabezado en alta resolución y de paso se permitió incluir los pantallazos en la carpeta ASSETS, que WordPress si que lee para mostrar la información sobre el plugin en la página web, pero que no se descargan cada vez que alguien instala un plugin.

Si hay pantallazos en la carpeta ASSETS, estos prevalecen sobre los pantallazos que pueda haber en la carpeta principal del plugin.

Por esta razón recomendamos subir los pantallazos a la carpeta ASSETS.

OJO: Los pantallazos son redimensionados a un ancho de 530 píxeles cuando se muestran en la web de WordPress.

 

¿De dónde obtiene WordPress los datos que muestra en la página de información del plugin dentro de WordPress.org?

• Descripción breve del plugin que se muestra sobreimpresa sobre la imagen del encabezado: Viene del encabezado del plugin y hay que vigilar que su extensión no sea superior a 150 caracteres (y debería ser igual que la descripción del archivo readme.txt, aunque ese lo ignore).
• Autores: Vienen del campo AUTHORS del encabezado del plugin y del campo CONTRIBUTORS del archivo readme.txt.
• Versión: Viene del campo VERSION del encabezado del plugin.
• Etiquetas: Viene del campo TAGS del archivo readme.txt.
• Nombre del plugin: Viene del archivo readme.txt y si no está disponible lo coge del encabezado del plugin.
• Páginas web del autor y del plugin: Viene del encabezado del plugin.
• Última vez que se actualizó: Momento en el cual se subió la última versión después de un cambio de número de versión al repositorio (/trunk).
• Creación: Momento en el que se subió la primera versión del plugin.

 

¿Cómo le pongo los números de versiones a un plugin de WordPress?

Las versiones del plugin deberían contener números y puntos separando los mismos. Por ejemplo: 2.8.4

WordPress y Subversion ordenan automáticamente las versiones y por eso es importante seguir una nomenclatura consistente y siempre ascendente.

 

¿Te ha parecido interesante? Mañana publicaremos la segunda parte: «SEO en WordPress.org o cómo hacer que encuentren nuestro plugin (2/5)«.

 

Si quieres descargarte una guía en PDF con las cinco entradas del blog sobre «Cómo subir un plugin a WordPress», la hemos compartido en la entrada:

«Cómo subir un plugin a WordPress: Resumen y PDF«.

Si te ha gustado, por favor regálanos un +1, un ME GUSTA o un Tweet. Gracias.