Функция GET_HEADER_IMAGE() для получения изображения заголовка │ WP 2.1.0

# Функция GET_HEADER_IMAGE() │ WP 2.1.0

Эта функция позволяет получить изображение заголовка для индивидуального заголовка темы.

**Использует:** get_theme_mod()  
**Используется в:** header_image()

## Хуки функции

- get_header_image

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

Строка или false.

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

Чтобы получить изображение заголовка, просто используйте:

```php
get_header_image();

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

Пример 1: Отображение тега изображения для заголовка

Чтобы вставить изображение заголовка на сайт, используйте следующий код:

Перед использованием этого кода, стоит ознакомиться с функцией get_header_image_tag(). Она возвращает тег с атрибутами srcset для адаптивных изображений.

Пример 2: Отображение тега изображения с использованием THE_CUSTOM_HEADER_MARKUP()

Вы также можете использовать функцию the_custom_header_markup():

the_custom_header_markup();

Это можно использовать вместо следующего кода:

Примечания

• Не забудьте проверить, существует ли заголовок изображения, прежде чем его отображать.

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

• Версия 2.1.0 — функция была введена.

Код функции GET_HEADER_IMAGE() для WP 6.7.2

Вот код функции из файла wp-includes/theme.php:

function get_header_image() {
    $url = get_theme_mod( 'header_image', get_theme_support( 'custom-header', 'default-image' ) );

    if ( 'remove-header' === $url ) {
        return false;
    }

    if ( is_random_header_image() ) {
        $url = get_random_header_image();
    }

    /**
     * Фильтрует URL изображения заголовка.
     *
     * @since 6.1.0
     *
     * @param string $url URL изображения заголовка.
     */
    $url = apply_filters( 'get_header_image', $url );

    if ( ! is_string( $url ) ) {
        return false;
    }

    $url = trim( $url );
    return sanitize_url( set_url_scheme( $url ) );
}

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

Поддержка тем

• add_theme_support()
• current_theme_supports()
• get_header_textcolor()
• get_theme_support()
• has_header_image()
• header_image()
• remove_theme_support()

Индивидуальный заголовок (опции темы: видео, цвет, изображение)

• get_custom_header_markup()
• get_header_image_tag()
• get_header_video_url()
• has_custom_header()
• has_header_video()
• is_header_video_active()
• the_custom_header_markup()
• the_header_video_url()

Другие функции темы

• bloginfo()
• body_class()
• get_custom_logo()
• get_page_template()
• get_page_templates()
• get_post_class()
• get_query_template()
• get_stylesheet()
• get_template()
• get_theme_mod()
• get_theme_mods()
• get_theme_root()
• has_custom_logo()
• is_child_theme()
• post_class()
• register_nav_menu()
• register_nav_menus()
• register_theme_directory()
• remove_theme_mod()
• remove_theme_mods()
• search_theme_directories()
• set_theme_mod()
• single_month_title()
• the_custom_logo()
• the_search_query()
• unregister_nav_menu()
• wp_body_open()
• wp_custom_css_cb()
• wp_footer()
• wp_get_archives()
• wp_get_document_title()
• wp_get_theme()
• wp_get_themes()
• wp_head()
• wp_is_mobile()
• wp_nav_menu()
• wp_robots()
• wp_site_icon()
• wp_title()