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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。