wp_title

説明

string wp_title( [ string $sep = '»' [ , bool $display = true [ , string $seplocaution = '' ] ] ] )
各種アーカイブページや投稿ページなど、要求されているページに応じたページタイトルを作成し、パラメータ$displayがtrueならば表示する。$displayがfalseの場合は、文字列として返す。

パラメータ

  • $sep
    区切り文字を指定。
  • $display
    タイトルを表示する場合はtrue(省略時)を、取得する場合はfalseを指定。
  • $seplocaution
    区切り文字の連結場所指定('right'かそれ以外)。'right'の場合は、作成したページタイトル文字列の後に区切り文字を連結する。'right'以外の場合はページタイトル文字列の前に連結する。

返り値

パラメータ$displayがfalseの場合はタイトルを返す。$displayがtrueの場合、返り値はない。

注意

パラメータ$sepで指定する区切り文字は、ページタイトルが空になる場合は連結されない。

本関数ではブログ名は出力(表示)されない。標準テーマ「Twenty Twelve」ではwp_titleフィルターを利用し、ブログ名を含めたり、ページ番号を追加するといった対応をしており、header.phpなどのtitleタグ出力部分をすっきりさせている。


使用例

  • ページタイトルを表示する。
    <title><?php wp_title('&laquo;', true, 'right'); ?> <?php bloginfo('name'); ?></title>
  • ページタイトルを取得する。
    <?php $title = wp_title( '' , false ); ?>

フィルター

[4.0.0]タイトルを組み立てる前にwp_title_partsフィルターを呼び出す。パラメータ$title_arrayはタイトルを区切り文字で分割した配列となる。
$title_array = apply_filters( 'wp_title_parts', $title_array );
[2.0.0]作成したタイトルを表示(または返す)直前にwp_titleフィルターを呼び出す。パラメーラ$titleには作成したタイトルが、$sep$seplocautionには本関数で受け取った値がそのまま格納されている。
$title = apply_filters( 'wp_title', $title, $sep, $seplocaution );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/general-template.php

最終更新 : 2018年05月27日 10:48



お勧め

query_posts(WP_Queryクラス)で投稿タグを絞り込む(2011年9月14日 更新)

投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。

管理者ページに文言を表示する(2012年4月19日 更新)

お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。

oEmbedについて考えてみた(2018年5月27日 更新)

本サイト向けにテーマをリニューアルしようと思い一から作っている最中、ふと生成されているHTMLの中にあるoEmbedの記述が目についた。「この記述いつからだっけ」くらいに思いながらリンク先を開き、ちょっとモヤモヤしてしまった。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。