get_the_archive_description()


WordPressのget_the_archive_description()関数は、アーカイブページの説明文を取得するために使用されます。カテゴリー、タグ、カスタムタクソノミーなどのアーカイブページで設定された説明文を表示する際に役立ちます。

構文

get_the_archive_description();

例1: アーカイブページの説明文を表示する

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

<?php echo get_the_archive_description(); ?>

例2: 説明文を条件付きで表示する

説明文が存在する場合のみ表示する例です。

<?php if ( get_the_archive_description() ) { echo get_the_archive_description(); } ?>

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

カテゴリーアーカイブページでのみ説明文を表示します。

<?php if ( is_category() ) { echo get_the_archive_description(); } ?>

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

タグアーカイブページでのみ説明文を表示します。

<?php if ( is_tag() ) { echo get_the_archive_description(); } ?>

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

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

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

例6: 説明文をHTMLタグ付きで表示する

説明文をHTMLタグ付きで表示する例です。

<?php echo wpautop( get_the_archive_description() ); ?>

例7: 説明文を短く切り詰めて表示する

説明文を短く切り詰めて表示する例です。

<?php echo wp_trim_words( get_the_archive_description(), 20 ); ?>

例8: 説明文をカスタムクラス付きで表示する

説明文をカスタムクラス付きで表示する例です。

<?php echo '<div class="custom-class">' . get_the_archive_description() . '</div>'; ?>

注意点

  • 説明文が設定されていない場合、この関数は空の文字列を返します。
  • アーカイブページ以外で使用すると、期待した結果が得られない場合があります。

関連機能：