remove_action或remove_filter与外部类?


59

如果插件将其方法封装在一个类中,然后针对这些方法之一注册了过滤器或操作,那么如果您不再有权访问该类的实例,该如何删除该操作或过滤器呢?

例如,假设您有一个执行此操作的插件:

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以下为您工作吗?
kaiser

Answers:


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)2012年

我接受了这个答案,因为它最直接地回答了问题,尽管奥托的回答是最佳实践。我在这里指出,我认为您不需要显式声明static。根据我的经验(尽管我可能错了),您可以将函数视为静态数组('MyClass','member_function'),并且通常无需使用“ static”关键字即可使用。
Tom Auger 2012年

@TomAuger不,您不能,只有将它添加为静态类后才能使用该remove_action函数,否则它将无法正常工作。...这就是为什么我必须编写自己的函数以处理非静态类的原因。仅当您的问题是关于您自己的代码时,此答案才是最佳答案,否则,您将尝试从其他人的代码库中删除另一个过滤器/操作,并且无法将其更改为静态
sMyles

78

每当插件创建时new MyClass();,都应将其分配给唯一命名的变量。这样,就可以访问该类的实例。

因此,如果他在做$myclass = new MyClass();,那么您可以这样做:

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

这是可行的,因为插件包含在全局名称空间中,因此插件主体中的隐式变量声明是全局变量。

如果插件没有在某个地方保存新类的标识符,那么从技术上讲,那是一个错误。面向对象编程的一般原则之一是,某些地方未被某些变量引用的对象将受到清除或清除。

现在,特别是PHP不会像Java那样执行此操作,因为PHP有​​点像是一个半精打采的OOP实现。实例变量只是其中包含唯一对象名称的字符串。它们之所以起作用,仅是因为变量功能名与->操作员的交互方式。因此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()时,它将实例化该类并保存其指针。您可以使用它来挂钩动作。

这样做的一个问题是,如果您使用这样的东西,则不能在构造函数内部使用getInstance()。这是因为new会在设置$ instance之前调用构造函数,因此从构造函数调用getInstance()会导致无限循环并破坏所有内容。

一种解决方法是不使用构造函数(或至少不要在其中使用getInstance()),而应在类中显式具有“ init”函数来设置操作等。像这样:

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

通过这样的操作,在文件的末尾,在所有类都定义好之后,实例化插件变得像下面这样简单:

ExamplePlugin::init();

Init开始添加您的操作,然后调用getInstance()来实例化该类并确保其中只有一个存在。如果您没有init函数,则可以使用此方法最初实例化该类:

ExamplePlugin::getInstance();

为了解决原始问题,可以从外部(也就是在另一个插件中)删除该动作挂钩,如下所示:

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

将其放入与plugins_loaded动作挂钩相关的内容中,它将撤消原始插件所挂钩的动作。


3
+1 Tru dat。显然,这是最佳做法。我们都应该努力以这种方式编写我们的插件代码。
Tom Auger 2012年

3
+1这些说明确实帮助我删除了单例模式类中的过滤器。
Devin Walker

+1,但我认为您通常应该挂钩wp_loaded,而不是plugins_loaded,这可能为时过早。
EML 2015年

4
不,那plugins_loaded是正确的地方。该wp_loaded操作在该init操作之后发生,因此,如果您的插件init对它采取了任何操作(并且大多数情况下都执行了此操作),那么您要初始化该插件并在此之前进行设置。该plugins_loaded挂钩是针对施工阶段正确的地方。
奥托


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警告)
sMyles

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答案。添加了compare 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' );
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.