post_type_archive_title()


WordPressのpost_type_archive_title()関数は、カスタム投稿タイプアーカイブページのタイトルを取得または表示するために使用されます。

シンタックス

<?php post_type_archive_title( string $prefix = '', bool $display = true ); ?>

引数の説明:

  • $prefix (string) — タイトルの前に表示される文字列を指定します。省略可能です。
  • $display (bool) — タイトルを直接表示するかどうかを指定します。デフォルトはtrueで、直接表示します。falseを設定すると、タイトルが返されます。

例1: アーカイブタイトルの表示

基本的な使用方法で、カスタム投稿タイプのアーカイブタイトルをそのまま表示します。

<?php post_type_archive_title(); ?>

例2: タイトルのプレフィックスを追加

タイトルの前にプレフィックスを追加します。

<?php post_type_archive_title( 'アーカイブ: ' ); ?>

例3: タイトルを取得してカスタムHTMLで表示

$displayをfalseに設定してタイトルを取得し、カスタムHTMLで表示します。

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

例4: 条件付きでタイトルを表示

現在のページがカスタム投稿タイプのアーカイブページの場合にのみタイトルを表示します。

<?php
if ( is_post_type_archive( 'custom_post_type' ) ) {
    post_type_archive_title( 'アーカイブ: ' );
}
?>

例5: ウィジェットエリアと組み合わせた使用例

タイトルを取得してウィジェットエリアに表示します。

<?php
if ( is_post_type_archive( 'custom_post_type' ) ) {
    echo '<div class="archive-header">';
    echo '<h2>' . post_type_archive_title( '', false ) . '</h2>';
    dynamic_sidebar( 'archive-widget-area' );
    echo '</div>';
}
?>

注意事項

  • この関数はカスタム投稿タイプのアーカイブページでのみ有効です。
  • is_post_type_archive()関数と併用して条件付き表示を行うことを推奨します。

関連機能：