IS_CUSTOMIZE_PREVIEW() │ WP 4.0.0

Функция IS_CUSTOMIZE_PREVIEW() проверяет, просматривается ли сайт в кастомизаторе WordPress (страница визуальных настроек темы). Это условная функция.

Что такое кастомизатор?

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

Как работает функция?

Сама функция is_customize_preview() действительно выполняется только в той ситуации, когда вы находитесь в среде кастомизатора. Это может произойти, когда:

• Вы открыли страницу кастомизатора в админке.
• Вы отправили запрос (через AJAX/POST/GET), чтобы обновить настройки кастомизатора.
• Вы отправили запрос для сохранения параметров кастомизатора.

Функция использует глобальную переменную $wp_customize, которая содержит экземпляр класса WP_Customize_Manager.

Время выполнения

• 1 раз — 0.000014 сек (очень быстро).
• 50000 раз — 0.01 сек (супер быстро).

PHP версия: 7.1.0, WP версия: 4.7.

Возвращаемое значение

Функция возвращает true (истина), если сайт просматривается в кастомизаторе, и false (ложь) в остальных случаях.

Применение

Чтобы использовать данную функцию, просто вызовите её:

is_customize_preview();

Примеры использования

Пример 1

if (is_customize_preview()) {
    // Это страница кастомизатора
}

Пример 2

Функция ниже выполнится только на странице администрирования кастомизатора:

function my_function() {
    // Завершить, если это не кастомизатор
    if (!is_customize_preview()) 
        return;

    // Код функции...
}

Примечания

• Глобальная переменная: $wp_customize — экземпляр кастомизатора.

История изменений

• С версии 4.0.0 — введена в WordPress.

Исходный код функции

function is_customize_preview() {
    global $wp_customize;
    return ($wp_customize instanceof WP_Customize_Manager) && $wp_customize->is_preview();
}

Похожие функции

Условные теги

Условные теги помогают вам определить, какой тип страницы текущий. Вот несколько примеров:

• is_404() — Проверьте, существует ли страница.
• is_admin() — Проверить, находитесь ли вы в админке.
• is_single() — Проверить, отображается ли одиночная запись.

Эти функции полезны для создания динамического контента в WordPress.