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



お勧め

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 更新)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

管理画面の'アイキャッチ画像'を'写真'に変える(2013年1月23日 更新)

クライアント向けに専用のテーマを提供する際、稀に管理画面内の用語の変更を依頼されることがある。今回は、'アイキャッチ画像'だとわかりにくいので'写真'に変えてほしいということだった。

5.7の機能拡張:投稿一覧画面向けのフィルター(2021年2月18日 更新)

昨日、予定通り公開された「WordPress 5.7 Beta 3(以降Beta 3)」。WordPressはバージョンアップ毎にアクションやフィルターが追加されており、今回のバージョンアップでは投稿一覧画面に影響を与えるフィルターが追加されていた。

Login rebuilder 2.6.0の新機能紹介(2019年4月22日 更新)

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。