get_header_image()

Извлекает изображение заголовка для пользовательского заголовка
Функция WordPress
INT 2.1.0
WordPress Icon

Описание функции

Функция get_header_image() используется для получения изображения заголовка для пользовательского заголовка.

Функция возвращает URL изображения заголовка, которое было установлено пользователем или по умолчанию. Если изображение заголовка не установлено, функция возвращает false.

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

get_header_image(): string|false

Функция get_header_image() является встроенной функцией WordPress и не требует подключения дополнительных файлов или плагинов.

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

$header_image = get_header_image();

В данном примере переменной $header_image будет присвоено значение URL изображения заголовка.

Функция get_header_image() возвращает строку (string) с URL изображения заголовка, если оно установлено пользователем или по умолчанию. Если изображение заголовка не установлено, функция возвращает false.

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

Получение URL-адреса изображения шапки


$header_image = get_header_image();
if ( $header_image ) {
    echo 'URL изображения шапки: ' . esc_url( $header_image );
} else {
    echo 'Изображение шапки не установлено.';
}

В данном примере мы используем функцию get_header_image() для получения URL-адреса изображения шапки. Если изображение шапки установлено, то выводится его URL-адрес с помощью функции esc_url(). Если изображение шапки не установлено, выводится сообщение об этом.

Загрузка изображения шапки на сайт


$header_image = get_header_image();
if ( ! $header_image ) {
    $header_image = 'http://example.com/wp-content/uploads/2022/01/header-image.jpg';
    set_theme_mod( 'header_image', $header_image );
}

В данном примере мы сначала проверяем, установлено ли изображение шапки с помощью функции get_header_image(). Если изображение не установлено, мы задаем URL-адрес нового изображения в переменной $header_image и сохраняем его с помощью функции set_theme_mod(). Это позволяет загрузить изображение шапки на сайт.

Установка изображения шапки по умолчанию


$header_image = get_header_image();
if ( ! $header_image ) {
    $default_header_image = get_template_directory_uri() . '/images/default-header.jpg';
    set_theme_mod( 'header_image', $default_header_image );
}

В данном примере мы сначала проверяем, установлено ли изображение шапки с помощью функции get_header_image(). Если изображение не установлено, мы задаем URL-адрес изображения шапки по умолчанию в переменной $default_header_image с помощью функции get_template_directory_uri(). Затем мы сохраняем этот URL-адрес с помощью функции set_theme_mod(), чтобы установить изображение шапки по умолчанию.

Проверка наличия изображения шапки


$header_image = get_header_image();
if ( $header_image ) {
    echo 'Изображение шапки установлено.';
} else {
    echo 'Изображение шапки не установлено.';
}

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

Изменение размеров изображения шапки


add_theme_support( 'custom-header', array(
    'width'         => 1200,
    'height'        => 400,
    'flex-width'    => true,
    'flex-height'   => true,
) );

В данном примере мы используем функцию add_theme_support() для изменения размеров изображения шапки. Мы передаем массив параметров вторым аргументом функции, где указываем ширину и высоту изображения шапки, а также параметры flex-width и flex-height, которые позволяют изображению шапки иметь гибкую ширину и высоту.

Вопросы и ответы

Как изменить размер заголовочного изображения?

Функция get_header_image() возвращает URL заголовочного изображения для пользовательского заголовка. Иногда нам может понадобиться изменить размер этого изображения, чтобы оно лучше соответствовало дизайну нашего сайта.

Для изменения размера заголовочного изображения мы можем использовать функцию add_theme_support() с параметром 'custom-header'. Этот параметр позволяет нам указать максимальную ширину и высоту заголовочного изображения.


add_theme_support( 'custom-header', array(
    'width'         => 1200,
    'height'        => 400,
    'flex-width'    => true,
    'flex-height'   => true,
) );

В приведенном выше примере мы указываем, что максимальная ширина заголовочного изображения должна быть 1200 пикселей, а максимальная высота — 400 пикселей. Параметры 'flex-width' и 'flex-height' позволяют изображению подстраиваться под изменение размеров окна браузера.

Как добавить ссылку на заголовочное изображение?

Иногда нам может потребоваться добавить ссылку на заголовочное изображение, чтобы пользователи могли перейти на определенную страницу или пост при клике на изображение.

Для добавления ссылки на заголовочное изображение мы можем использовать функцию get_header_image() вместе с функцией get_home_url(), которая возвращает URL домашней страницы.


<a href="<?php echo esc_url( get_home_url() ); ?>">
    <img src="<?php header_image(); ?>" alt="Header Image">
</a>

В приведенном выше примере мы создаем ссылку на домашнюю страницу с помощью функции get_home_url(), а заголовочное изображение выводим с помощью функции header_image(). Мы также добавляем атрибут alt для заголовочного изображения.

Как удалить заголовочное изображение?

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

Для удаления заголовочного изображения мы можем использовать функцию remove_theme_support() с параметром 'custom-header'.


remove_theme_support( 'custom-header' );

В приведенном выше примере мы удаляем поддержку пользовательского заголовка с помощью функции remove_theme_support().

Как установить заголовочное изображение по умолчанию?

Чтобы установить заголовочное изображение по умолчанию в WordPress, вы можете использовать функцию get_header_image(). Эта функция возвращает строку с URL-адресом изображения или значение false, если изображение не установлено.


$default_header_image = get_header_image();
if ( $default_header_image ) {
    echo '<img src="' . esc_url( $default_header_image ) . '" alt="" />';
}

Как изменить заголовочное изображение для конкретной страницы?

Если вам нужно изменить заголовочное изображение для конкретной страницы, вы можете использовать функцию get_header_image() в сочетании с условным оператором if. Вы можете проверить текущую страницу с помощью функции is_page() и затем установить нужное изображение.


if ( is_page( 'about' ) ) {
    $header_image = 'https://example.com/about-header.jpg';
} elseif ( is_page( 'contact' ) ) {
    $header_image = 'https://example.com/contact-header.jpg';
} else {
    $header_image = get_header_image();
}
if ( $header_image ) {
    echo '<img src="' . esc_url( $header_image ) . '" alt="" />';
}

Как изменить заголовочное изображение для конкретной категории?

Если вы хотите изменить заголовочное изображение для конкретной категории, вы можете использовать функцию get_header_image() в сочетании с условным оператором if. Вы можете проверить текущую категорию с помощью функции is_category() и затем установить нужное изображение.


if ( is_category( 'news' ) ) {
    $header_image = 'https://example.com/news-header.jpg';
} elseif ( is_category( 'events' ) ) {
    $header_image = 'https://example.com/events-header.jpg';
} else {
    $header_image = get_header_image();
}
if ( $header_image ) {
    echo '<img src="' . esc_url( $header_image ) . '" alt="" />';
}

Как изменить заголовочное изображение для конкретного поста?

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

Для изменения заголовочного изображения для конкретного поста, вам потребуется использовать другие функции и методы WordPress. Например, вы можете использовать функцию get_post_meta() для получения значения пользовательского поля, в котором хранится URL изображения. Затем, вы можете использовать это значение в своем шаблоне для отображения заголовочного изображения.


$custom_header_image = get_post_meta( get_the_ID(), 'custom_header_image', true );
if ( $custom_header_image ) {
    echo '<img src="' . esc_url( $custom_header_image ) . '" alt="" />';
} else {
    // Вывод стандартного заголовочного изображения
    echo '<img src="' . esc_url( get_header_image() ) . '" alt="" />';
}

Как добавить альтернативный текст к заголовочному изображению?

Функция get_header_image() не предоставляет возможности добавить альтернативный текст к заголовочному изображению. Вы можете использовать другие функции WordPress для этой цели.

Например, вы можете использовать функцию get_custom_header() для получения информации о заголовочном изображении, включая его URL и альтернативный текст. Затем, вы можете использовать эту информацию в своем шаблоне для отображения заголовочного изображения и его альтернативного текста.


$custom_header = get_custom_header();
if ( $custom_header ) {
    echo '<img src="' . esc_url( $custom_header->url ) . '" alt="' . esc_attr( $custom_header->description ) . '" />';
} else {
    // Вывод стандартного заголовочного изображения без альтернативного текста
    echo '<img src="' . esc_url( get_header_image() ) . '" alt="" />';
}

Как использовать заголовочное изображение в шаблоне?

Функция get_header_image() возвращает URL заголовочного изображения, установленного в настройках темы. Вы можете использовать это значение в своем шаблоне для отображения заголовочного изображения.


$header_image_url = get_header_image();
if ( $header_image_url ) {
    echo '<img src="' . esc_url( $header_image_url ) . '" alt="" />';
} else {
    // Вывод стандартного заголовочного изображения
    echo '<img src="default-header-image.jpg" alt="" />';
}

Функция get_header_image() позволяет получить заголовочное изображение для пользовательского заголовка. Она не предоставляет возможности изменить заголовочное изображение для конкретного поста или добавить альтернативный текст к заголовочному изображению. Для реализации этих функций, вам потребуется использовать другие функции и методы WordPress, такие как get_post_meta() и get_custom_header(). Тем не менее, функция get_header_image() полезна для получения URL заголовочного изображения, установленного в настройках темы, и его использования в шаблоне.

Связанные элементы

  • Функция get_custom_header(): возвращает объект, содержащий информацию о пользовательском заголовке.
  • Функция get_header_image_tag(): возвращает HTML-тег для отображения заголовочного изображения.
  • Функция has_custom_header(): проверяет, установлен ли пользовательский заголовок для текущей страницы.
Обсуждение