Функция single_post_title() │ WP 0.71

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

Описание

Функция single_post_title() оптимизирована для файла шаблона single.php, который используется для отображения заголовка поста. Она полезна, когда вам нужно вывести заголовок поста вне цикла WordPress.

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

Используется в:

wp_get_document_title()

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

• 1 раз — 0.00001 сек (очень быстро)
• 50000 раз — 0.3093 сек (все ещё очень быстро)

Хуки функции

single_post_title

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

Строка или null. Заголовок, когда он извлекается.

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

single_post_title( $prefix, $display );

• $prefix (string) — Что отображать перед заголовком.

  • Значение по умолчанию: ''

• $display (true|false) — Указывает, нужно ли отображать или извлекать заголовок.

  • Значение по умолчанию: true

Примеры

Пример 1: Вывод заголовка поста

Вывод заголовка записи в теге H2 с префиксом "Текущий пост: ":

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

С версии 0.71 появилась эта функция.

Код функции single_post_title

function single_post_title( $prefix = '', $display = true ) {
    $_post = get_queried_object();

    if ( ! isset( $_post->post_title ) ) {
        return;
    }

    /**
     * Фильтрует заголовок страницы для отдельного поста.
     *
     * @since 0.71
     *
     * @param string  $_post_title Заголовок страницы отдельного поста.
     * @param WP_Post $_post       Текущий пост.
     */
    $title = apply_filters( 'single_post_title', $_post->post_title, $_post );
    if ( $display ) {
        echo $prefix . $title;
    } else {
        return $prefix . $title;
    }
}

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

• get_admin_page_title()
• get_the_archive_title()
• get_the_title()
• single_month_title()
• single_term_title()
• the_archive_title()
• the_title()
• the_title_attribute()
• wp_get_document_title()

Эти функции могут быть полезны при работе с заголовками постов и страниц в WordPress.