Por Qué y Cómo Publicar un Plugin al Directorio de Plugins de WordPress

Por , Actualizado: agosto 11, 2017
Traducido por Peter Kovacs

directorio de plugins de wordpress

Con más de 50,000 plugins gratuitos, el directorio de plugins de WordPress es el centro comercial de la ciudad para cada usuario de WordPress, y donde encontrará plugins cubriendo todas las características y funcionalidades para su próximo sitio web. No obstante, es probable que no encuentre un plugin con las características exactas requeridas expresamente por el cliente. Nos guste o no, es posible que usted tenga que iniciar su editor de texto favorito y empezar a codificar. Pero, ¿alguna vez ha considerado la posibilidad de compartir sus plugins con toda la comunidad de WordPress?

El propósito principal de esta publicación es estudiar con ustedes los lectores las ventajas de la distribución de plugins a través del repositorio de WordPress.org. Voy a resumir rápidamente las recomendaciones y mejores prácticas que son recomendables a seguir, después le conduciré a través de los conceptos claves de SVN que usted debe saber cuando está planeando publicar un plugin al directorio de plugins de WordPress.

¿Por Qué el Directorio de Plugins de WordPress?

La primera razón para publicar el plugin al directorio de plugins de WordPress es tomar ventaja de un gran número de herramientas y servicios gratuitos, como la descripción del plugin, estadísticas, instalaciones activas, changelog, foro de soporte, y mucho más. Además, se notifica a los usuarios cuando una nueva versión está disponible y se puede ejecutar la actualización directamente desde la pantalla de plugins de WordPress. Los plugins de WordPress.org tienen mayor visibilidad en los motores de búsqueda, y usted puede explotar un poderoso medio para promover su identidad y mejorar su reputación como desarrollador.

Si no es un gran vendedor o no tiene el tiempo para comercializar, el directorio de plugins de WordPress puede ser una gran manera de conseguir tráfico gratuito y atraer más atención en su plugin.

El directorio de plugins de WordPress

Otra buena razón para publicar un plugin es contribuir a la comunidad de WordPress. WordPress es software gratis, con una enorme comunidad proporcionando toneladas de temas y plugins de forma gratuita. Publicar un plugin de WordPress es la mejor manera de dar las gracias a todas estas personas increíbles que regalan su trabajo de forma gratuita.

De Lo que Debería Preocuparse

Hay que tener en cuenta que una mayor visibilidad podría arruinar su reputación si los plugins están mal codificados, si no los actualizan regularmente, o si no se proporciona un apoyo rápido y eficaz (sin duda, si no actúa como un desarrollador de confianza). Aquí están algunos de los conceptos clave que apuntar.

Codificación

Hay mucho que decir acerca de la codificación, y encontrará un montón de lecturas útiles allá afuera. Pero si es un desarrollador de WordPress, el Codex es su Biblia, y usted debe leer las directrices del Plugin antes de comenzar la codificación. Aquí está mi lista personal de conceptos clave:

  • Mantenga el código legible por el ojo humano. Esto permite a otros desarrolladores a comprender qué hace su plugin, posiblemente para ayudarle a encontrar errores y a desarrollar sus propios plugins en su código. A fin de impulsar la colaboración entre desarrolladores, WordPress Codex establece los estándares de codificación de WordPress, que es una suma de las mejores prácticas para cualquier desarrollador de WordPress.
  • Siempre comente su código. La documentación en línea es un gran recurso que nunca se debe subestimar. Permite que cualquier persona pueda comprender rápidamente lo que hace una función, qué argumentos son aceptadas, que renta variable, etc. en los comentarios, puede agregar vínculos, versiones del script, y otras descripciones que pueden ser prácticas en cualquier momento que su script vaya a ser editado por usted o cualquier otra persona.
    Y me gustaría decir que la gente de WordPress son una comunidad de aprendizaje, y respetar las normas de documentación en línea es una gran manera para que la gente aprenda lo que usted ya sabe.
  • Prefiera las funciones de WordPress en lugar de las funciones de PHP cuando sea posible. Las funciones de WordPress le permiten generar código eficiente y seguro. Especialmente cuando usted necesita obtener datos de la base de datos, las funciones de la API le previenen que construya consultas complejas, que muy probablemente podrían ser menos seguras que las consultas incorporadas de WordPress. Hay un montón de desarrolladores detrás del núcleo, y están haciendo un trabajo fantástico que podemos aprovechar.

Características

Incluso si usted no consigue pago por su trabajo, usted debe considerar su plugins como productos para vender. Usted no necesita ser un especialista de marketing: sólo tiene que saber que el plugin debe ser de alguna manera único y/o distinguible de plugins similares. Dele a su plugin un nombre memorable y significativo, y características únicas que harán que la gente diga “¡Lo Necesito!”. Y, si el plugin proporciona características que ya están cubiertas por otros plugins, concéntrese en la accesibilidad y la facilidad de uso para dar a los usuarios un valor añadido haciendo una clara diferencia entre su producto y sus competidores.

Apoyo

Cada plugin distribuido a través del directorio de plugins tiene un foro específico donde los usuarios se pondrán en contacto con usted para que les ayude. Proporcione respuestas claras a las preguntas de los usuarios, y ayúdeles a solucionar sus problemas. Respuestas rápidas y adecuadas serán cruciales en la construcción de su reputación como desarrollador de confianza. Tome en cuenta cualquier tema, y tome cualquier pieza de información que podría ayudar a mejorar su plugin.

Actualizaciones

Actualice regularmente su plugin, empujando a los pequeños cambios cuando sea necesario, pero no más. Demasiadas actualizaciones pueden decepcionar a sus usuarios.

Licencias

WordPress es liberado bajo la Licencia Pública General de GNU V2 y la mayoría de los plugins son liberados bajo la misma licencia GPL. En realidad, no es estrictamente necesario liberar el plugin bajo la misma licencia, como cualquier licencia compatible es admitida. De todos modos, GPLv2 es recomendado (lea más acerca de licencia GPL).

A fin de proporcionar un ejemplo para esta publicación, el plugin que disecamos en 4 Hacks Prácticos de la Biblioteca Multimedia WordPress ha sido publicado en el directorio. Descargue el EXIF Viewer y abra sus archivos en el editor de texto y después, vuelva a esta publicación y a sumergirse en la estructura del plugin.

La Estructura Del Plugin

El plugin se almacenará en el repositorio SVN de WordPress.org. Nadie será capaz de ver una copia, sino que sólo el autor tendrá los privilegios para hacer el registro. Una vez que haya publicado un plugin, puede agregar nuevos archivos y editar o eliminar los archivos existentes en el equipo local y después, cargar los cambios en el servidor. Todos los cambios están marcados por la subversión, para que usted pueda volver a versiones antiguas o revisiones posteriores.
Los repositorios SVN proporcionan cuatro carpetas predeterminadas:

/assets/
/branches/
/tags/
/trunk/
  • Capturas de pantalla, los encabezados y los iconos van en Assets
  • Secciones divergentes del código van en Branches
  • Versiones del plugin se almacenarán en Tags
  • Trunk es el directorio donde se va a colocar los archivos de plugin

Cada plugin debe consistir siempre en al menos dos archivos: el archivo readme.txt y el principal script PHP. Opcionalmente, puede añadir una serie de imágenes (Assets) que se mostrarán en la página del plugin.

Los Activos del Plugin

Los Assets o activos son encabezados, iconos e imágenes de un plugin. Los encabezados de plugin son imágenes JPG o PNG que se pueden ver en la parte superior de la página del plugin. Los nombres de archivo dependen de la anchura y la altura de la imagen. Actualmente, el siguiente nombre/dimensiones son permitidos:

  • Regular: banner-772×250.(jpg|png)
  • Retina: banner-1544×500.(jpg|png)

Icons are squared images with the following names/dimensions:.

  • icon-128×128.(jpg|png)
  • icon-256×256.(jpg|png)
  • icon.svg

No se debe especificar las dimensiones de SVG en el nombre de archivo, estas imágenes se pueden escalar a cualquier tamaño. Si utiliza SVGs, debe proporcionar un icono PNG como respaldo.

Las capturas de pantalla son imágenes que aparecen en el contenido de la página del plugin. PNG y JPEG son formatos permitidos, y el nombre de archivo debe estar en minúsculas y respetar la siguiente estructura:

  • captura de pantalla-1.(jpg|png)
  • captura de pantalla-2.(jpg|png)

Para cada captura de pantalla se deberá proporcionar una descripción en el archivo readme. Todos estos gráficos deben ser añadidos a la carpeta de activos en su directorio local del plugin (más sobre cómo sus activos de plugin trabajan).

Activos atractivos y coherentes hacen una página bonita del plugin

El archivo Readme.txt

Usted debe proporcionar su plugin con un archivo readme.txt y encabezados apropiados en el script principal.
Primero, usted necesita un archivo readme.txt con la siguiente información:

  • Nombre del plugin
  • Colaboradores: (Una lista de ids de usuario de wordpress.org).
  • Enlace de donar: http://example.com/
  • Tags: (Plugin etiquetas)
  • Requiere al menos: (Versión de WordPress)
  • Probado hasta: (Versión de WordPress)
  • Etiqueta estable: (Versión plugin)
  • Licencia: GPLv2 o posterior (o compatible)
  • URI : https://www.gnu.org/licenses/gpl-2.0.html licencia
  • Descripción
  • Instalación
  • Capturas de pantalla
  • Changelog

La sección de capturas de pantalla permite agregar una descripción para cada imagen que desee incluir a la página del plugin. WordPress.org proporciona la plantilla estándar del archivo readme del plugin, que le ayudará a construir su archivo readme. Además, puede utilizar el Readme Validator para comprobar si su archivo es correcto.

El Readme Validator da notas y advertencias sobre los archivos readme

El comentario del encabezado del plugin

El comentario del encabezado indica a WordPress que un archivo es un plugin.
Si no va a publicar su plugin, el único campo obligatorio es el nombre del plugin. Por el contrario, si usted está planeando publicar el plugin, cuanto más información agrega, mejor. Aquí está una lista de campos disponibles:

  • Nombre del Plugin: (Requerido) el nombre del plugin debe ser único. Antes de publicar, busque en el directorio de plugins para plugins con el mismo nombre
  • Plugin URI: la página de inicio del plugin
  • Descripción: una descripción de plugin de una línea (menos de 140 caracteres)
  • Versión: la versión actual del plugin (debe ser mayor de la versión anterior)
  • Autor: uno o más nombres de autores, separados por comas.
  • Autor URI: la página principal del autor
  • Licencia: El slug de la licencia (por ejemplo GPL2)
  • URI licencia: el enlace al texto completo de la licencia (es decir, https://www.gnu.org/licenses/gpl-2.0.html)
  • Domino de Texto: el texto de dominio del plugin
  • La ruta de acceso del dominio: dónde encontrar los archivos de traducción (ver Cómo internacionalizar su plugin)

Aquí está el comentario de encabezado de uno de los más populares WordPress plugins:

<?php
/**
 * @package Akismet
 */
/*
Plugin Name: Akismet Anti-Spam
Plugin URI: https://akismet.com/
Description: Used by millions, Akismet is quite possibly the best way in the world to <strong>protect your blog from spam</strong>. It keeps your site protected even while you sleep. To get started: activate the Akismet plugin and then go to your Akismet Settings page to set up your API key.
Version: 3.3.2
Author: Automattic
Author URI: https://automattic.com/wordpress-plugins/
License: GPLv2 or later
Text Domain: akismet
*/

Publicar el Plugin al Directorio de Plugins de WordPress

Cuando esté listo, haga un registro y envíe su plugin.

La primera versión del plugin debe ser cargada para una revisión manual

El plugin será revisado manualmente por el personal de WordPress.org. Este proceso puede tardar entre uno y diez días. Si se detectan problemas, usted recibirá un correo electrónico explicando cuál es el problema y qué debe hacer para corregir los errores.

El proceso de revisión puede tardar hasta diez días

Una vez que el plugin haya sido aprobado, recibirá un correo electrónico que le permite saber si tiene acceso al repositorio SVN.

El correo le informará de que su plugin ha sido aprobado

En este momento, el plugin no está disponible para descargarse, pero puede cargar, editar y eliminar archivos mediante la línea de comandos (o cualquier cliente SVN). La siguiente imagen muestra la página de plugin actual.

El correo le informará de que su plugin ha sido aprobado

En este momento, el plugin no está disponible para descargarse, pero puede cargar, editar y eliminar archivos mediante la línea de comandos (o cualquier cliente SVN). La siguiente imagen muestra la página de plugin actual.

La página de plugin está activa, pero el plugin no está disponible para descargarse

Cargar el Plugin

Nuestra primera tarea consiste en cargar los archivos de plugins en el repositorio SVN, pero primero necesitamos una carpeta local donde almacenaremos los archivos de plugin:

$ mkdir localdir

Ahora podemos ver el repositorio pre-construido:

$ svn co https://plugins.svn.wordpress.org/plugin-name path/to/localdir

Obtendremos la siguiente respuesta:

> A    plugin-name/branches
> A    plugin-name/tags
> A    plugin-name/trunk
> Checked out revision 99999999.

A significa que las carpetas se han agregado desde el repositorio central a la carpeta local.
El siguiente paso es añadir los archivos a la carpeta /trunk local y subirlos al repositorio:

localdir/$ svn add trunk/*

Se le pedirá que se autentique. Una vez registrado, recibirá la siguiente respuesta:

> A    trunk/my-plugin.php
> A    trunk/readme.txt

Nota: no coloque el principal archivo de plugins en una subcarpeta de trunk, porque esto romperá las descargas.

Ahora, verifique en los cambios en el repositorio:

localdir/$ svn ci -m 'First plugin version'

Y aquí está la respuesta final:

> Adding trunk/my-plugin.php
> Adding trunk/readme.txt
> Transmitting file data .
> Committed revision 9999999.
La estructura del archivo de la copia local del EXIF Viewer

Después, tenemos que añadir los activos del plugin:

localdir/$ svn add assets/*

Después, checar los cambios de nuevo:

localdir/$ svn ci -m 'Assets upload'

¡Y eso es todo! Vaya a la página del plugin y comience a promocionar su trabajo!

La última página del plugin de EXIF Viewer

Publicar una nueva versión

Antes de publicar la próxima versión, recuerde que debe actualizar la Etiqueta campo estable en trunk/readme.txt y el número de versión en el comentario del encabezado del plugin. Cuando la nueva versión esté lista para publicarse, copie los archivos en una subcarpeta de/tags y establezca el nombre de la subcarpeta con el número de versión (es decir, 1.0.1):

localdir/$ svn cp trunk tags/1.0.1
> A tags/1.0.1

A continuación, registre los cambios:

localdir/$ svn ci -m "tagging version 1.0.1"
> Adding         tags/1.0.1
> Adding         tags/1.0.1/my-plugin.php
> Adding         tags/1.0.1/readme.txt
> Committed revision 999999.

¡Y eso es todo! La nueva versión está online.

Editar un Archivo

Ocasionalmente, es posible que necesite hacer cambios menores que no requieran una nueva versión. En primer lugar, actualice la copia local del repositorio:

localdir/$ svn up
> At revision 999999.

A continuación, edite los archivos y compruebe los cambios:

localdir$ svn stat
> M       trunk/readme.txt

M significa que los archivos han sido modificados.
Después, usted puede ver lo que ha cambiado entre las dos versiones:

localdir$ svn diff

Por último, verifique los cambios al repositorio central:

localdir$ svn ci -m "minor changes"
> Sending trunk/readme.txt
> Transmitting file data .
> Committed revision 999999.

Finalizando

Si usted decide publicar una versión comercial de un plugin, o publicar el plugin para contribuir a la comunidad, el Directorio WordPress.org es el mejor lugar para distribuir su trabajo. Le da una amplia exposición y proporciona una serie de herramientas profesionales para distribuir y promocionar sus plugins.

Por lo tanto, ¿alguna vez ha considerado esta oportunidad? Comparta su experiencia con nosotros a continuación.