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



お勧め

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

Emojin:プラグイン作ってみました(2015年3月21日 更新)

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。

メタボックスをクラシックエディターのみで表示する(2019年1月15日 更新)

投稿画面向けにメタボックスを使ったプラグインがあり、それがブロックエディターで意図した通りに機能しなかった。この対処方法を考える過程でエディタータイプに応じてメタボックスを出し分けできる方法が見つかったので紹介したい。