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



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

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

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

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。