get_the_post_type_description()


WordPressのget_the_post_type_description()関数は、現在の投稿タイプの説明を取得するために使用されます。

構文

get_the_post_type_description();

この関数は引数を受け取りません。現在の投稿タイプの説明を返します。説明は投稿タイプを登録する際に設定されます。

例 1: 現在の投稿タイプの説明を表示

以下のコードは、現在の投稿タイプの説明を画面に表示します。

<?php echo get_the_post_type_description(); ?>

例 2: 投稿タイプの説明を特定のHTMLタグでラップ

投稿タイプの説明を特定のHTML要素でラップして表示します。

<?php echo '<div class="post-type-description">' . get_the_post_type_description() . '</div>'; ?>

例 3: 投稿タイプが特定の場合のみ説明を表示

投稿タイプが「カスタム投稿タイプ」の場合のみ説明を表示します。

<?php
if ( get_post_type() === 'custom_post_type' ) {
    echo get_the_post_type_description();
}
?>

例 4: デフォルトの説明を追加

投稿タイプに説明が設定されていない場合、デフォルトの説明を表示します。

<?php
$description = get_the_post_type_description();
if ( empty( $description ) ) {
    $description = 'この投稿タイプには説明が設定されていません。';
}
echo $description;
?>

例 5: 投稿タイプの説明を条件付きで変更

特定の投稿タイプに対して、説明を動的に変更します。

<?php
$post_type = get_post_type();
if ( $post_type === 'custom_post_type' ) {
    echo 'このカスタム投稿タイプの説明はこちらです: ' . get_the_post_type_description();
} else {
    echo get_the_post_type_description();
}
?>

注意点

  • get_the_post_type_description()はテーマやプラグイン内での使用を想定しています。
  • 投稿タイプの説明はregister_post_type()で設定される必要があります。
  • 説明が設定されていない場合、空の文字列が返されます。

関連機能：