Escribir un complemento simple de WordPress, Tutorial para principiantes

En lenguaje sencillo, un complemento de WordPress es un programa simple que te ayuda a personalizar y mejorar tu sitio web de WordPress sin tener que editar la programación principal. Cuando dominas Desarrollo de plugins de WordPress, podrá agregar todo tipo de funcionalidades a su blog de WordPress en muy poco tiempo. Pero antes de convertirte en un profesional, debes aprender las cuerdas.


Un complemento de WordPress es un programa, o un conjunto de una o más funciones, escritas en el lenguaje de script PHP, que agrega un conjunto específico de características o servicios al blog de WordPress, que puede integrarse perfectamente con el blog usando puntos de acceso y métodos proporcionado por la interfaz de programa de aplicación (API) del complemento de WordPress. – Escribir un complemento, WordPress Codex

En la publicación de hoy, lo guiaremos a través del proceso de creación de su primer complemento de WordPress. Mantendremos el tutorial simple para atender al desarrollador por primera vez que tiene poco o ningún conocimiento de PHP (el lenguaje de script detrás de WordPress).

Sin embargo, antes de pasar a la codificación real, veremos algunas cosas que debe comprender sobre el desarrollo de plugins de WordPress.

Conceptos básicos para saber antes de crear un complemento de WordPress

En esta sección, revelaremos el primeros pasos debe seguir al crear un complemento de WordPress. Además, mencionaremos todas las diversas cosas que debe tener en cuenta al escribir su complemento. Excelente. Empecemos con lo básico.

Cómo nombrar un complemento de WordPress

Antes que todo lo demás, debe encontrar un nombre único para su complemento de WordPress. Una de las mejores formas de determinar un nombre favorable es pensar en lo que hará su complemento. Entonces, por ejemplo, si su complemento ayudará a las personas a compartir contenido a través de las redes sociales, puede incluir la frase “compartir en redes sociales” en el nombre. Otra cosa, los nombres de complementos pueden ser varias palabras, así que no pierdas la creatividad.

El nombre de su complemento debe ser único para evitar conflictos con otros complementos. Para asegurarse de que su nombre sea único, puede hacer una búsqueda en Google del nombre. Además, puede buscar en varios directorios de complementos, incluido el Repositorio de plugins de WordPress.

Para nombrar cualquier complemento, tenemos que crear al menos un archivo de complemento (el archivo PHP principal), que nos introduce en nuestra siguiente sección.

Cómo crear archivos de complemento

Un complemento puede estar compuesto por un solo archivo PHP o varios archivos, según lo que esté diseñado para hacer. El archivo más importante es el principal. Archivo PHP, que es el equivalente de index.php e index.html en temas de WordPress y diseños HTML respectivamente.

Se recomienda que los desarrolladores de WordPress nombren su archivo de complemento principal después de su complemento por convención. Por ejemplo, el archivo de complemento principal para un complemento llamado plugin WP Renym sería wp-renym.php. Si agrega un separador en su nombre, use solo guiones (-) entre palabras en lugar de guiones bajos (_).

Como se mencionó anteriormente, un complemento puede estar hecho de uno o varios archivos (imágenes, JavaScript, idioma, archivos CSS, etc.). De cualquier manera, sus archivos de complemento deben vivir en un solo directorio. Entonces, para un plugin llamado WP Renym, el wp-renym.php el archivo se colocaría en un wp-renym carpeta. Se pueden agregar subcarpetas adicionales dentro de la carpeta del complemento principal para contener y organizar otros archivos.

Después de colocar todo el código para un complemento, comprime su carpeta principal en un archivo zip (en este caso sería el archivo wp-renym.zip) para cargar e instalar en un sitio de WordPress.

Agregar un encabezado de archivo al archivo PHP principal

Al nombrar su complemento, debe agregar otros detalles, como descripción, versión, licencia, nombre del autor, básicamente todo lo que aparecerá debajo y junto a su complemento en el Pantalla de complementos de WordPress – El encabezado del complemento. Para esto debes usar un encabezado de información de complemento estándar en la parte superior de su archivo PHP principal. Así es como se ve un encabezado típico:


/ *
Nombre del complemento: nombre de su complemento
URI del complemento: http: // enlace a la página de inicio de su complemento
Descripción: describe de qué se trata tu complemento en unas pocas oraciones cortas
Versión: 1.0
Autor: Tu nombre (¡Yay! Aquí viene la fama ...)
Autor URI: http: // enlace a su sitio web
Licencia: GPL2, etc.
Licencia URI: http: // enlace a su licencia de complemento
* /

Cada parámetro en el encabezado anterior se explica por sí mismo, por lo que no entraré en detalles. Solo asegúrese de incluir lo relevante http: // o https: // al escribir sus URI de plugin y autor o los enlaces no funcionarán.

Siga su encabezado con la siguiente información de licencia si va a utilizar un Licencia GPL2 o una licencia compatible con la GPL2:

/ * Copyright YEAR PLUGIN_AUTHOR_NAME (correo electrónico: su dirección de correo electrónico)
(Nombre del complemento) es un software gratuito: puede redistribuirlo y / o modificarlo
bajo los términos de la Licencia Pública General GNU publicada por
Free Software Foundation, ya sea la versión 2 de la Licencia, o
cualquier versión posterior.

(Nombre del complemento) se distribuye con la esperanza de que sea útil,
pero SIN NINGUNA GARANTÍA; sin siquiera la garantía implícita de
COMERCIABILIDAD o APTITUD PARA UN PROPÓSITO EN PARTICULAR. Ver el
Licencia pública general de GNU para más detalles.

Debería haber recibido una copia de la Licencia Pública General de GNU
junto con (Nombre del complemento). Si no, vea (http: // enlace a su licencia de complemento).
* /

El alcance de este tutorial no nos permite ir más allá de estos pasos básicos. Tendrá que revisar el escribir un complemento guía en el códice para obtener más información sobre los ganchos de complementos de WordPress, etiquetas de plantillas, guardar datos de complementos en bases de datos, mecanismo de opciones de complementos y actualizar su complemento, entre otras cosas. El códice también incluye un masivo Recursos de complementos colección que está llena de guías de video, temas avanzados y más.

Ahora que hemos cubierto los conceptos básicos, vamos a escribir un simple complemento de WordPress que realizará dos funciones básicas (pero ingeniosas):

  • Reemplace las palabras en su contenido con su propia elección de palabras
  • Agregue una nota de “Gracias por leer este tutorial …” al final de cada publicación de blog.

Cómo escribir un complemento simple de WordPress – WP Renym

En esta sección, escribiremos código para el complemento WP Renym que he estado mencionando todo el tiempo.

Que necesitas:

Nombrando nuestro complemento

Primero, verificamos el repositorio de plugins de WordPress e hicimos una búsqueda en Google de nuestro nombre; WP Renym estaba libre. Mi elección inicial fue WP Rename pero ya estaba tomada.

Continuando … Abra un nuevo archivo en su editor de código y agregue el siguiente código en la parte superior después de abrir su complemento con :

/ *
Nombre del complemento: WP Renym
URI del complemento: http: // enlace a la página de inicio de su complemento
Descripción: este complemento reemplaza las palabras con su propia elección de palabras.
Versión: 1.0
Autor: Freddy Muriuki
Autor URI: http: // enlace a su sitio web
Licencia: GPL2, etc.
URI de licencia: https: // enlace a su licencia de complemento

Copyright YEAR PLUGIN_AUTHOR_NAME (correo electrónico: su dirección de correo electrónico)
(Nombre del complemento) es un software gratuito: puede redistribuirlo y / o modificarlo
bajo los términos de la Licencia Pública General GNU publicada por
Free Software Foundation, ya sea la versión 2 de la Licencia, o
cualquier versión posterior.

(Nombre del complemento) se distribuye con la esperanza de que sea útil,
pero SIN NINGUNA GARANTÍA; sin siquiera la garantía implícita de
COMERCIABILIDAD o APTITUD PARA UN PROPÓSITO EN PARTICULAR. Ver el
Licencia pública general de GNU para más detalles.

Debería haber recibido una copia de la Licencia Pública General de GNU
junto con (Nombre del complemento). Si no, vea (http: // enlace a su licencia de complemento).
* /

Guarda el archivo como wp-renym.php en la carpeta wp-renym. Si aún no tiene la carpeta, créela. wp-renym.php será tu archivo PHP principal.

Agregar funciones

Ahora para agregar las funciones reales al complemento. Justo debajo del código anterior, agregue la siguiente función para corregir errores ortográficos de wordpress a WordPress:

función renym_wordpress_typo_fix ($ texto) {
return str_replace ('wordpress', 'WordPress', $ texto);
}
add_filter ('the_content', 'renym_wordpress_typo_fix');

renym_wordpress_typo_fix es el nombre único que le hemos dado a nuestra función. Cuando agregue nuevas funciones, nunca las comience con wp_ – esto para evitar futuras incompatibilidades con las funciones de código de WordPress que usan el prefijo wp_.

Nuestra función PHP toma ($ text) como argumento y devuelve la primera cadena “wordpress” reemplazada por la segunda cadena “WordPress”.

Hemos agregado un filtro (add_filter) a nuestro complemento para indicar nuestra función ( renym_wordpress_typo_fix ) para trabajar en el texto que hemos seleccionado, que en este caso es todo el contenido de la publicación (el_contenido).

Para reemplazar más de una palabra (quizás le gustaría editar varias palabras en su blog o usar el complemento como un simple filtro de malas palabras), reemplace el código anterior con el siguiente código:

función renym_content_replace ($ contenido) {
$ search = array ('wordpress', 'cabra', 'Pascua', '70', 'sensacional');
$ replace = array ('WordPress', 'café', 'vacaciones de Pascua', 'setenta', 'extraordinario');
return str_replace ($ búsqueda, $ reemplazar, $ contenido);
}
add_filter ('the_content', 'renym_content_replace');

En nuestro código anterior, ya hemos seleccionado las palabras para reemplazar, p. WordPress, cabra, Pascua, etc. También hemos seleccionado las palabras de reemplazo, p. WordPress, café, vacaciones de Pascua, etc. Con suerte, el código se explica por sí mismo:

  • los renym_content_replace La función toma ($ contenido) como argumento, reemplaza todas las palabras contenidas en la matriz $ search y devuelve las palabras ahora modificadas a WordPress.
  • $ search contiene todas las palabras que se reemplazarán
  • $ replace contiene las palabras de reemplazo
  • str_replace hace lo que hace mejor, reemplazando palabras con las nuevas palabras

Tenga en cuenta cómo agregamos el prefijo renym a cada función Esto evita conflictos con otros complementos que puedan instalarse. Debes acostumbrarte a agregar prefijos a tus funciones, ya sea que estés desarrollando complementos, temas o widgets.

Si ha completado los pasos anteriores, su complemento puede reemplazar todas las palabras seleccionadas de manera efectiva. Ahora agreguemos la nota “Gracias por leer este tutorial …” que aparecerá en la parte inferior de cada publicación. Agregue el siguiente código a su archivo de complemento principal ( renym_content_replace ) antes del cierre del corchete PHP ( ?> ) Que viene en la última línea:

function renym_content_footer_note ($ contenido) {
$ content. = '
Gracias por leer este tutorial. ¡Quizás la próxima vez te deje comprarme un café! Para más tutoriales de WordPress visite nuestro Blog
'; devolver $ contenido; } add_filter ('the_content', 'renym_content_footer_note');

Guarda los cambios. los renym_content_footer_note La función agrega el marcado HTML al parámetro $ content y devuelve el nuevo valor a WordPress. También hemos agregado una clase de pie de página a nuestro texto para que se pueda diseñar fácilmente más adelante.

Hemos incluido un filtro (add_filter) que le dice a nuestra función que opere en el texto que hemos seleccionado, que es el contenido de la publicación representado por the_content.

Comprime tu carpeta

En este punto, tu final wp-renym.php el archivo debería verse así:

Gracias por leer este tutorial. ¡Quizás la próxima vez te deje comprarme un café! Para más tutoriales de WordPress visite nuestro Blog';
devolver $ contenido;
}
add_filter ('the_content', 'renym_content_footer_note');

?>

Guarda todos tus cambios. Comprima la carpeta WP Renym en un wp-renym.zip archivo (en una Mac es tan fácil como hacer clic derecho, comprimir archivo, y en PC creo que es muy similar). Solo asegúrese de que su archivo se guarde como una extensión .ZIP o el complemento no se instalará.

Use su complemento

Cargue y active su nuevo complemento WP Renym a través de Pantalla de complementos de WordPress. Felicidades por escribir su primer complemento!

Instale el complemento Renym WordPress

Recursos

Para obtener más información sobre el desarrollo del complemento de WordPress, consulte los siguientes recursos:

Conclusión

Espero que este tutorial te haya dirigido en la dirección correcta en lo que respecta a comprender los complementos. Esta publicación debe servir como un trampolín para desarrollar complementos complejos de WordPress que hagan lo que sea que haga. No se detenga aquí, consulte los recursos que recomendé anteriormente para aumentar su conocimiento del desarrollo de plugins de WordPress.

Si este tutorial le resultó útil o si tiene algo más que agregar, nos encantaría saberlo. Por favor comparte tus pensamientos en la sección de comentarios. Nos vemos ��

Jeffrey Wilson Administrator
Sorry! The Author has not filled his profile.
follow me
    Like this post? Please share to your friends:
    Adblock
    detector
    map