Cómo añadir un plugin a WordPress

Share on facebook
Facebook
Share on twitter
Twitter
Share on linkedin
LinkedIn
Añadir plugin para WordPress

Mucha gente se plantea añadir su propio plugin al directorio de plugins de WordPress pero terminan rechazando esa idea por la falta de documentación sobre como conseguirlo. En este post te vamos a enseñar como puedes subir tu propio plugin a WordPress y que nada te impida compartir tu creación con la comunidad. Obviamente, si eres un desarrollador de plugins con cierta experiencia, ya sabrás como subirlo al directorio de WordPress, pero para aquellos que no saben como, en este tutorial les mostraré todo lo que necesitan saber.

Pero si no te aclaras, lo mejor es ponerse en mano de desarrolladores profesionales para que realicen está tarea por ti.

Pasos a seguir para crear y subir el plugin

  • Escribir y preparar el plugin.
  • Preparar el archivo readme.txt.
  • Registrarnos al repositorio de Subversion.
  • Esperar la aprobación y la información de acceso SVN.
  • Usar Subversion para subir los archivos de nuestro plugin.
  • Esperar unos pocos minutos para que el sistema añada el plugin al directorio de WordPress.

La parte más complicada o liosa es la de usar SVN/Subversion. Pero una vez que aprendas y veas lo sencillo que es, no dudarás en subir todos tus plugins.

Primeros pasos

Primero tienes que escribir el código del plugin y tenerlo completamente listo y revisado.

Junto a todos los archivos del plugin tendrás que añadir uno que se llame readme.txt. Este es un archivo requerido para poder subir el plugin.

Rellenar el archivo readme.txt

Tener listo y bien preparado el archivo readme.txt es una de las cosas más importantes a la hora de subir un plugin y ayuda mucho a que el primer plugin que subamos nos cueste mucho menos. El archivo se usa para que WordPress pueda leer los datos del plugin y pueda mostrarlos después. Se escribe como una lista:

  • Nombre del plugin
  • Descripción
  • Instalación
  • FaQ
  • Capturas de pantalla
  • Otras notas
  • Lista de cambios
  • Estadísticas
  • Admin

Esto es básicamente lo que contiene dicho archivo. Si el tuyo contiene estas secciones, ya deberías estar listo. Hay varios detalles requeridos en ciertas secciones como, por ejemplo, la información en la zona del Plugin Name. Para que no sea demasiado complicado aquí voy a dejar una plantilla de como sería el archivo readme.txt. Simplemente tendréis que copiarlo en un archivo .txt en blanco y rellenarlo con los datos de vuestro plugin.

=== Plugin Name ===

Contributors:      (Nombre de los contribuidores)

Plugin Name:       (Nombre del plugin)

Plugin URI:        (Página web para el plugin)

Tags:              (Etiquetas para el plugin)

Author URI:        (Sitio del autor del plugin)

Author:            (Autor del plugin)

Donate link:       (Link para recibir donaciones)

Requires at least: (Versión mínima de WordPress requerida)

Tested up to:      (Versión hasta la que se ha probado el plugin)

Stable tag:        (Versión estable del plugin)

Version:           (Versión actual del plugin)

== Description ==

== Installation ==

== Upgrade Notice ==

== Screenshots ==

== Changelog ==

== Frequently Asked Questions ==

== Donations ==

Todo deberá ir en inglés ya que es el idioma estandarizado. La parte de Plugin Name deberá ir la primera, ya que contiene todos los datos básicos del plugin. Por otra parte, el resto de secciones se pueden colocar en el orden preferido, pero todas deben de estar presentes.

Aquí dejo el enlace a un validador de WordPress donde podréis validar vuestro readme.txt para comprobar que está correctamente.

A continuación os pongo una serie de trucos y consejos que he encontrado útiles a la hora de redactar el archivo readme.txt:

  • Puedes incluir PHP (para ello tienes que escaparlo con “ ` ”: `<?php . . . ?>`).
  • Usa asteriscos para enfatizar texto (* texto *).
  • Usa asteriscos dobles para usar negrita en el texto (** texto **).

Preparar el archivo del plugin

Crear plugin para WordPress

Después de crear y probar el plugin necesitarás darle una licencia. Para ello, el WordPress Codex dice que:

  • El plugin debe de ser GPLv2 Compatible.
  • El plugin no debe hacer nada ilegal o moralmente ofensivo.
  • Tienes que utilizar el repositorio de Subversion que te dan para que el plugin se muestre en la página. El directorio de plugins de WordPress es un sitio de hosting y no de listado.
  • El plugin no debe tener enlaces externos en el lado público de la página (como un enlace de “patrocinado por”) sin el consentimiento expreso del usuario.
  • Si no se especifica una licencia v2-compatible, la licencia será explícitamente GPLv2.

Una vez que le has dado la correspondiente licencia al plugin – de forma explícita incluyendo la licencia o de forma implícita sin incluir ninguna licencia – estas listo para alojarte en el Repositorio de WordPress.

Registrarse para acceder al Repositorio de plugins

Ahora que tenemos listos todos los archivos del plugin, podemos ir a la Página de registro, acceder con nuestra cuenta o registrarnos si no tenemos ninguna y rellenar el formulario con la siguiente información:

  • Nombre del plugin (Obligatorio).
  • Descripción del plugin (Obligatorio).
  • URL del plugin.

Después de enviar el formulario, espera para que te aprueben el acceso al repositorio de Subversion. Tienes que ser paciente, puede tardar unas 24 horas aunque suele estar listo en menos tiempo. Si todo está correctamente, alguien aprobará tu petición. Cuando esto ocurra recibirás un email con los datos de acceso al repositorio de Subversion. Aquí es donde subirás y almacenarás el plugin. El sistema usará los archivos y la información incluida en el repositorio Subversion para generar las páginas web que aparecerán en el directorio de plugins junto con todos los plugins. Esto suele tardar unos minutos para que el sistema cree la entrada del plugin.

Uso de Subversion para subir los archivos del plugin

En este punto, se te ha garantizado acceso al repositorio SVN y estás listo para subir tus archivos.

Subversion es un software de código abierto que la gente usa para el manejo de archivos y directorios y sus versiones. Subversion permite restaurar versiones anteriores de los datos y ver los cambios. Es similar a otros programas de control de versiones como Git.

Hay 2 conjuntos de archivos con los que trabajaremos: archivos locales (en tu equipo) y archivos remotos (en el servidor). Para cada tipo de archivos queremos la siguiente estructura de directorios:

root-folder/

       /trunk/

               plugin.php

               readme.txt

       /branches/

       /tags/

Para empezar, colocamos nuestros archivos en / trunk / y en el futuro añadiremos nuevas versiones de este en / branches / para grandes actualizaciones y en / tags/ para actualizaciones pequeñas.

Una vez subido, tus archivos estarán almacenados en el repositorio central de plugins en los servidores de WordPress. Desde el repositorio cualquiera puede ver o copiar tus archivos, pero solo tú tienes los permisos para subir nuevos archivos. Con Subversion cualquier cambio realizado en el archivo local será subido automáticamente al archivo remoto del directorio de plugins y actualizado.

Añadir el plugin al repositorio

Añadir plugin al repositorio de WordPress

Ahora que tenemos nuestros archivos listos abriremos una terminal y los subiremos al repositorio. Lo que vamos a hacer se puede resumir en 3 sencillos pasos:

  • Verificar que la estructura de repositorios está vacía.
  • Agregar el archivo a / trunk/ en nuestro equipo.
  • Actualizar el repositorio con copias de nuestros archivos locales.

Estos serían los comandos que vamos a utilizar:

# Crear una carpeta local para copiar el repositorio

$ mkdir my-local-dir

# Descargar el directorio a la nueva carpeta

$ svn co http://svn.wp-plugins.org/your-plugin-name my-local-dir

> A     my-local-dir/trunk

> A     my-local-dir/branches

> A     my-local-dir/tags

> Checked out revision 11325.

# Copiar los archivos del plugin al directorio

$ cd my-local-dir/

my-local-dir/$ cp ~/my-plugin.php trunk/my-plugin.php

my-local-dir/$ cp ~/readme.txt trunk/readme.txt

# Registrar los nuevos archivos con Subversion

my-local-dir/$ svn add trunk/*

> A     trunk/my-plugin.php

> A     trunk/readme.txt

# Actualizar el repositorio con los archivos nuevos

my-local-dir/$ svn ci -m ‘añade algún comentario aquí’

> Adding        trunk/my-plugin.php

> Adding        trunk/readme.txt

> Transmitting file data ..

> Committed revision 11326.

# Todo hecho!

Puede parecer demasiado pero ciertamente son solo 7 comandos los que hay que usar, menos incluso si creas la estructura de directorios manualmente. También debes tener en cuenta lo siguiente si eres nuevo usando comandos:

  • Cualquier línea que empiece por # es un comentario y no se debe usar como comando.
  • Las líneas que empiezan por > significan una respuesta del software y tampoco se usan como comando.
  • Todos los nombres de directorios y archivos tienen que ser cambiados para concordar con los del plugin.
  • La parte -m ‘añade algún comentario aquí’ en la última línea de comandos se usa para añadir notas al evento -puedes poner la nota que quieras.
  • En el último paso se te preguntará por un usuario y una contraseña. Estos tienen que ser los mismos con los que te has registrado en WordPress.

Después de usar estos comandos el plugin será añadido al repositorio y estará listo para que el sistema cree automáticamente las páginas del plugin en el directorio de plugins de WordPress.

Esto suele tardar un poco, como unos 5 o 10 minutos. Pasado un tiempo verás aparecer tu plugin en la zona de Nuevos Plugins y en su página propia que sería algo como:

http://wordpress.org/extend/plugins/tu-nuevo-plugin/

Una vez puedas ver el plugin ya habrás terminado todo y cualquiera podrá usarlo. Ya solo te queda ir mejorando poco a poco el plugin y añadiendo nuevas funciones o crear nuevos plugins para poder subirlos.

Más...

Portada SmartMaterials3d

Tienda online y Blog SmartMaterials3d

En garberinformática hemos creado la nueva versión de la tienda online SmartMaterials3d. SmartMaterials3d es uno de los principales fabricantes nacionales de filamentos

Más...

Portada SmartMaterials3d

Tienda online y Blog SmartMaterials3d

En garberinformática hemos creado la nueva versión de la tienda online SmartMaterials3d. SmartMaterials3d es uno de los principales fabricantes nacionales de filamentos

Deja un comentario