wp_get_document_title

説明

string wp_get_document_title( )
ページタイトルを取得する。

パラメータ

パラメータはありません。

返り値

ページタイトルを返す。

注意

4.4.0で wp_title関数から代わったページタイトル生成関数となる。実際には本関数を直接呼び出さず、テーマのfunctions.phpで add_theme_support関数することが推奨されている。

add_theme_support( 'title-tag' );

[5.8.0]'document_title'フィルターが追加された。


使用例

  • ページタイトルを取得する。
    <?php $title = wp_get_document_title(); ?>

フィルター

[4.4.0]はじめに'pre_get_document_title'フィルターを呼び出す。パラメータ$titleは標準では''となる。このフィルターで''以外を返すと以降の処理が行われず、それがページタイトルとなる。
$title = apply_filters( 'pre_get_document_title', $title );
[4.4.0]リクエストに応じてページタイトル要素を取得すると'document_title_separator'フィルターを呼び出す。パラメータ$sepは標準では'-'となる。
$sep = apply_filters( 'document_title_separator', $sep );
[4.4.0]タイトル要素の区切り文字を決定すると'document_title_parts'フィルターを呼び出す。パラメータ$titleはいくつかのタイトル要素の連想配列(キー'title'は必須で、'page'、'tagline'、'site'はリクエストに応じて追加される)となる。
$title = apply_filters( 'document_title_parts', $title );
[5.8.0]ページタイトルを返す前に'document_title'フィルターを呼び出す。パラメータ$titleにはページタイトルが格納されている。
$title = apply_filters( 'document_title', $title );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/general-template.php

最終更新 : 2021年07月21日 13:26



お勧め

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

Slightly troublesome permalink:プラグイン作ってみました(2021年4月20日 更新)

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。