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年8月27日 更新)

サイトの特性によるが、「投稿」には繰り返し更新するものがある。そんなサイトでは投稿一覧ページに「更新日時」があった方が便利。というわけで、今回は投稿一覧にソートに対応した「更新日時」カラムを追加する方法を紹介する。

5.3の機能強化:サブメニューの位置が指定可能になる(2019年10月29日 更新)

プラグインや一部のテーマでは管理画面の左側にあるナビゲーションメニューに任意のサブメニューを追加できる。従来、追加したサブメニューは既存のサブメニューの末尾となっているが、5.3ではその場所を指定できるようになる。

PHPとMySQLのバージョンを確認(2013年9月11日 更新)

先日、WordPressで構築されたサイトについて最新版へのバージョンアップを依頼される。使用されていたWordPressはバージョン2.xということで、最新版へバージョンアップできるのか、PHPとMySQLのバージョンを確認することになった。

ポップアップのログインフォームに何か表示する(2018年11月6日 更新)

まもなくリリースされるWordPress 5.0にタイミングを合わせて「Login rebuilder」プラグインのアップデートを予定している。管理画面にログインしてしばらく操作しないと、ログインフォームがポップアップ表示される。このログインフォームに何かを表示するのが今回の内容だ。

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

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