web-dev-qa-db-ja.com

フィルタとアクション関数にパラメータを渡す

自分のパラメータをadd_filterまたは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)
pluginshooksactionsfilters
51
Aakash Chakravarthy

デフォルトではこれは不可能です。 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'
    )
);

出力：

enter image description here

重要なのは 再利用性 ：クラスを（そしてこの例では関数も）再利用することができます。

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>";
}

欠点は、クロージャの単体テストを書くことができないということです。

76
fuxia

WPのフィルタとアクションに引数をいくつでも渡すための正しい、本当に短くて最も効率的な方法は、@Wesam Alalem here からのもので、クロージャを使用します。

実際の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;
}
1
bob-12345

関数を返す必要な引数を使って関数を作成します。この関数（無名関数、クロージャとも呼ばれる）を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
hornament

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
wesamly

時間が経過したことは知っていますが、add_filterの4番目のパラメーターが、渡されるパラメーターの数を変更するコンテンツを含むことが判明するまで、私は自分のパラメーターを渡すのに問題がありました。したがって、1つの追加パラメータを渡す場合、numberは2であり、あなたの場合は1ではありません。

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

と使用

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

いつでもグローバルを使用できますか？

  global $my_param;
0
samjco

あなたがあなた自身のフックを作成するならば、これは例です。

// 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 );
0
T.Todua