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



お勧め

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

リクエスト応答を終了する前に何かを処理する(2013年9月26日 更新)

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

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

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

段落ブロックに日付・時刻の入力支援を実装した(2023年1月25日 更新)

ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。

ブロックエディターのタグ入力にタグクラウド機能を追加した(2019年1月10日 更新)

ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。