get_the_title() │ WP 0.71

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

Эту функцию можно использовать внутри цикла WordPress, без указания параметров — в этом случае будет возвращён заголовок текущего поста. Если вы передадите ID поста как первый параметр, функция вернёт заголовок указанного поста.

Если пост защищён паролем или является приватным, то перед заголовком будет отображаться "Защищённо" или "Приватно".

В WordPress нет функции get_post_title(), вместо этого используйте get_the_title().

Когда нужно добавить заголовок поста в атрибут HTML-тега, используйте функцию the_title_attribute() вместо the_title() или get_the_title().

Значение, возвращаемое get_the_title(), рекомендуется очищать перед отображением, так как функция выводит все HTML-теги как есть, и это небезопасно. Есть два способа очистки:

• Полная очистка. Предотвращает использование любых HTML-тегов:

  echo esc_html( get_the_title() );

• Частичная очистка. Позволяет оставить базовые HTML-теги (в этом случае производительность может пострадать):

  echo wp_kses_post( get_the_title() );

Использование функции

Функция get_the_title() используется в:

• the_title()

1 раз — 0.000346 сек (быстро) | 50000 раз — 0.68 сек (очень быстро) | PHP 7.1.0, WP 4.7

Хуки функции

• protected_title_format
• private_title_format
• the_title

Возврат

Возвращает строку — заголовок поста.

Как использовать

get_the_title( $post );

$post (int|WP_Post) — ID поста или объект WP_Post.
По умолчанию: глобальный $post.

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

Пример 1: Печать заголовка текущего поста

echo get_the_title();
// Или в теге H1
echo '
'. esc_html( get_the_title() ) .'
';

Пример 2: Печать заголовка поста с ID 25

echo get_the_title( 25 );
// Или передать параметр как объект
$the_post = get_post( 25 );
echo get_the_title( $the_post );

Пример 3: Нужно ли очищать вывод с помощью обратной косой черты?

Это зависит от контекста, в котором используется функция. Как правило, очищать не нужно, так как WP делает это сам. В частности, к хук�� the_title применяются следующие функции:

• convert_chars()
• wptexturize()

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

Общую функцию очистки можно применить через хук:

add_filter( 'the_title', 'my_escape_title' );

function my_escape_title( $title ){
    return esc_html( $title );
}

Изменения в версии

С версии 0.71 — введена функция get_the_title().

function get_the_title( $post = 0 ) {
    $post = get_post( $post );

    $post_title = isset( $post->post_title ) ? $post->post_title : '';
    $post_id    = isset( $post->ID ) ? $post->ID : 0;

    if ( ! is_admin() ) {
        if ( ! empty( $post->post_password ) ) {
            /* перевод: %s: Защищённый заголовок поста. */
            $prepend = __( 'Защищено: %s' );

            $protected_title_format = apply_filters( 'protected_title_format', $prepend, $post );
            $post_title = sprintf( $protected_title_format, $post_title );
        } elseif ( isset( $post->post_status ) && 'private' === $post->post_status ) {
            /* перевод: %s: Приватный заголовок поста. */
            $prepend = __( 'Приватно: %s' );

            $private_title_format = apply_filters( 'private_title_format', $prepend, $post );
            $post_title = sprintf( $private_title_format, $post_title );
        }
    }

    return apply_filters( 'the_title', $post_title, $post_id );
}

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

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

Посты, страницы и другие функции

• edit_post_link()
• get_delete_post_link()
• get_edit_post_link()
• get_permalink()
• get_post_field()
• get_post_status()
• get_post_time()
• get_sample_permalink()
• get_the_content()
• get_the_date()
• get_the_excerpt()
• get_the_ID()
• get_the_modified_date()
• get_the_modified_time()
• get_the_permalink()
• get_the_time()
• get_the_title_rss()
• has_excerpt()
• post_password_required()
• register_post_status()
• the_author()
• the_content()
• the_date()
• the_excerpt()
• the_excerpt_rss()
• the_ID()
• the_modified_date()
• the_permalink()
• the_time()

Эта статья подробно объясняет, как использовать функцию get_the_title() в WordPress, а также важные аспекты её работы и безопасности.