set_post_format()


WordPressのset_post_format()関数は、指定された投稿のフォーマットを設定するために使用されます。この関数は、投稿のフォーマットを変更する際に役立ちます。

構文

set_post_format( int|WP_Post $post, string $format );

引数の説明:

  • $post(int|WP_Post) — フォーマットを設定する投稿のIDまたは投稿オブジェクト。
  • $format(string) — 設定するフォーマットの種類。例えば、’aside’, ‘gallery’, ‘link’, ‘image’, ‘quote’, ‘status’, ‘video’, ‘audio’, ‘chat’など。

例1: 投稿のフォーマットを「ギャラリー」に設定

この例では、IDが123の投稿のフォーマットを「ギャラリー」に設定します。

set_post_format( 123, 'gallery' );

例2: 現在の投稿のフォーマットを「リンク」に設定

この例では、現在表示されている投稿のフォーマットを「リンク」に設定します。

set_post_format( get_the_ID(), 'link' );

例3: 特定の投稿オブジェクトのフォーマットを「引用」に設定

この例では、特定の投稿オブジェクトのフォーマットを「引用」に設定します。

$post = get_post( 123 ); set_post_format( $post, 'quote' );

例4: 投稿のフォーマットを「画像」に設定

この例では、IDが456の投稿のフォーマットを「画像」に設定します。

set_post_format( 456, 'image' );

例5: 投稿のフォーマットを「ビデオ」に設定

この例では、IDが789の投稿のフォーマットを「ビデオ」に設定します。

set_post_format( 789, 'video' );

例6: 投稿のフォーマットを「オーディオ」に設定

この例では、IDが101の投稿のフォーマットを「オーディオ」に設定します。

set_post_format( 101, 'audio' );

注意点

  • フォーマットを設定する前に、投稿が存在することを確認してください。
  • フォーマットの種類は、テーマがサポートしている必要があります。
  • 無効なフォーマットを指定すると、関数はfalseを返します。

関連機能：