wp_get_document_title() は、現在のページのHTMLドキュメントのタイトルを取得するためのテンプレートタグです。主にSEOや表示タイトルの最適化のために使用されます。
機能の説明
wp_get_document_title() は、現在のページの文書タイトル（<title>タグに表示されるタイトル）を取得します。この関数は、投稿、ページ、カテゴリーページ、検索結果ページなど、さまざまなコンテンツタイプに応じて適切なタイトルを自動的に生成します。
シンプルなコード例
$title = wp_get_document_title();
echo $title;使い方の解説
このテンプレートタグを使用することで、現在のページのタイトルを取得できます。WordPressのテーマやプラグイン内でタイトルを表示する際に使用されます。例えば、<title>タグの内容を制御したり、SEO対策用に使用することが可能です。
引数
この関数は引数を取りません。
戻り値
- string
-
ページのドキュメントタイトルを文字列で返します。
オプション
この関数にオプションはありません。
使用例
add_filter('wp_title', 'custom_title_prefix', 10, 2);
function custom_title_prefix($title) {
$document_title = wp_get_document_title();
return 'サイト名 | ' . $document_title;
}
echo custom_title_prefix('');wp_get_document_title(): 現在のページのタイトルを取得します。add_filter(): タイトルのフィルターフックを利用して、カスタムのタイトル形式に変更します。custom_title_prefix(): タイトルの先頭に「サイト名 | 」を追加して出力します。
一緒に使うことが多い関連タグ
get_the_title()
get_the_title() は、投稿やページのタイトルを取得するためのテンプレートタグです。wp_get_document_title() との違いは、ページ全体のタイトルではなく、特定の投稿やページのタイトルに限定される点です。
$post_title = get_the_title();
echo 'この投稿のタイトル: ' . $post_title;追加情報を取得したい場合
タイトルに関する追加情報が必要な場合は、以下の関数も有効です。
get_bloginfo() でサイト名を取得
$site_name = get_bloginfo('name');
echo 'サイト名: ' . $site_name;出力できる情報
- name: サイト名
- description: サイトのキャッチフレーズ
- url: サイトのURL
想定されるトラブル
タイトルが正しく表示されない
テーマが wp_head() を正しく呼び出していることを確認してください。wp_head() が不足していると、タイトルの自動生成が適切に動作しない可能性があります。
タイトルに不必要なプレフィックスが含まれる
add_filter() フックを使ってタイトルの生成ロジックをカスタマイズすることで、余分な情報を削除できます。
Q&A
まとめ
wp_get_document_title() は、現在のページのHTMLドキュメントのタイトルを取得するための便利な関数です。
SEO対策やページタイトルのカスタマイズに頻繁に使用されます。テーマ内で正確なタイトルを取得することで、検索エンジンに適切な情報を提供できます。
コメント