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



お勧め

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

the_date関数で投稿日を確実に表示する(2011年12月20日 更新)

投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。

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

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

さくらのVPSでKUSANAGI(2018年5月27日 更新)

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

絵文字画像がPNGからSVGへ(2018年5月27日 更新)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。