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



お勧め

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

「姓」の後に「名」を(2013年11月6日 更新)

WordPressのユーザー情報設定ページでは、「名(First name)」の後に「姓(Last name)」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)

今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。

投稿情報を連想配列で参照する(2018年5月27日 更新)

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。