Фильтр WordPress для изменения окончательного вывода HTML

WordPress имеет отличную поддержку фильтров для получения всех видов определенных фрагментов контента и изменения его перед выводом. Как и фильтр the_content, который позволяет получить доступ к разметке для сообщения перед его выводом на экран.

Я пытаюсь найти универсальный фильтр, который дает мне последний шанс изменить окончательную разметку полностью перед выводом.

Я просматривал список фильтров несколько раз, но у меня ничего не выскакивает: https://codex.wordpress.org/Plugin_API/Filter_Reference

Кто-нибудь знает об этом?

Ответы

Ответ 1

AFAIK, для этого нет никакого крючка, поскольку темы используют HTML, который не будет обрабатываться WordPress.

Вы можете, однако, использовать буферизацию вывода, чтобы поймать окончательный HTML:

<?php
// example from php.net
function callback($buffer) {
  // replace all the apples with oranges
  return (str_replace("apples", "oranges", $buffer));
}
ob_start("callback");
?>
<html><body>
<p>It like comparing apples to oranges.</p>
</body></html>
<?php ob_end_flush(); ?>
/* output:
   <html><body>
   <p>It like comparing oranges to oranges.</p>
   </body></html>
*/

Ответ 2

В WordPress нет фильтра "конечного вывода", но вы можете взломать его вместе. Приведенный ниже пример находится в плагине "Must Use", который я создал для проекта.

Примечание. Я не тестировал плагины, которые могли бы использовать действие "shutdown".

Плагин работает, просматривая все уровни открытого буфера, закрывая их и записывая их выходные данные. Затем он запускает фильтр "final_output", отображая отфильтрованный контент.

К сожалению, WordPress выполняет почти такой же процесс (закрывая открытые буферы), но фактически не захватывает буфер для фильтрации (просто сбрасывает его), поэтому дополнительные действия "завершение" не будут иметь к нему доступа. Из-за этого нижеприведенное действие имеет приоритет над WordPress.

WP-содержание/мю-плагинов /buffer.php

<?php

/**
 * Output Buffering
 *
 * Buffers the entire WP process, capturing the final output for manipulation.
 */

ob_start();

add_action('shutdown', function() {
    $final = '';

    // We'll need to get the number of ob levels we're in, so that we can iterate over each, collecting
    // that buffer output into the final output.
    $levels = ob_get_level();

    for ($i = 0; $i < $levels; $i++) {
        $final .= ob_get_clean();
    }

    // Apply any filters to the final output
    echo apply_filters('final_output', $final);
}, 0);

Пример подключения к фильтру final_output:

<?php

add_filter('final_output', function($output) {
    return str_replace('foo', 'bar', $output);
});

Edit:

Этот код использует анонимные функции, которые поддерживаются только в PHP 5.3 или новее. Если вы работаете с сайтом, использующим PHP 5.2 или старше, вы оказываете себе медвежью услугу. PHP 5.2 был выпущен в 2006 году, и хотя Wordpress (edit: в версии WP & lt; 5.2) все еще поддерживает его, вы не должны его использовать.

Ответ 3

Вопрос может быть старый, но я нашел лучший способ сделать это:

function callback($buffer) {
  // modify buffer here, and then return the updated code
  return $buffer;
}

function buffer_start() { ob_start("callback"); }

function buffer_end() { ob_end_flush(); }

add_action('wp_head', 'buffer_start');
add_action('wp_footer', 'buffer_end');

Объяснение Этот код плагина регистрирует два действия - buffer_start и buffer_end.

buffer_start выполняется в конце раздела заголовка HTML. Параметр, функция callback, вызывается в конце буферизации вывода. Это происходит в нижнем колонтитуле страницы, когда выполняется второе зарегистрированное действие, buffer_end.

Функция callback - это место, где вы добавляете свой код для изменения значения вывода (переменная $buffer). Затем вы просто вернете измененный код, и страница отобразится.

Примечания Обязательно используйте уникальные имена функций для buffer_start, buffer_end и callback, чтобы они не конфликтовали с другими функциями, которые могут быть в плагинах.

Ответ 4

@jacer, если вы используете следующие перехватчики, заголовок также включается.

function callback($buffer) {      
    $buffer = str_replace('replacing','width',$buffer);
    return $buffer; 
}

function buffer_start() { ob_start("callback"); } 
function buffer_end() { ob_end_flush(); }

add_action('after_setup_theme', 'buffer_start');
add_action('shutdown', 'buffer_end');

Ответ 5

В последнее время в списке рассылки WP-Hackers появилась дискуссия о теме полной модификации страницы, и, похоже, консенсус заключался в том, что буферизация вывода с помощью ob_start() и т.д. была единственным реальным решением. Также обсуждались проблемы и недостатки: http://groups.google.com/group/wp-hackers/browse_thread/thread/e1a6f4b29169209a#

Подводя итог: он работает и является лучшим решением при необходимости (например, в плагине WP-Supercache), но замедляет общие скорости, потому что ваш контент не может быть отправлен в браузер как готовый, но вместо этого он должен дождаться полного документа, который будет отображаться (для ob_end()), прежде чем он может быть обработан вами и отправлен в браузер.

Ответ 6

Вы можете попробовать найти файл wp-includes/formatting.php. Например, функция wpautop. Если вы ищете что-то со всей страницей, посмотрите на плагин Super Cache. Это записывает окончательную веб-страницу в файл для кэширования. Увидев, как эти плагины могут дать вам некоторые идеи.

Ответ 7

Измененный https://stackoverflow.com/users/419673/kfriend ответ.

Весь код будет на functions.php. Вы можете делать все что угодно с html фильтром final_output.

На вашей теме 'functions.php'

//we use 'init' action to use ob_start()
add_action( 'init', 'process_post' );

function process_post() {
     ob_start();
}


add_action('shutdown', function() {
    $final = '';

    // We'll need to get the number of ob levels we're in, so that we can iterate over each, collecting
    // that buffer output into the final output.
    $levels = ob_get_level();

    for ($i = 0; $i < $levels; $i++) {
        $final .= ob_get_clean();
    }

    // Apply any filters to the final output
    echo apply_filters('final_output', $final);
}, 0);

add_filter('final_output', function($output) {
    //this is where changes should be made
    return str_replace('foo', 'bar', $output); 
});

Ответ 8

Я использовал верхнее решение этого поста (от Kfriend) некоторое время. Он использует mu-plugin для буферизации всего вывода.

Но это решение нарушает кеширование wp-super-cache и при загрузке mu-plugin не генерируются файлы supercache.

Итак: если вы используете wp-super-cache, вы можете использовать фильтр этого плагина следующим образом:

add_filter('wp_cache_ob_callback_filter', function($buffer) {
    $buffer = str_replace('foo', 'bar', $buffer);
    return $buffer;
});

Ответ 9

У меня возникли проблемы с этим кодом, так как в итоге я получил исходный код страницы, поэтому некоторые плагины не влияют на эту страницу. Я пытаюсь решить эту проблему сейчас - я не нашел много информации о передовых методах сбора выходных данных из WordPress.

Обновление и решение:

Код от KFRIEND не работал для меня, так как он захватывает необработанный исходный код из WordPress, а не тот же вывод, который фактически заканчивается в браузере. Мое решение, вероятно, не изящно с использованием переменной globals для буферизации содержимого, но, по крайней мере, я знаю, что получаю тот же собранный HTML, что и в браузере. Может быть, из-за разных настроек плагинов возникают проблемы, но благодаря приведенному выше примеру кода Jacer Omri я закончил с этим.

Этот код в моем случае находится обычно в functions.php в папке темы.

$GLOBALS['oldschool_buffer_variable'] = '';
function sc_callback($data){
    $GLOBALS['final_html'] .= $data;
    return $data;
}
function sc_buffer_start(){
    ob_start('sc_callback');
}
function sc_buffer_end(){
    // Nothing makes a difference in my setup here, ob_get_flush() ob_end_clean() or whatever
    // function I try - nothing happens they all result in empty string. Strange since the
    // different functions supposedly have very different behaviours. Im guessing there are 
    // buffering all over the place from different plugins and such - which makes it so 
    // unpredictable. But that why we can do it old school :D
    ob_end_flush();

    // Your final HTML is here, Yeeha!
    $output = $GLOBALS['oldschool_buffer_variable'];
}
add_action('wp_loaded', 'sc_buffer_start');
add_action('shutdown', 'sc_buffer_end');

Ответ 10

Попробуйте решить это с помощью JavaScript, прежде чем использовать выходные буферы.

Допустим, вы хотите добавить спиннер при загрузке фреймов, например:

(function ($) {

    $(document).ready(function () {
        showSpinnerWhileIFrameLoads();
    });

    function showSpinnerWhileIFrameLoads() {
        var iframe = $('iframe');
        if (iframe.length) {
            $(iframe).before('<div id=\'spinner\'><i class=\'fa fa-spinner fa-spin fa-3x fa-fw\'></i></div>');
            $(iframe).on('load', function() {
                document.getElementById('spinner').style.display='none';
            });
        }
    }

})(jQuery);

Адаптируйте эту идею к своим потребностям, обычно вы должны иметь возможность манипулировать выводом HTML с помощью JavaScript без необходимости связываться с выходными буферами, которые могут, например, нарушить кеш.