remove_action 或 remove_filter 与外部类？

问题描述

在某种情况下，插件已将其方法封装在类中，然后针对其中一种方法注册了过滤器或操作，如果您不再有权访问该类的实例，那么您如何删除该操作或过滤器？

例如，假设你有一个这样做的插件：

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' ) ); 似乎不是正确的方法 – 至少在我的情况下似乎不起作用。

最佳解决方案

这里最好的办法是使用静态类。以下代码应该是说明性的：

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 中删除。

次佳解决方案

每当一个插件创建一个 new MyClass();，它应该将它分配给唯一命名的变量。这样，该类的实例是可访问的。

所以如果他正在做 $myclass = new MyClass();，那么你可以这样做：

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

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

如果插件没有在某个地方保存新类的标识符，那么在技术上这就是一个 bug 。面向对象编程的一般原则之一是某些变量在某个地方未被引用的对象可以被清理或消除。

现在，PHP 特别不像 Java 那样做，因为 PHP 是一个 half-arsed 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() 。这是因为在设置 $ 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 动作钩子挂钩的东西中，它会撤消原始插件挂起的动作。

第三种解决方案

2 个小 PHP 功能，允许使用”anonymous” 类删除过滤器/操作：https://github.com/herewithme/wp-filters-extras/

第四种方案

这是一个广泛记录的功能，当您无法访问类对象时，为删除过滤器而创建的功能 (适用于 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 );
}

参考文献

remove_action or remove_filter with external classes?

注：本文内容整合自 Google/Baidu/Bing 辅助翻译的英文资料结果。如果您对结果不满意，可以加入我们改善翻译效果：薇晓朵技术论坛。

remove_action 或 remove_filter 与外部类？