概要
has_excerpt関数は、特定の投稿に対して抜粋が存在するかどうかをチェックするための関数です。この関数は、投稿情報に抜粋が含まれているか調べる際に頻繁に使用されます。主に以下のような機能を実装する際に役立ちます。
- 投稿一覧や詳細ページで該当する抜粋がある場合のみ表示する。
- 投稿のカスタムテンプレートで抜粋を使用する条件を設定する。
- 特定のカスタム投稿タイプに対する抜粋の存在確認。
- 抜粋を有効にする必要があるプラグインの作成。
- 抜粋が存在しない場合のフォールバック状態を設定する。
- 投稿内容を要約するためのカスタム表示を実装する。
- テーマのウィジェットエリアでの抜粋の確認。
- SEO対策としての抜粋の活用。
構文
has_excerpt( int|WP_Post $post = null )
パラメータ
$post(int|WP_Post)【オプショナル】: 投稿のIDまたはWP_Postオブジェクト。指定しない場合は現在の投稿を対象とします。
戻り値
- bool: 指定された投稿が抜粋を持っている場合はtrueを、そうでない場合はfalseを返します。
関連する関数
使用可能なバージョン
- ワードプレスバージョン 2.0 以降
コアファイルのパス
/wp-includes/post.php
サンプルコード
- 抜粋があるか確認する基本的な使用例
if ( has_excerpt() ) {
echo 'この投稿には抜粋があります。';
} else {
echo 'この投稿には抜粋がありません。';
}
このコードは、現在の投稿が抜粋を持っているかどうかを確認し、結果を表示します。
- 特定の投稿IDの抜粋を確認する場合
$post_id = 42; // 投稿IDを指定
if ( has_excerpt( $post_id ) ) {
echo '投稿ID 42には抜粋があります。';
}
指定した投稿IDに対して抜粋の有無を確認し、結果を表示します。
- カスタム投稿タイプに対する抜粋の確認
$post_type = 'custom_post_type'; // カスタム投稿タイプを指定
$posts = get_posts( array( 'post_type' => $post_type ) );
foreach ( $posts as $post ) {
if ( has_excerpt( $post ) ) {
echo $post->post_title . 'には抜粋があります。';
}
}
指定したカスタム投稿タイプに対して、各投稿の抜粋の有無を確認します。
- 抜粋がない場合のフォールバック表示
if ( has_excerpt() ) {
the_excerpt();
} else {
echo '<p>この投稿には抜粋が設定されていません。</p>';
}
現在の投稿に抜粋が存在しない場合に、フォールバックメッセージを表示します。
- ウィジェットでの抜粋表示の判断
function my_custom_widget() {
$recent_posts = wp_get_recent_posts();
foreach ( $recent_posts as $post ) {
if ( has_excerpt( $post['ID'] ) ) {
echo '<h2>' . $post['post_title'] . '</h2>';
echo '<p>' . get_the_excerpt( $post['ID'] ) . '</p>';
}
}
}
最近の投稿ウィジェットで各投稿に対する抜粋の有無を確認し、存在する場合のみ抜粋を表示します。
この関数のアクションでの使用可能性
| アクション名 | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | 〇 |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
この関数は特定のワードプレスバージョンで非推奨又は削除されていません。