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



お勧め

囲み型ショートコードとwpautop(2018年5月27日 更新)

ショートコードは投稿記事の閲覧時に動的に内容を変更できる優れもの。galleryやcaptionなどいくつかのショートコードが標準で組み込まれており、一部のプラグインではその機能を利用する手段としてショートコードが利用されている。

使っていないか確認しないとね!(フィルター編)(2019年4月24日 更新)

先週末にWordPress 5.2 Beta3(以降5.2Beta3)が公開され、正式リリースまであとわずか。ソースコードの変更点を見ていくと、wp-login.phpの中に非推奨となったフィルターが目に留まった。

Login rebuilder 2.5.0の新機能紹介(2018年12月10日 更新)

今回追加したものは、任意の名前でロックファイルを設定し、そのファイルが存在する場合は常にログイン不可にする機能である。この機能を有効にしておくことで、何らかの理由により認証に関する情報が漏洩した場合でも不正なログインを防ぐことができる。

時代はWP_Queryなのか(2011年8月1日 更新)

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

query_posts(WP_Queryクラス)で'tax_query'を使いこなす(2011年9月14日 更新)

2日にわたって投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」「query_posts(WP_Queryクラス)で投稿タグを絞り込む」の続き。今日はカテゴリーや投稿タグ以外ののタクソノミーによる絞り込み、複数のタクソノミーの絞り込みの組み合わせについてまとめてみる。