概要
get_post_format関数は、特定の投稿の記事フォーマットを取得するために使用されます。この関数は、カスタム投稿タイプや異なるコンテンツの種類を扱うテーマやプラグインの開発において非常に便利です。以下はこの関数が特に役立つ場合の例です。
- カスタム投稿フォーマットを使用したテーマの開発
- 投稿フォーマットに応じた異なる表示スタイルの実装
- 特定の情報に基づいたカスタムクエリの生成
- 特定のフォーマットに基づいてリストやグリッド表示を制御
- フォーマットに応じたウィジェットの配置
- カテゴリーやタグに基づくフィルタリングの適用
- モバイルデバイス向けにフォーマットを変更
- SEO対策としてのメタデータの取得
構文
get_post_format( $post_id );
パラメータ
$post_id(int) — 投稿のID。省略した場合は現在の投稿が使用されます。
戻り値
- 取得した投稿フォーマット名を返します。フォーマットが設定されていない場合は、
falseが返ります。
関連する関数
使用可能なバージョン
この関数は、WordPress 3.1.0以降で使用可能です。
コアファイルのパス
この関数は wp-includes/post.php に含まれています。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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 |
get_post_format関数は、特定のワードプレスバージョンで非推奨または削除されていません。
サンプルコード
サンプル1: 投稿フォーマットを表示
このコードは、現在の投稿のフォーマットを取得し、表示します。
$post_format = get_post_format();
if ( $post_format ) {
echo '投稿フォーマット: ' . esc_html( $post_format );
} else {
echo 'フォーマットは設定されていません。';
}
サンプル2: 特定の投稿フォーマットを取得
このコードは、特定の投稿IDに基づいて投稿フォーマットを取得します。
$post_id = 42; // 投稿IDの指定
$post_format = get_post_format( $post_id );
echo '指定された投稿のフォーマット: ' . esc_html( $post_format );
サンプル3: 投稿フォーマットに基づく条件分岐
このコードは、投稿フォーマットに基づいて異なるコンテンツを表示します。
if ( get_post_format() === 'video' ) {
echo 'この投稿は動画フォーマットです。';
} else {
echo 'この投稿は動画ではありません。';
}
サンプル4: 一覧ページでのフォーマット表示
このコードは、投稿一覧で各投稿のフォーマットを表示します。
if ( have_posts() ) :
while ( have_posts() ) : the_post();
echo '<h2>' . get_the_title() . '</h2>';
echo '<p>フォーマット: ' . esc_html( get_post_format() ) . '</p>';
endwhile;
endif;
サンプル5: フォーマットが設定された投稿だけを表示
このコードは、投稿フォーマットが設定された投稿だけを表示します。
if ( have_posts() ) :
while ( have_posts() ) : the_post();
if ( get_post_format() ) {
echo '<h2>' . get_the_title() . '</h2>';
}
endwhile;
endif;
これらのサンプルコードはすべて、著作権フリーのアイデアとコードの構造を元にしています。引用元の情報は確認していませんが、これらのスニペットはWordPressの公式文書や開発者向けのリソースから得られたものと同様のスタイルです。