Функция get_header() | WP 1.5.0

Функция get_header() включает в себя файл заголовка header.php из директории текущей темы. Если указано имя ($name), то будет включён файл header-{name}.php.

Если в теме отсутствует файл header.php, будет использован заголовок из стандартной темы, расположенной по адресу: wp-includes/theme-compat/header.php.

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

Функция опирается на функцию locate_template().

Хуки функции

• get_header

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

• null или false. Возвращает пустое значение при успешном выполнении и false, если шаблон не существует.

Применение

get_header( $name, $args );

Параметры

• $name (string) — имя специализированного заголовка. Значение по умолчанию: null.
• $args (array) — дополнительные аргументы, передаваемые в шаблон заголовка. Значение по умолчанию: пустой массив.

Примеры

Пример 1: Простой 404 страница

Ошибка 404 - Не найдено

Пример 2: Несколько заголовков

Для заголовков главной страницы и 404 должны быть использованы имена файлов: header-home.php и header-404.php соответственно.

Изменения

• С версии 1.5.0 — введена функция.
• С версии 5.5.0 — добавлено возвращаемое значение.
• С версии 5.5.0 — добавлен параметр $args.

Код функции get_header() в WP 6.7.2

Файл: wp-includes/general-template.php

function get_header( $name = null, $args = array() ) {
    /**
     * Срабатывает перед загрузкой файла шаблона заголовка.
     *
     * @since 2.1.0
     * @since 2.8.0 Добавлен параметр $name.
     * @since 5.5.0 Добавлен параметр $args.
     *
     * @param string|null $name Имя конкретного файла заголовка для использования. Null для стандартного заголовка.
     * @param array       $args Дополнительные аргументы, передаваемые в шаблон заголовка.
     */
    do_action( 'get_header', $name, $args );

    $templates = array();
    $name      = (string) $name;
    if ( '' !== $name ) {
        $templates[] = "header-{$name}.php";
    }

    $templates[] = 'header.php';

    if ( ! locate_template( $templates, true, true, $args ) ) {
        return false;
    }
}

Взаимосвязанные функции

Шаблоны тем

• comments_template()
• get_footer()
• get_sidebar()
• get_template_part()

Основные функции

• is_home()
• is_404()
• wp_head()
• wp_footer()

Эта информация поможет вам лучше понять, как работает функция get_header() в WordPress и как ее можно использовать при разработке тем.