Получение фонового изображения с помощью get_background_image()

Функция get_background_image() позволяет получить фоновое изображение для настройки пользовательского фона в WordPress. Эта функция была добавлена в версии 3.0.0 и с тех пор используется в различных темах и плагинах.

Основная информация

• Используется в: background_image()
• Время выполнения:
  • 1 раз — 0.004724 сек (очень медленно)
  • 50,000 раз — 4.45 сек (быстро)
• Версии PHP: 7.2.5
• Версии WordPress: 5.0
• Крючки: Нет

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

Функция возвращает строку — URL фонового изображения.

Использование

Для получения фонового изображения, вы можете использовать простую команду:

$bg_image = get_background_image();

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

Пример 1: Получение фонового изображения

$bg_image = get_background_image(); 
echo $bg_image; // http://example.com/wp-content/uploads/2015/04/image.jpg

Пример 2: Отображение URL в CSS-стилях

Вы можете вставить полученный URL непосредственно в ваши CSS-стили:

Пример 3: Использование фонового изображения в качестве запасного

В этом примере показано, как использовать миниатюру поста в качестве фонового изображения для страницы. Если миниатюра не задана, используется изображение по умолчанию из настроек темы:

    

    ID ) ) {
        // Указываем желаемый размер изображения вместо 'full'
        $page_bg_image = wp_get_attachment_image_src( get_post_thumbnail_id( $post->ID ), 'full' );
        $page_bg_image_url = $page_bg_image[0]; // это возвращает только URL изображения
    } else {
        // Запасной вариант – фоновое изображение по умолчанию текущей активной темы
        $page_bg_image_url = get_background_image();
    }
    ?>

    

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

• Версия 3.0.0 — первая версия функции.

Код функции

Вот как реализована функция get_background_image() в коде WordPress:

function get_background_image() {
return get_theme_mod( 'background_image', get_theme_support( 'custom-background', 'default-image' ) );
}

Связанные функции

Для работы с фоновыми изображениями также могут быть полезны следующие функции:

• background_image() — установка фонового изображения.
• has_custom_header() — проверка наличия пользовательского заголовка.
• is_customize_preview() — проверка, находится ли пользователь в режиме предварительного просмотра кастомизатора.

Эти функции могут помочь вам настроить внешний вид вашего сайта на WordPress более гибко и просто.