将参数传递给过滤器和动作功能


52

是一种将我自己的参数传递给add_filteror中的函数的方法add_action。例如看下面的代码:

function my_content($content, $my_param)
{
do something...
using $my_param here ...
return $content;
}
add_filter('the_content', 'my_content', 10, 1);

我可以传递自己的参数吗?就像是:

add_filter('the_content', 'my_content($my_param)', 10, 1)

要么

add_filter('the_content', 'my_content', 10, 1, $my_param)

Answers:


77

默认情况下,这是不可能的。如果您采用OOP方式,则有解决方法。
您可以创建一个类来存储以后要使用的值。

例:

/**
 * Stores a value and calls any existing function with this value.
 */
class WPSE_Filter_Storage
{
    /**
     * Filled by __construct(). Used by __call().
     *
     * @type mixed Any type you need.
     */
    private $values;

    /**
     * Stores the values for later use.
     *
     * @param  mixed $values
     */
    public function __construct( $values )
    {
        $this->values = $values;
    }

    /**
     * Catches all function calls except __construct().
     *
     * Be aware: Even if the function is called with just one string as an
     * argument it will be sent as an array.
     *
     * @param  string $callback Function name
     * @param  array  $arguments
     * @return mixed
     * @throws InvalidArgumentException
     */
    public function __call( $callback, $arguments )
    {
        if ( is_callable( $callback ) )
            return call_user_func( $callback, $arguments, $this->values );

        // Wrong function called.
        throw new InvalidArgumentException(
            sprintf( 'File: %1$s<br>Line %2$d<br>Not callable: %3$s',
                __FILE__, __LINE__, print_r( $callback, TRUE )
            )
        );
    }
}

现在,您可以使用所需的任何函数来调用该类–如果该函数存在于某个地方,则将使用您存储的参数来调用该类。

让我们创建一个演示函数……

/**
 * Filter function.
 * @param  array $content
 * @param  array $numbers
 * @return string
 */
function wpse_45901_add_numbers( $args, $numbers )
{
    $content = $args[0];
    return $content . '<p>' . implode( ', ', $numbers ) . '</p>';
}

……并使用一次……

add_filter(
    'the_content',
    array (
        new WPSE_Filter_Storage( array ( 1, 3, 5 ) ),
        'wpse_45901_add_numbers'
    )
);

… 然后再次 …

add_filter(
    'the_content',
    array (
        new WPSE_Filter_Storage( array ( 2, 4, 6 ) ),
        'wpse_45901_add_numbers'
    )
);

输出:

在此处输入图片说明

关键是可重用性:您可以重用该类(在我们的示例中还可以重用该函数)。

PHP 5.3以上

如果你可以使用PHP版本5.3或更新版本关闭将使得更加容易:

$param1 = '<p>This works!</p>';
$param2 = 'This works too!';

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
);

/**
 * Add a string to post content
 *
 * @param  string $content
 * @param  string $string This is $param2 in our example.
 * @return string
 */
function t5_param_test( $content, $string )
{
    return "$content <p><b>$string</b></p>";
}

缺点是您不能编写闭包的单元测试。 


17
您不仅会为在WP核心应该有内置解决方案的问题提供高质量的答案,而且还会在五个月后回来使用PHP 5.3+闭包示例更新答案。
亚当(

1
很好的答案!但是,以后如何删除该匿名函数创建的过滤器?
Vinicius Tavares 2014年

2
@ViniciusTavares您不能。使用前请三思。:)
fuxia

5
但请注意,如果您将匿名函数保存到变量(例如$func = function() use ( $param1 ) { $param1; };add_action( $func, 11);)中,则可以通过remove_action( $func, 11 );
bonger

1
但是不建议在要发布的插件或主题上使用匿名函数(可以在自己的项目中使用它们)。问题在于您将无法将其摘钩。您决定采用的方法以后都应该无法使用。
Mueyiwa Moses Ikomi

1

创建具有返回函数的所需参数的函数。将此函数(匿名函数,也称为闭包)传递给wp挂钩。

在此处显示有关wordpress后端的管理员通知。

public function admin_notice_func( $message = '')
{
$class = 'error';
    $output = sprintf('<div class="%s"><p>%s</p></div>',$class, $message);
    $func = function() use($output) { print $output; };
    return $func;
}
$func = admin_notice_func('Message');
add_action('admin_notices', $func);

1

使用php 匿名函数

$my_param = 'my theme name';
add_filter('the_content', function ($content) use ($my_param) {
    //$my_param is available for you now
    if (is_page()) {
        $content = $my_param . ':<br>' . $content;
    }
    return $content;
}, 10, 1);

1

我知道时间已经过去,但是我发现自己在传递参数时遇到了一些问题,直到我发现add_filter中的第4个参数是传递参数的数量,包括要更改的内容。因此,如果您传递1个附加参数,则数字应为2,而不是1

add_filter('the_content', 'my_content', 10, 2, $my_param)

和使用

function my_content($content, $my_param) {...}

1

将任意数量的参数传递给WP过滤器和操作的正确,真正简短,最有效的方法来自@Wesam Alalem,这里使用了闭包。

我只想补充一点,通过将实际的doer方法与匿名闭包分开,可以使它更清晰,更灵活。为此,您只需按如下所示从闭包中调用方法(来自@Wesam Alalem答案的修改示例)。

这样,您可以在用于调用实际doer的闭包之外按词法编写尽可能长或复杂的逻辑。

// ... inside some class

private function myMethod() {
    $my_param = 'my theme name';
    add_filter('the_content', function ($content) use ($my_param) {
        // This is the anonymous closure that allows to pass 
        // whatever number of parameters you want via 'use' keyword.
        // This is just oneliner.
        // $my_param is available for you now via 'use' keyword above
        return $this->doThings($content, $my_param);
    }, 10, 2);
}

private function doThings($content, $my_param) {
    // Call here some other method to do some more things
    // however complicated you want.
    $morethings = '';
    if ($content = 'some more things') {
        $morethings = (new MoreClass())->get();
    }
    return $my_param . ':<br>' . $content . $morethings;
}

0

如果您创建自己的钩子,请参见以下示例。

// lets say we have three parameters  [ https://codex.wordpress.org/Function_Reference/add_filter ]
add_filter( 'filter_name', 'my_func', 10, 3 );
my_func( $first, $second, $third ) {
  // code
}

然后实现钩子:

// [ https://codex.wordpress.org/Function_Reference/apply_filters ]
echo apply_filters( 'filter_name', $first, $second, $third );

这不会将信息从注册传递到回调。它只是说回调可以接受多少个参数。
fuxia

@fuxia,您能否建议一个简单的更改,以便信息得到通过?会在参数值之后增加参数值3吗?
SherylHohman


0

尽管直接调用一个函数,但以一种更为优雅的方式进行:将匿名函数作为回调传递。

例如:

我有一个功能可以翻译帖子的标题,内容和摘录。因此,我需要向一些主要函数传递一些参数,以说明谁正在调用。

add_filter( 'the_title', function( $text ) { 
    return translate_text( $text, 'title', 'pl' );
});

add_filter( 'the_content', function( $text ) { 
    return translate_text( $text, 'content', 'pl' );
});

add_filter( 'the_excerpt', function( $text ) { 
    return translate_text( $text, 'excerpt', 'pl' );
});

因此,主函数translate_text接收了我想要的尽可能多的参数,只是因为我已经传递了一个匿名函数作为回调。


-1

我希望这样做,但是由于不可能,我想一个简单的解决方法是调用一个不同的函数,例如 add_filter('the_content', 'my_content_filter', 10, 1);

然后my_content_filter()可以只调用my_content()并传递任何所需的参数。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.