WordPress Hooks – Guía para principiantes

Te han encargado cambiar cierta funcionalidad de WordPress y no tienes ni idea de por dónde empezar. ¡Menudo marrón! Te has descargado el código fuente y encuentras un montón de archivos en PHP. Y tu primera intención como programador es encontrar dónde tienes que empezar a meter código para hacer lo que te han pedido. Primer error grave: jamás modifiques el código fuente de WordPress. En serio, no lo hagas. La solución está en los WordPress Hooks.

Cómo ya sabes, o seguramente intuyes, WordPress se encarga de construir las páginas web HTML que puedes ver en tu navegador desde el servidor. Cuando llega una petición, se inicia el Loop de WordPress. Si quieres modificar estilos, tendrás que añadir código CSS en los archivos de tu tema, pero si necesitas cambios estructurales más contundentes tendrás que ir al código fuente.

Modificar las líneas de código del núcleo de WordPress puede parecer acertado, pero ni mucho menos lo es. Primero porque puedes romper muchas cosas, y segundo porque cuando actualizes a una nueva versión perderás los cambios muy posiblemente, porque los archivos del core se sobrescriben. Y además, ya sabemos que no actualizar es una muy mala idea.

Afortunadamente, los WordPress Hooks son un mecanismo que nos van a permitir modificar el código fuente de WordPress sin realmente tocarlo. ¿Parece algo imposible? Vas a ver que no. Permíteme que te lo demuestre.

¿Qué son los WordPress Hooks?

Simplificando al máximo, los Hooks de WordPress son puntos concretos dentro del código fuente de WordPress donde podemos conectar nuestras propias funciones para modificar ciertos contenidos o comportamientos.

Como ya ves, la palabra hook puede traducirse como gancho, y en el caso que estamos tratando, estos ganchos nos permiten colgar funciones de ellos, como si se tratase de un abrigo en una percha. Al colgar (o enganchar) nuestras funciones en un hook (o gancho), cuando la ejecución de WordPress llegue a ese hook, nuestra función se ejecutará, haciendo lo que nosotros hayamos programado.

Action Hooks y Filter Hooks

Existen dos tipos diferentes de hooks en WordPress: las acciones y los filtros. Aunque ambos son conceptos muy parecidos en cuanto a la forma de usarlos, su comportamiento es diferente.

Las acciones (o Action Hooks) nos permiten ejecutar funciones propias, además de las funciones que ya se incluyen en el código de WordPress para tal acción. Los filtros, en cambio, nos permiten modificar una funcionalidad existente. Básicamente podemos ver a las acciones y filtros como eventos concretos que al suceder llaman a las funciones nuestras que les hayamos asociado.

La principal diferencia entre acciones y filtros es que los filtros deben retornar un parámetro a la función original. Esto significa que toman un parámetro del código sobre el que filtran, lo modifican de algún modo y lo devuelven cambiado.

Por otro lado, las acciones simplemente añaden código adicional al punto donde se enganchan, sin tener en cuenta qué más se está haciendo en ese punto.

Por ejemplo, si queremos cambiar el texto de una entrada, podemos añadir una función propia a la acción publish_post (la tienes aquí en el Codex) que modifique la entrada en el momento de publicarla. O podemos añadir una función en el filtro the_content (aquí en el Codex) que modifique la entrada cuando se está a punto de pintar en el navegador del visitante.

No te preocupes si aún tienes dudas entre acciones y filtros, seguramente se despejen cuando veas el código.

Nelio Unlocker

Pásate a WordPress manteniendo tus diseños y contenidos

Mejora hoy mismo el SEO de tu web y acelera su velocidad de carga convirtiendo tus páginas a estándares HTML, CSS y WordPress. No necesitas conocimientos técnicos y solo pagarás por aquello que necesites.

Pruébalo ya

La estructura de un hook

Para definir una función y engancharla en un hook de WordPress, sólo hemos de definir la función y utilizar la llamada add_action o add_filter, como vemos a continuación:

Ten en cuenta que add_action la utilizamos cuando queremos engancharnos a un Action Hook, mientras que add_filter cuando queremos engancharnos a un Filter Hook. Sin embargo, add_filter no es más que un alias a add_action (internamente hace una llamada a add_action), por lo que podríamos usar siempre add_action y no pasaría nada.

Veamos los parámetros que admite la función add_action para definir el enganchamiento de tu función de un hook de WordPress concreto (ver línea 5 del código anterior):

• nombre_del_hook: El nombre de la acción o filtro concreto de WordPress, e indica a qué evento asociar nuestra función.
• mi_funcion: El nombre de la función que queremos asociar con el hook concreto. Puede ser una función estándar de PHP, una función existente en el código fuente de WordPress, o una función que nosotros definamos (como sucede en el ejemplo anterior, líneas 2 a 4).
• prioridad: Es un parámetro opcional utilizado para especificar el orden en el que la función asociada al hook se va a ejecutar. Es un valor entero (un número, vaya) y por defecto si no ponemos nada tiene un valor de 10. Indicar un número más bajo indica que queremos que nuestra función sea más prioritaria que otras. Si hay más de una función asociada a un hook concreto y tienen la misma prioridad, se ejecutan en el orden en el que se hayan añadido al hook.
• parametros: Es un parámetro opcional cuyo valor es un entero (otro número) que indica cuántos parámetros ha de aceptar la función que asociamos al hook. Por defecto el valor es 1, aunque hay algunos hooks que pueden pasar más de una parámetro a la función.

Como lo mejor es ver ejemplos, vamos a empezar por añadir una función que envíe un correo al autor de una entrada cuando esta se publica en nuestro WordPress. Utilizamos la Action Hook publish_post que ya hemos mencionado antes y la función wp_mail que puedes ver aquí en el Codex:

Fíjate que asociamos la función notifica_al_autor al Action Hook publish_post mediante add_action. La función que hemos enganchado lo único que hace es una llamada a wp_mail para enviar un correo al autor de la entrada.

Y ahora vamos a ver un ejemplo de filtro:

Como puedes intuir mirando el código, utilizamos el filtro the_title que nos permite modificar el título de entradas cuando las devolvemos desde la base de datos de WordPress. En este caso enganchamos al filtro una función nuestra cuyo nombre es incluye_exclusiva que añade el texto "¡Exclusiva!" delante de un título cuando la entrada pertenece a la categoría Exclusiva.

De este modo, hemos visto dos ejemplos de cómo modificar el comportamiento por defecto de WordPress sin tener que que tocar el código fuente del propio WordPress. La pregunta que seguramente te estarás haciendo es: si no puedo tocar el código fuente, ¿dónde he de poner el código de los hooks que hemos visto en los ejemplos para que funcione? Sigue leyendo para saber la respuesta.

Cómo implementar WordPress Hooks

Hay varias maneras de añadir código que implementa funciones asociadas a hooks en WordPress. Principalmente, podemos añadir este código dentro del archivo functions.php de tu tema, o incluso mejor, dentro de un tema hijo. De este modo tus funciones estarán disponibles para ser ejecutadas.

Otra opción es crear un plugin nuevo dónde incluir estas funciones junto a las llamadas a add_filter y add_action. Esto puede ser algo más complicado, si no sabemos trabajar con plugins, por lo que te recomiendo empezar con el archivo functions.php. Tan sólo hemos de ir a Apariencia » Editor dentro del Escritorio de WordPress y ahí escoger el tema que tenemos activo. Buscamos el archivo functions.php y añadimos el código que queramos, siguiendo las directrices explicadas en la sección anterior.

Tienes que tener un par de cosas en cuenta cuando hagas esto. La primera es no equivocarte con la sintaxis PHP, ya que si escribes mal el código puedes tirar por los suelos toda tu web. Lo mejor para ello es bajarte por FTP el archivo functions.php a tu ordenador, guardar una copia sin ninguna modificación (por si acaso) y editar una copia en local. Cuando hayas acabado y estés seguro que está bien, súbelo de nuevo por FTP y comprueba que todo funciona bien. Si te hubieras equivocado y tu web no funciona, no pasa nada; vuelve a subir la copia original del archivo.

La otra cosa a tener en cuenta es que el nombre de la función que asocies a un hook ha de ser único. Si utilizas un nombre que otro plugin o tema ya utilice, tendrás problemas. Por lo que suele estar bien añadir un prefijo antes del nombre de la función. Por ejemplo, en la función anterior incluye_exclusiva podríamos usar mejor wprincipiante_incluye_exclusiva, ya que seguramente nadie más a parte de nosotros utilizará nombres de función que empiecen por wprincipiante_.

Por último, si queremos desactivar una acción o un filtro sólo tenemos que llamar a las funciones remove_action o remove_filter:

En el ejemplo anterior vemos cómo desactivar la asociación entre los hooks y las funciones de los ejemplos que hemos visto antes. Y si quieres volver a activar una función que hayamos desactivado, tan solo has de volver a hacer al llamada a add_action o add_filter. Tan simple como eso.

Solo un apunte más para terminar. Si al usar add_action o add_filter indicaste una prioridad diferente del valor por defecto de 10, al hacer remove_action o remove_filter tendrás que especificar el valor concreto para que la desactivación funcione. Y recuerda no eliminar nada a menos que estés seguro de lo que estás haciendo.

Para saber más

Este artículo no es más que una introducción básica a los hooks en WordPress. Si quieres entrar en más detalle en ciertos aspectos, debes visitar el Codex de WordPress, donde encontrarás todo lo necesario para convertirte en un crack del desarrollo.

En concreto, deberías echarle un ojo a las siguientes secciones del Codex:

• Filter Reference: Lista con todos los Filter Hooks (o filtros) que están disponibles en WordPress.
• Action Reference: Lista con todos los Action Hooks (o acciones) disponibles.
• Plugin API: Introducción a los hooks en WordPress desde la perspectiva del desarrollo de plugins.
• Theme Development: Introducción al desarrollo de temas para WordPress.
• Writing a Plugin: Introducción al desarrollo de plugins en WordPress.

Resumen final

En esta entrada has conocido los WordPress Hooks, y en concreto las acciones y filtros que nos permiten modificar el comportamiento de WordPress sin tener que cambiar el código fuente.

Tanto si piensas desarrollar o modificar temas de WordPress o si quieres crear plugins, los WordPress Hooks son los ganchos que te van a permitir añadir código propio (engancharte) a ciertos puntos de la ejecución de WordPress, así como filtrar ciertos datos para modificar sus valores.

Además de ver cómo implementar hooks incluyendo nuestras propias funciones PHP, hemos visto cómo desactivarlos. Al principio trabajar con ellos es un poco liado, pero a la larga todo es mucho más dinámico.

Para terminar sólo me queda repetir que no toques el código fuente de WordPress directamente, sino que uses los Hooks. Y si tienes dudas, siempre las puedes describir en los comentarios, donde intentaremos ayudarte a resolverlas.

Imagen destacada de haru__q.