post_type_archive_title()

post_type_archive_title()
目次

post_type_archive_title()の用途

post_type_archive_title() は、WordPressでカスタム投稿タイプ(post_type)のアーカイブページタイトルを表示するためのテンプレートタグです。この関数は、特に「投稿タイプアーカイブページ」で使用され、該当する投稿タイプの「名前(ラベル)」を取得して出力します。

post_type_archive_title()の使用方法

post_type_archive_title( string $prefix = '', bool $display = true )

post_type_archive_title()のパラメータ

引数説明
$prefixstringタイトルの前に付けるテキスト(任意)
$displaybooltrue(デフォルト)にするとタイトルを出力、false にするとタイトルを返すのみ(表示しない)

post_type_archive_title()の返り値

  • $displayfalse の場合、**投稿タイプのアーカイブタイトル(ラベル名)**が文字列で返されます。
  • $displaytrue の場合は、**画面上にそのまま出力(echo)**され、返り値は null になります。

post_type_archive_title()の使い方の例

タイトルを直接出力する場合(通常)

<h1><?php post_type_archive_title(); ?></h1>

プレフィックス付きで出力する

<h1><?php post_type_archive_title( '一覧:' ); ?></h1>

→ 例: 「一覧:イベント」

取得だけしてカスタム処理したい場合

<?php
$title = post_type_archive_title( '', false );
echo '<h1 class="archive-title">' . esc_html( $title ) . '</h1>';
?>

post_type_archive_title()はいつ使う?

  • archive-{post_type}.php(カスタム投稿タイプのアーカイブテンプレート)で使うケースが最も多いです。
  • 通常の is_post_type_archive() チェックとセットで使うこともあります。
<?php if ( is_post_type_archive() ) : ?>
  <h1><?php post_type_archive_title(); ?></h1>
<?php endif; ?>

post_type_archive_title()の注意点

  • カスタム投稿タイプ登録時に 'has_archive' => true を設定していないと使えません。
  • 投稿タイプの labels 配列内の 'name' を元にタイトルが生成されます。

post_type_archive_title()と似た関数との比較

関数用途特徴
post_type_archive_title()投稿タイプアーカイブタイトル取得カスタム投稿用
single_post_title()投稿・固定ページタイトル取得単一投稿ページ用
the_archive_title()ターム・日付・投稿タイプなど汎用アーカイブタイトル取得より汎用的
よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

この記事を書いた人

初めてホームページを作成したのは1996年。
2000年よりフリーランスで主に中小企業、学校、各種公的団体、個人事業主のWordPressを活用したホームページ制作を行っています。WordPressテーマはそれぞれのクライアントに合わせて作成しています。
WordPressを活用したサイト運営のための情報発信をしていきます。

目次