Фильтр WordPress для изменения окончательного вывода HTML - PullRequest
50 голосов
/ 21 апреля 2009

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

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

Я просматривал список фильтров несколько раз, но у меня ничего не выскакивает: http://adambrown.info/p/wp_hooks/hook/filters

(Я коснулся некоторых WordPress-сообществ по этому вопросу, но не получил ни одного ответа, подумал, что я обращусь к почтенному SO.)

Ответы [ 10 ]

50 голосов
/ 02 апреля 2014

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

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

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

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

в.ч.-контент / мю-плагинов / 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's 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 <5.2 </em>) STILL поддерживает его, вы не должны его использовать.

19 голосов
/ 04 июля 2013

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

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, чтобы они не конфликтовали с другими функциями, которые могут быть в плагинах.

18 голосов
/ 21 апреля 2009

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's like comparing apples to oranges.</p>
</body></html>
<?php ob_end_flush(); ?>
/* output:
   <html><body>
   <p>It's like comparing oranges to oranges.</p>
   </body></html>
*/
13 голосов
/ 26 октября 2014

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

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');
3 голосов
/ 30 апреля 2009

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

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

3 голосов
/ 21 апреля 2009

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

2 голосов
/ 18 сентября 2018

Изменено 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's 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); 
});
2 голосов
/ 04 июля 2018

Я некоторое время пользовался лучшим решением этого поста (от 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;
});
1 голос
/ 12 октября 2016

У меня возникли проблемы с этим кодом, так как я в итоге получил исходный код страницы, поэтому некоторые плагины не влияют на страницу. Я пытаюсь решить эту проблему сейчас - я не нашел много информации о лучших методах сбора выходных данных из 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's 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');
0 голосов
/ 04 ноября 2018

Попробуйте решить это с помощью 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 без необходимости связываться с выходными буферами, которые могут, например, нарушить кеш.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...