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



お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

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

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

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。