Desarrollo de plugins. Consideraciones previas. La cabecera del plugin. Francisco Javier Cervigon Ruckauer

Desarrollo de plugins

Consideraciones previas

  • Nombre del plugin: Cuando creamos un plugin debemos elegir un nombre que explique su función pero que no tenga ya otro plugin de los disponibles en el repositorio oficial. De lo contrario WordPress pensará que estamos usando ese otro plugin.
  • Prefijar código: Igual que sucede con el nombre del plugin, es conveniente distinguir nuestras variables y funciones del resto de las que pueda tener una instalación de WordPress. La mejor manera de conseguirlo añadir un prefijo a nuestras funciones a todo nuestro código, desde los archivos a las funciones y variables para evitar posibles colisiones con otros que coincidan en el nombre.
  • Estructura clara: Aunque un plugin puede contar de un único archivo, lo normal es que el plugin se estructure en una carpeta que contenga a su vez otras con los diferentes archivos (.php, .css, .js, imágenes...).
  • Licencia: Wordpress se distribuye bajo una licencia GNU GPL y todo plugin desarrollado para él debe tener esta licencia u otra que sea compatible con ella. Aunque no es obligatorio, si es conveniente incluir en nuestro plugin un archivo llamado license.php con toda la información del tipo de licencia.

La cabecera del plugin

El archivo principal de cualquier plugin debe tener un aspecto similar a este:

Veamos la información contenida en este bloque de comentario:
  • Nombre del plugin. Es el único de los datos que es obligatorio, aunque es conveniente incluirlos todos para aportar la máxima información posible sobre el plugin a los usuarios.
  • URI con más información sobre el plugin.
  • Breve descripción del plugin
  • Versión del plugin
  • Nombre del desarrollador o empresa
  • Página del desarrollador o empresa
  • Licencia y URI con sus términos
  • Nombre y ruta del dominio. Se usará para traducir las cadenas de texto de nuestro plugin a otros idiomas.
Francisco Javier Cervigon Ruckauer

No hay comentarios:

Publicar un comentario