wp_title() の使い方|説明・引数・注意点

説明

wp_title() は、ページタイトルを出力する関数です(非推奨)。

基本構文

wp_title( string $sep = '»', bool $display = true, string $seplocation = '' ): string|void

引数

  • $sep:区切り文字
  • $display:出力するか
  • $seplocation:区切りの位置

戻り値

$display が false のときのみ文字列を返します。

使い方(サンプル)

// 現在は add_theme_support( 'title-tag' ) を使う
add_theme_support( 'title-tag' );

注意点

  • WordPress 4.4 以降は、add_theme_support( 'title-tag' ) の使用が推奨です。

実務での使いどころ

  • 古いテーマの、<title> の出力を、理解するとき。

よくあるミスと対処

  • 新しいテーマでも、これを使っている。add_theme_support( 'title-tag' ) を有効にして、WordPressに、<title> を出力させるのが、推奨。
  • title-tag を有効にしたのに、header.php に、wp_title() を残し、タイトルが二重になる。

NG例

<title><?php wp_title( '|', true, 'right' ); ?></title> <!-- 古い書き方 -->

OK例

add_action( 'after_setup_theme', function () {
	add_theme_support( 'title-tag' );
} );
// header.php には、<title> を書かない

使い分け早見表

方法 特徴
add_theme_support( 'title-tag' ) WordPressが、<title> を出力する(推奨)
wp_get_document_title() ページのタイトルを、文字列で取得する
wp_title() 古い方法で、タイトルを出力する

関連項目

add_theme_support()、wp_get_document_title()

公式リファレンス:wp_title() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました