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


59

プラグインがメソッドをクラス内にカプセル化し、それらのメソッドの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' ) );正しいアプローチではないようです-少なくとも、私の場合はうまくいかないようです。


N / P。以下のAはあなたのために働きますか?
カイザー

回答:


16

ここで行う最善の方法は、静的クラスを使用することです。次のコードは教育的なものでなければなりません。

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から削除されることに注意してください。


7
重要な点はありますが、すべてのクラスを単純に静的に変換できるわけではありません。
-Geert

Ottoの回答がベストプラクティスですが、質問に最も直接回答するため、この回答を受け入れました。ここで、静的を明示的に宣言する必要はないと思います。関数を静的配列( 'MyClass'、 'member_function')のように扱うことができ、多くの場合 'static'キーワードなしで機能することができるのは(私は間違っているかもしれませんが)私の経験です。
トム・オージェ

@TomAugerいいえ、できません。静的クラスとして追加された場合のみremove_action関数を使用できます。そうでない場合は機能しません。この答えは、あなたの質問には、独自のコードに関してれた場合にのみ、それ以外の場合は、あなたが他の誰かのコードベースから別のフィルタ/アクションを削除しようとしますが、最高のだろうと静的に変更することはできません
sMyles

78

プラグインがを作成するたびnew MyClass();に、一意の名前の変数に割り当てる必要があります。これにより、クラスのインスタンスにアクセスできます。

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

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

これは、プラグインがグローバルネームスペースに含まれているため機能します。そのため、プラグインのメインボディの暗黙的な変数宣言はグローバル変数です。

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

現在、特にPHPはJavaのようにこれを行いません。これは、PHPが半種のOOP実装であるためです。インスタンス変数は、固有のオブジェクト名を含む単なる文字列です。変数関数名の相互作用が->演算子と連動する方法のためにのみ機能します。だから、ただやるnew class()だけで、ばかげて完璧に機能します。:)

結局のところ、絶対にしないでくださいnew class();。やる$var = new class();とそれを参照するために、他のビットのために何らかの方法でそれの$ varがアクセスできるようにします。

編集:数年後

多くのプラグインが行っていることの1つは、「シングルトン」パターンに似たものを使用することです。クラスの単一インスタンスを取得する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()を使用できないことです。これは、新しいインスタンスが$ 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それをアクションフックにフックされたものに入れると、元のプラグインにフックされているアクションが取り消されます。


3
+1データ これは明らかにベストプラクティスです。プラグインコードをそのように書くように努力する必要があります。
トム・オージェ

3
これらの指示に+1を付けると、シングルトンパターンクラスのフィルターを削除するのに本当に役立ちました。
デヴィンウォーカー14年

+1ですが、一般的にはwp_loaded、ではなくにフックする必要plugins_loadedがあります。
EML

4
いいえ、plugins_loaded正しい場所になります。wp_loadedアクションは、後に起こるinitアクションなので、あなたのプラグインは、上の任意のアクションを実行した場合init(そしてほとんどが行う)、その後、あなたはプラグインを初期化し、その前にそれを設定したいです。plugins_loadedフックは、建設段階のための適切な場所です。
オットー

13

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


非常にクールな機能。ここに投稿してくれてありがとう!
トム・オージェ

以下の私の記事で他人ことが述べたように、これらは(レポが更新されない限り、しかし、2年後にはしていない)のWordPress 4.7に壊れる
sMyles

1
wp-filters-extrasリポジトリがv4.7とWP_Hookクラスで実際に更新されたことに注意してください。
デイブロムジー

13

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

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

2
質問-これを4.7でテストしましたか?真新しいフィルターにコールバックを登録する方法にいくつかの変更がありました。私は中に深くあなたのコードを見ていないが、それはあなたがチェックアウトすることがあります何か:make.wordpress.org/core/2016/09/08/...
トム・オージェ

うん、かなり確実これは4.7に壊れる
gmazzapの

ああ!いいえ、そうではありませんでしたが、これを詳しく調べて、互換性があるように更新します(必要な場合)
sMyles

1
@TomAuger、ありがとうございます!関数を更新し、WordPress 4.7+での動作をテストしました(下位互換性は維持されています)
sMyles

1
これを更新して、コア内部の削除方法を使用して(中間反復を処理し、
PHP

2

上記のソリューションは時代遅れのように見えるので、自分で書く必要がありました...

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

0

@Digerkamの回答に基づいたこの関数。比較if $def['function'][0]が文字列であることが追加され、最終的には機能しました。

また、使用$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

これは一般的な答えではありませんが、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' );
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.