[Mini-tutorial] Introducción a los filtros de WordPress

[metacortex]

Supongamos que escribimos esta función en WordPress:

Código PHP:

function pepe() {
    return 'Pepe es gordo';
}
 
echo pepe();
 

Naturalmente obtendremos "Pepe es gordo" hoy y en 1000 años. Si quisiéramos mostrar "Pepe es flaco" tendríamos que escribir otra función o aplicar un str_replace() a la existente; métodos viables con el presente ejemplo pero definitivamente engorrosos con funciones más complejas. Ahora abordemos esto al estilo WordPress:

Código PHP:

function pepe() {
    return 'Pepe es '. apply_filters( 'contextura', 'gordo' );
}
 
echo pepe();
 

Aquí hemos aplicado un hook tipo filtro. "Hook" significa "gancho", palabra que los define correctamente, pues literalmente son ganchos ubicados dentro de las funciones que nos permiten añadir trozos de código para alterar su comportamiento. Ahora nuestra función pepe() está lista para ser modificada sin tocarle un pelo. Veamos:

Código PHP:

function pepe() {
    return 'Pepe es '. apply_filters( 'contextura', 'gordo' );
}
 
function contex() {
    return 'flaco';
}
 
add_filter( 'contextura', 'contex');
 
echo pepe();
 

Ahora tenemos que "Pepe es flaco" mientras echo pepe() permanece inmutable. Esto es sencillamente genial, pues hablamos de la posibilidad de construir funciones modificables de forma externa.

Revisemos de nuevo lo que ha sucedido en el código anterior: apply_filters es el hook que nos dice "hey, pssst... puedes modificar esta parte", mientras add_filter es el hook que la modifica. Ambos se enganchan a través de un identificador único ('contextura') y se logra la sobrescritura.

Ahora bien ¿Qué pasaría si quisiéramos mostrar "Laura es flaca"?. Pues nada, construimos nuestros "ganchos" donde haga falta:

Código PHP:

function pepe() {
    return apply_filters( 'nombre', 'Pepe' ) .' es '. apply_filters( 'contextura', 'gordo' );
}
 
function otra_cosa() {
    return 'Laura';
}
 
function contex() {
    return 'flaca';
}
 
add_filter( 'nombre', 'otra_cosa');
add_filter( 'contextura', 'contex');
 
echo pepe(); // "Laura es flaca"
 

El ejemplo es bastante básico pero nos ayuda a comprender esta parte de una vez por todas. La estructura de parámetros básica de apply_filters es:

Código PHP:

apply_filters('identificador' , 'elemento modificable');
 

y la de add_filter:

Código PHP:

add_filter( 'identificador', 'funcion modificadora' );
 

Notas:

1) Los hooks también aceptan parámetros extra. Igualmente es posible establecer la prioridad entre dos o más hooks de un mismo tipo. La configuración es la siguiente:

Código PHP:

add_filter('identificador' , 'funcion modificadora' , 'prioridad frente a otros hooks del mismo tipo', 'parámetros extra');
 

2) En el propio sistema de archivos de WordPress, muchas funciones vienen preparadas para ser modificadas mediante filtros. Puedes revisar la lista.

De interés:

- Referencia de filtros.
- apply_filters
- add_filter
- Using Filter Hooks in WordPress Child Themes (el mejor tutorial de inicio que he visto en la red hasta el momento).

[carlos_belisario]

Excelente tutorial metacortex, creo que me leíste la mente, porque estaba por hacer una pregunta sobre los filtros que se utilizan en el archivo functions, mas que todo cual era su uso y creo que mas claro no puede estar, saludos

[lobos1981]

Excelente información y aprendí de una.. xD

Gracias!

[prometenn]

Fantástico tutorial! Por fin me queda un poquito claro, la verdad que el codex es bastante pobre en algunas secciones. Una duda.
En el tema por defecto twenty eleven, la función que se encarga de validar el registro del grupo de opciones de la página de administración en theme-options.php termina así:

Código PHP:

  return apply_filters( 'twentyeleven_theme_options_validate', $output, $input, $defaults);  
   

En este caso concreto, he buscado un add_filter que se encargue de modificar la función, pero no lo he encontrado. Lo único, que el identificador tiene el mismo nombre que la función que lo aplica,

Código PHP:

  twentyeleven_theme_options_validate($input)  
   

He comprobado también la variable $output, es un array y no contiene ninguna función. Aquí ya estoy perdido del todo, pero del todo todo.
Espero haberme explicado bien.

Un saludo.