видалити запуск або delete_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' ) );мабуть, не є правильним підходом - принаймні, в моєму випадку, здавалося, не працює.


Н / п. Чи нижче це робота для вас?
кайзер

Відповіді:


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

Я прийняв цю відповідь, тому що вона відповідає на це питання найбільш безпосередньо, хоча відповідь Отто є найкращою практикою. Тут зауважу, що я не думаю, що вам потрібно чітко заявляти статику. З мого досвіду (хоча я можу помилятися), ви можете просто ставитися до функції як до статичного масиву ("MyClass", "member_function"), і він часто працює без "статичного" ключового слова.
Том Оже

@TomAuger ні, ви не можете, ТІЛЬКИ, якщо він доданий як статичний клас, ви можете використовувати цю remove_actionфункцію, інакше вона не працюватиме ... тому мені довелося написати свою власну функцію для обробки, коли це не статичний клас. Ця відповідь була б найкращою, лише якщо ваше питання стосувалося вашого власного коду, інакше ви намагатиметесь видалити інший фільтр / дію з чужого
кодового

78

Щоразу, коли плагін створює a 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 () всередині конструктора, якщо ви використовуєте таку річ. Це тому, що новий виклик конструктора перед встановленням екземпляра $, тому виклик 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 Дат. Це, очевидно, найкраща практика. Ми всі повинні намагатися писати свій плагін-код таким чином.
Том Ожер

3
+1 ці вказівки дійсно допомогли мені видалити фільтр в однотонному класі шаблону.
Девін Уокер

+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/


Дуже круті функції. Дякуємо, що опублікували тут!
Том Ожер

Як уже згадувалося в моїй публікації нижче, вони будуть порушені в WordPress 4.7 (якщо репо не буде оновлено, але не відбудеться через 2 роки)
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/…
Tom Auger

так, цілком впевнений, що це зламається в 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. Додано порівняння, якщо $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' );
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.