Italiano
Română
РусскийPasando un parámetro a funciones de filtro y acción
Existe una forma de pasar mis propios parámetros a la función en add_filter o add_action.
Por ejemplo, observa el siguiente código:
function my_content($content, $my_param)
{
// hacer algo...
// usando $my_param aquí ...
return $content;
}
add_filter('the_content', 'my_content', 10, 1);
¿Puedo pasar mi propio parámetro? ¿algo como:
add_filter('the_content', 'my_content($my_param)', 10, 1)
o
add_filter('the_content', 'my_content', 10, 1, $my_param)
Por defecto esto no es posible. Hay soluciones alternativas si lo haces de manera orientada a objetos.
Podrías crear una clase para almacenar los valores que quieras usar más tarde.
Ejemplo:
/**
* Almacena un valor y llama a cualquier función existente con este valor.
*/
class WPSE_Filter_Storage
{
/**
* Rellenado por __construct(). Usado por __call().
*
* @type mixed Cualquier tipo que necesites.
*/
private $values;
/**
* Almacena los valores para su uso posterior.
*
* @param mixed $values
*/
public function __construct( $values )
{
$this->values = $values;
}
/**
* Captura todas las llamadas a funciones excepto __construct().
*
* Ten en cuenta: Incluso si la función se llama con solo una cadena como
* argumento, se enviará como un array.
*
* @param string $callback Nombre de la función
* @param array $arguments
* @return mixed
* @throws InvalidArgumentException
*/
public function __call( $callback, $arguments )
{
if ( is_callable( $callback ) )
return call_user_func( $callback, $arguments, $this->values );
// Función incorrecta llamada.
throw new InvalidArgumentException(
sprintf( 'Archivo: %1$s<br>Línea %2$d<br>No se puede llamar: %3$s',
__FILE__, __LINE__, print_r( $callback, TRUE )
)
);
}
}
Ahora puedes llamar a la clase con cualquier función que desees – si la función existe en algún lugar, se llamará con tus parámetros almacenados.
Vamos a crear una función de demostración ...
/**
* Función de filtro.
* @param array $content
* @param array $numbers
* @return string
*/
function wpse_45901_add_numbers( $args, $numbers )
{
$content = $args[0];
return $content . '<p>' . implode( ', ', $numbers ) . '</p>';
}
... y usarla una vez ...
add_filter(
'the_content',
array (
new WPSE_Filter_Storage( array ( 1, 3, 5 ) ),
'wpse_45901_add_numbers'
)
);
... y otra vez ...
add_filter(
'the_content',
array (
new WPSE_Filter_Storage( array ( 2, 4, 6 ) ),
'wpse_45901_add_numbers'
)
);
Salida:
La clave es la reutilización: Puedes reutilizar la clase (y en nuestros ejemplos también la función).
PHP 5.3+
Si puedes usar una versión de PHP 5.3 o superior, los cierres (closures) lo harán mucho más fácil:
$param1 = '<p>¡Esto funciona!</p>';
$param2 = '¡Esto también funciona!';
add_action( 'wp_footer', function() use ( $param1 ) {
echo $param1;
}, 11
);
add_filter( 'the_content', function( $content ) use ( $param2 ) {
return t5_param_test( $content, $param2 );
}, 12
);
/**
* Añade una cadena al contenido del post
*
* @param string $content
* @param string $string Esto es $param2 en nuestro ejemplo.
* @return string
*/
function t5_param_test( $content, $string )
{
return "$content <p><b>$string</b></p>";
}
El inconveniente es que no puedes escribir pruebas unitarias para los cierres.
No solo obtienes un voto a favor por una respuesta de calidad a un problema que debería tener una solución incorporada en el núcleo de WP, sino que también obtienes uno por regresar cinco meses después para actualizar tu respuesta con el ejemplo de cierre (closure) para PHP 5.3+.
Adam
¡Excelente respuesta! Pero, ¿cómo puedo hacer para eliminar este filtro creado por esta función anónima más adelante?
Vinicius Tavares
@ViniciusTavares No puedes. Piensa antes de usarlo. :)
fuxia
Sin embargo, ten en cuenta que si guardas la función anónima en una variable (por ejemplo, $func = function() use ( $param1 ) { $param1; }; y add_action( $func, 11);) entonces puedes eliminarla mediante remove_action( $func, 11 );
bonger
Pero no es recomendable usar funciones anónimas en plugins o temas que vayas a distribuir públicamente (puedes usarlas en tus propios proyectos). El problema con esto es que no podrás desengancharlas. Cualquier enfoque que decidas usar debería permitir ser desenganchado posteriormente.
Mueyiwa Moses Ikomi
Esto no proporciona una respuesta a la pregunta. Una vez que tengas suficiente reputación podrás comentar cualquier publicación; en su lugar, proporciona respuestas que no requieran aclaración del que pregunta. - De la revisión
cjbj
@cjbj En realidad sí lo hace. La pregunta es si se pueden pasar parámetros a la "función" que está en add_filter o add_action. No estaba claro si el usuario quería pasarlo en la propia función add_filter o add_action, aunque esa sea la suposición. :)
samjco-com
Esto no es Jeopardy. Responder en forma de pregunta es más apropiado para comentarios, no para respuestas. Creo que a eso se refiere cjbj.
Jake
Las variables globales no están protegidas: cualquiera puede asignarles cualquier valor (piensa en colisiones de nombres), y son muy difíciles de depurar. En general, se consideran una mala práctica.
fuxia
Esto no pasa la información del registro al callback. Solo indica cuántos parámetros puede aceptar el callback.
fuxia
@fuxia, ¿puedes sugerir un cambio simple para que la información sí se pase? ¿Sería simplemente añadir los valores de los parámetros después del 3?
SherylHohman
¿Estás seguro de que puedes pasar un quinto parámetro a add_filter? Según la documentación oficial, esto no es correcto. ¿Has probado tu respuesta? Por favor, ten cuidado con difundir información errónea.
plong0
Esto no es así como funciona, y mis pruebas hasta ahora confirman que esto no funciona de esta manera.
Jake