get_the_archive_title

説明

string get_the_archive_title()
アーカイブページのタイトルを取得する。

パラメータ

パラメータはありません。

返り値

アーカイブページのタイトルを返す。未知の投稿フォーマットの場合、''が返る可能性がある。

注意

headタグのtitleタグ向けではなく、bodyタグ(コンテンツ)内などで使用するタイトルを取得する。タイトルは、次に示す表の順にリクエストを評価して決定する。

判定条件書式(英語)書式(日本語)
is_category()'Category: %s''カテゴリー: %s'
is_tag()'Tag: %s''タグ: %s'
is_author()'Author: <span class="vcard">%s</span>''作者別: <span class="vcard">%s</span>'
is_year()'Year: %s''年: %s'
is_month()'Month: %s''月別: %s'
is_day()'Day: %s''日: %s'
is_tax( 'post_format' )'Asides'、'Galleries'など'アサイド'、'ギャラリー'など
is_post_type_archive()'Archives: %s''アーカイブ: %s'
is_tax()'タクソノミー名: ターム名'
上記以外'Archives''アーカイブ'

使用例

  • アーカイブページのタイトルを取得する。
    <?php $title = get_the_archive_title(); ?>

フィルター

[5.5.0]タイトル部分とタイトルのプレフィックスを連結する前に'get_the_archive_title_prefix'フィルターを呼び出す。このフィルターの返り値が空の場合、タイトル部分とタイトルのプレフィックスを連結されない。パラメータ$prefixにはタイトルのプレフィックス(アーカイブの種別など)が格納されている。
$prefix = apply_filters( 'get_the_archive_title_prefix', $prefix );
[4.1.0]タイトルを返す直前に'get_the_archive_title'フィルターを呼び出す。パラメータ$titleはリクエストに応じたタイトルが格納されている。[5.5.0]パラメータ$original_title$prefixが追加され、$original_titleにはタイトル部分が、$prefixにはタイトルのプレフィックスが格納されている。
return apply_filters( 'get_the_archive_title', $title, $original_title, $prefix );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/general-template.php

最終更新 : 2020年08月18日 13:27



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

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

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

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。