the_archive_description()


WordPressのthe_archive_description()関数は、アーカイブページの説明文を表示するために使用されます。カテゴリー、タグ、カスタムタクソノミーなどのアーカイブページで、説明文を簡単に表示することができます。

構文

the_archive_description( string $before = '', string $after = '' );

引数の説明:

  • $before (string) — 説明文の前に表示するHTMLまたはテキスト。
  • $after (string) — 説明文の後に表示するHTMLまたはテキスト。

例1: 基本的なアーカイブ説明文の表示

この例では、アーカイブページの説明文をそのまま表示します。

<?php the_archive_description(); ?>

例2: 説明文の前後にHTMLを追加

説明文の前後に<div>タグを追加して表示します。

<?php the_archive_description( '&lt;div class="archive-description"&gt;', '&lt;/div&gt;' ); ?>

例3: カテゴリーアーカイブの説明文を表示

カテゴリーアーカイブページで説明文を表示する例です。

<?php if ( is_category() ) { the_archive_description(); } ?>

例4: タグアーカイブの説明文を表示

タグアーカイブページで説明文を表示する例です。

<?php if ( is_tag() ) { the_archive_description(); } ?>

例5: カスタムタクソノミーの説明文を表示

カスタムタクソノミーのアーカイブページで説明文を表示する例です。

<?php if ( is_tax( 'custom_taxonomy' ) ) { the_archive_description(); } ?>

例6: 説明文がない場合の代替テキストを表示

説明文がない場合に代替テキストを表示する例です。

<?php if ( ! the_archive_description() ) { echo '説明文はありません。'; } ?>

注意点:

  • アーカイブ説明文は、WordPressの管理画面で設定された説明文を使用します。
  • 説明文がない場合、何も表示されないため、代替テキストを用意することが推奨されます。

関連機能: