web-dev-qa-db-ja.com

外部クラスでremove_actionまたはremove_filter?

プラグインがそのメソッドをクラス内にカプセル化してから、それらのメソッドの1つに対してフィルタまたはアクションを登録した場合、そのクラスのインスタンスにアクセスできない場合はどのようにしてアクションまたはフィルタを削除しますか。

たとえば、これを行うプラグインがあるとします。

class MyClass {
    function __construct() {
       add_action( "plugins_loaded", array( $this, 'my_action' ) );
    }

    function my_action() {
       // do stuff...
    }
}

new MyClass();

インスタンスにアクセスする方法がないので、クラスの登録を解除する方法を教えてください。 remove_action( "plugins_loaded", array( MyClass, 'my_action' ) );は正しいアプローチではないようです - 少なくとも私の場合はうまくいかないようです。

57
Tom Auger

ここで行うべき最善のことは、静的クラスを使用することです。次のコードは指導的なものです。

class MyClass {
    function __construct() {
        add_action( 'wp_footer', array( $this, 'my_action' ) );
    }
    function my_action() {
        print '<h1>' . __class__ . ' - ' . __function__ . '</h1>';
    }
}
new MyClass();


class MyStaticClass {
    public static function init() {
        add_action( 'wp_footer', array( __class__, 'my_action' ) );
    }
    public static function my_action() {
        print '<h1>' . __class__ . ' - ' . __function__ . '</h1>';
    }
}
MyStaticClass::init();

function my_wp_footer() {
    print '<h1>my_wp_footer()</h1>';
}
add_action( 'wp_footer', 'my_wp_footer' );

function mfields_test_remove_actions() {
    remove_action( 'wp_footer', 'my_wp_footer' );
    remove_action( 'wp_footer', array( 'MyClass', 'my_action' ), 10 );
    remove_action( 'wp_footer', array( 'MyStaticClass', 'my_action' ), 10 );
}
add_action( 'wp_head', 'mfields_test_remove_actions' );

このコードをプラグインから実行すると、StaticClassのメソッドと関数がwp_footerから削除されます。

15
mfields

プラグインがnew MyClass();を作成するときはいつでも、それはユニークに名前が付けられた変数にそれを割り当てるべきです。そのようにして、クラスのインスタンスはアクセス可能になります。

それで彼が$myclass = new MyClass();をやっていたら、あなたはこれをすることができます:

global $myclass;
remove_action( 'wp_footer', array( $myclass, 'my_action' ) );

これは、プラグインがグローバル名前空間に含まれているために機能します。したがって、プラグイン本体の暗黙の変数宣言はグローバル変数です。

プラグインが新しいクラス somewhere の識別子を保存しない場合、技術的には、それはバグです。オブジェクト指向プログラミングの一般原則の1つは、どこかの変数によって参照されていないオブジェクトはクリーンアップまたは削除の対象となるということです。

さて、PHPはある種のハーフアークPHP実装であるため、特にOOPはJavaのようにはこれを行いません。インスタンス変数は、一意のオブジェクト名を含む単なる文字列です。これらは、変数関数名のやり取りが->演算子と連携する方法のためにのみ機能します。したがって、new class()を実行するだけで、実際には完璧に動作します。 :)

つまり、結論として、決してnew class();を実行しないでください。 $var = new class();を実行し、その$ varを他のビットが参照できるように何らかの方法でアクセス可能にします。

編集:数年後

多くのプラグインがやっているのを見たことの一つは、 "Singleton"パターンに似たものを使うことです。それらは、クラスの単一のインスタンスを取得するためのgetInstance()メソッドを作成します。これはおそらく私が見た中で最高の解決策です。プラグインの例:

class ExamplePlugin
{
    protected static $instance = NULL;

    public static function getInstance() {
        NULL === self::$instance and self::$instance = new self;
        return self::$instance;
    }
}

初めてgetInstance()が呼び出されると、クラスがインスタンス化され、そのポインタが保存されます。これを使ってアクションをフックすることができます。

これに関する1つの問題はあなたがそのようなことを使うならばあなたがコンストラクタの中でgetInstance()を使うことができないということです。これは、newが$ instanceを設定する前にコンストラクタを呼び出すため、コンストラクタからgetInstance()を呼び出すと無限ループが発生し、すべてが中断されるためです。

1つの回避策は、コンストラクタを使用しない(または少なくともその中でgetInstance()を使用しない)ことですが、アクションなどを設定するために明示的に "init"関数をクラスに含めることです。このような:

public static function init() {
    add_action( 'wp_footer', array( ExamplePlugin::getInstance(), 'my_action' ) );
}

このようなものでは、ファイルの最後で、クラスがすべて定義された後などで、プラグインのインスタンス化は次のように単純になります。

ExamplePlugin::init();

Initはあなたのアクションを追加し始め、その際にgetInstance()を呼び出します。これはクラスをインスタンス化し、それらのうちの1つだけが存在することを確認します。 init関数がない場合は、代わりに最初にクラスをインスタンス化するためにこれを行います。

ExamplePlugin::getInstance();

元の質問に対処するには、そのアクションフックを外側から(別のプラグインで)削除することができます。

remove_action( 'wp_footer', array( ExamplePlugin::getInstance(), 'my_action' ) );

それをplugins_loadedアクションフックにフックしたものに入れると、元のプラグインによってフックされていたアクションが元に戻ります。

75
Otto

"匿名"クラスのフィルタ/アクションを削除するための2つの小さなPHP関数: https://github.com/herewithme/wp-filters-extras/

13
herewithme

これは、クラスオブジェクトにアクセスできない場合にフィルタを削除するために私が作成した、広範囲に文書化された関数です(4.7+を含むWordPress 1.2以降で動作します)。

https://Gist.github.com/tripflex/c6518efc1753cf2392559866b4bd1a53

/**
 * Remove Class Filter Without Access to Class Object
 *
 * In order to use the core WordPress remove_filter() on a filter added with the callback
 * to a class, you either have to have access to that class object, or it has to be a call
 * to a static method.  This method allows you to remove filters with a callback to a class
 * you don't have access to.
 *
 * Works with WordPress 1.2+ (4.7+ support added 9-19-2016)
 * Updated 2-27-2017 to use internal WordPress removal for 4.7+ (to prevent PHP warnings output)
 *
 * @param string $tag         Filter to remove
 * @param string $class_name  Class name for the filter's callback
 * @param string $method_name Method name for the filter's callback
 * @param int    $priority    Priority of the filter (default 10)
 *
 * @return bool Whether the function is removed.
 */
function remove_class_filter( $tag, $class_name = '', $method_name = '', $priority = 10 ) {
    global $wp_filter;

    // Check that filter actually exists first
    if ( ! isset( $wp_filter[ $tag ] ) ) return FALSE;

    /**
     * If filter config is an object, means we're using WordPress 4.7+ and the config is no longer
     * a simple array, rather it is an object that implements the ArrayAccess interface.
     *
     * To be backwards compatible, we set $callbacks equal to the correct array as a reference (so $wp_filter is updated)
     *
     * @see https://make.wordpress.org/core/2016/09/08/wp_hook-next-generation-actions-and-filters/
     */
    if ( is_object( $wp_filter[ $tag ] ) && isset( $wp_filter[ $tag ]->callbacks ) ) {
        // Create $fob object from filter tag, to use below
        $fob = $wp_filter[ $tag ];
        $callbacks = &$wp_filter[ $tag ]->callbacks;
    } else {
        $callbacks = &$wp_filter[ $tag ];
    }

    // Exit if there aren't any callbacks for specified priority
    if ( ! isset( $callbacks[ $priority ] ) || empty( $callbacks[ $priority ] ) ) return FALSE;

    // Loop through each filter for the specified priority, looking for our class & method
    foreach( (array) $callbacks[ $priority ] as $filter_id => $filter ) {

        // Filter should always be an array - array( $this, 'method' ), if not goto next
        if ( ! isset( $filter[ 'function' ] ) || ! is_array( $filter[ 'function' ] ) ) continue;

        // If first value in array is not an object, it can't be a class
        if ( ! is_object( $filter[ 'function' ][ 0 ] ) ) continue;

        // Method doesn't match the one we're looking for, goto next
        if ( $filter[ 'function' ][ 1 ] !== $method_name ) continue;

        // Method matched, now let's check the Class
        if ( get_class( $filter[ 'function' ][ 0 ] ) === $class_name ) {

            // WordPress 4.7+ use core remove_filter() since we found the class object
            if( isset( $fob ) ){
                // Handles removing filter, reseting callback priority keys mid-iteration, etc.
                $fob->remove_filter( $tag, $filter['function'], $priority );

            } else {
                // Use legacy removal process (pre 4.7)
                unset( $callbacks[ $priority ][ $filter_id ] );
                // and if it was the only filter in that priority, unset that priority
                if ( empty( $callbacks[ $priority ] ) ) {
                    unset( $callbacks[ $priority ] );
                }
                // and if the only filter for that tag, set the tag to an empty array
                if ( empty( $callbacks ) ) {
                    $callbacks = array();
                }
                // Remove this filter from merged_filters, which specifies if filters have been sorted
                unset( $GLOBALS['merged_filters'][ $tag ] );
            }

            return TRUE;
        }
    }

    return FALSE;
}

/**
 * Remove Class Action Without Access to Class Object
 *
 * In order to use the core WordPress remove_action() on an action added with the callback
 * to a class, you either have to have access to that class object, or it has to be a call
 * to a static method.  This method allows you to remove actions with a callback to a class
 * you don't have access to.
 *
 * Works with WordPress 1.2+ (4.7+ support added 9-19-2016)
 *
 * @param string $tag         Action to remove
 * @param string $class_name  Class name for the action's callback
 * @param string $method_name Method name for the action's callback
 * @param int    $priority    Priority of the action (default 10)
 *
 * @return bool               Whether the function is removed.
 */
function remove_class_action( $tag, $class_name = '', $method_name = '', $priority = 10 ) {
    remove_class_filter( $tag, $class_name, $method_name, $priority );
}
13
sMyles

上記の解決策は時代遅れのように見えます、私自身のものを書かなければなりませんでした...

function remove_class_action ($action,$class,$method) {
    global $wp_filter ;
    if (isset($wp_filter[$action])) {
        $len = strlen($method) ;
        foreach ($wp_filter[$action] as $pri => $actions) {
            foreach ($actions as $name => $def) {
                if (substr($name,-$len) == $method) {
                    if (is_array($def['function'])) {
                        if (get_class($def['function'][0]) == $class) {
                            if (is_object($wp_filter[$action]) && isset($wp_filter[$action]->callbacks)) {
                                unset($wp_filter[$action]->callbacks[$pri][$name]) ;
                            } else {
                                unset($wp_filter[$action][$pri][$name]) ;
                            }
                        }
                    }
                }
            }
        }
    }
}
2
Digerkam

この関数は@Digerkamの回答に基づいています。 $def['function'][0]が文字列で、それがついに私のために機能する場合にcompareを追加しました。

また$wp_filter[$tag]->remove_filter()を使うことで安定性が増します。

function remove_class_action($tag, $class = '', $method, $priority = null) : bool {
    global $wp_filter;
    if (isset($wp_filter[$tag])) {
        $len = strlen($method);

        foreach($wp_filter[$tag] as $_priority => $actions) {

            if ($actions) {
                foreach($actions as $function_key => $data) {

                    if ($data) {
                        if (substr($function_key, -$len) == $method) {

                            if ($class !== '') {
                                $_class = '';
                                if (is_string($data['function'][0])) {
                                    $_class = $data['function'][0];
                                }
                                elseif (is_object($data['function'][0])) {
                                    $_class = get_class($data['function'][0]);
                                }
                                else {
                                    return false;
                                }

                                if ($_class !== '' && $_class == $class) {
                                    if (is_numeric($priority)) {
                                        if ($_priority == $priority) {
                                            //if (isset( $wp_filter->callbacks[$_priority][$function_key])) {}
                                            return $wp_filter[$tag]->remove_filter($tag, $function_key, $_priority);
                                        }
                                    }
                                    else {
                                        return $wp_filter[$tag]->remove_filter($tag, $function_key, $_priority);
                                    }
                                }
                            }
                            else {
                                if (is_numeric($priority)) {
                                    if ($_priority == $priority) {
                                        return $wp_filter[$tag]->remove_filter($tag, $function_key, $_priority);
                                    }
                                }
                                else {
                                    return $wp_filter[$tag]->remove_filter($tag, $function_key, $_priority);
                                }
                            }

                        }
                    }
                }
            }
        }

    }

    return false;
}

使用例

完全に一致

add_action('plugins_loaded', function() {
    remove_class_action('plugins_loaded', 'MyClass', 'my_action', 0);
});

任意の優先順位

add_action('plugins_loaded', function() {
    remove_class_action('plugins_loaded', 'MyClass', 'my_action');
});

任意のクラスと任意の優先順位

add_action('plugins_loaded', function() {
    remove_class_action('plugins_loaded', '', 'my_action');
});
0
Jonny

これは一般的な答えではありませんが、 AvadaテーマとWooCommerce に固有のもので、他の人が役に立つと思うかもしれません:

function remove_woo_commerce_hooks() {
    global $avada_woocommerce;
    remove_action( 'woocommerce_single_product_summary', array( $avada_woocommerce, 'add_product_border' ), 19 );
}
add_action( 'after_setup_theme', 'remove_woo_commerce_hooks' );
0
nabrown