WordPressで特定のカスタム投稿タイプのアーカイブページのタイトル名を取得する「post_type_archive_title」

ところで、「spot」という名前でカスタム投稿タイプを作ったんですが(作り方などの解説はこちら「投稿タイプ」をご参考ください)

その「spot」のアーカイブページのファイル名を「archive-spot.php」にしてテーマフォルダ内に入れているんですが、アーカイブページでタイトルを表示する際には「post_type_archive_title」を使うと便利な事を知りました。

「post_type_archive_title」の使い方

Codex「関数リファレンス/post type archive title」を参考にすると、

 archive.php および archive-{投稿タイプ}.php テンプレートファイル用に最適化されており、その投稿タイプのタイトルを表示します。

と書いてあるので、まさに今回のケースにハマった感じですね。

コードの書き方

サンプルコードが同じくCodexに掲載されていますので、そのままお借りしますと・・・

<?php post_type_archive_title( $prefix, $display ); ?>

という感じです。

パラメーター

・$prefix・・・ タイトルの前に表示する文字列(オプション)初期値:なし ※「$display」引数が「false」の場合は無視されるようです。(詳細は「http://core.trac.wordpress.org/ticket/16632 」を参照して欲しいとのことです。)

・$display・・・一旦変数などに格納する場合は「false」でOK。そのまま出力する場合は「true」デフォルト:「true」

使い方も理解できたので、今後はこの関数「post_type_archive_title」を使うことにしました。何かのご参考となりましたら幸いです。

著者:bouya Imamura