post_type_archive_title – カスタム投稿タイプのアーカイブページタイトルを出力する関数

このページでは、カスタム投稿タイプのアーカイブページタイトルを出力する post_type_archive_title() 関数について詳しく紹介します。

post_type_archive_title() 関数とは

archive.php と archive-{$post_type}.php のテンプレートファイル（要するにアーカイブ関係のテンプレート）でカスタム投稿タイプのタイトルを表示するために最適化されています。

パラメーター

使い方

一般的にはアーカイブを表示するテンプレートに設置することが多いでしょう。

post_type_archive_title();

出力するタイトルの前に挿入する文言などを設定することができます。

post_type_archive_title( 'カスタム投稿タイプタイトル：');

フック

post_type_archive_title

apply_filters( ‘post_type_archive_title’, string $post_type_name, string $post_type )

第一引数に post_type_name 、第二引数に $post_type にフィルターすることができます。

以下のコードで値を確認することができます。

add_filter(
	'post_type_archive_title',
	function ( $post_type_name, $post_type ) {
		echo '<hr>' . basename(__FILE__) . ' :: ' . __LINE__;
		echo( '<pre>' );
		var_dump( $post_type_name, $post_type );
		echo( '</pre>' );
		echo '<hr>';

		return $post_type_name;
	},
	10,
	2
);

まとめ

WordPress テーマ開発において、カスタム投稿タイプに対応することは多くあるでしょう。その際には、当然アーカイブページも用意するでしょうし、そこで使われる関数が今回紹介した post_type_archive_title() 関数です。ぜひしっかり確認しておきましょう。

post_type_archive_title() – Function | Developer.WordPress.org

Displays or retrieves title for a post type archive.

developer.wordpress.org