• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/set post format

提供: WordPress Codex 日本語版
移動先: 案内検索

説明

指定した投稿の投稿フォーマットを設定します。この関数は、投稿オブジェクトまたは投稿 ID とフォーマットを与えれば、どこで呼び出しても構いません。

使い方

<?php set_post_format( $post, $format ); ?>

パラメータ

$post
整数/オブジェクト) (必須) 投稿 ID か、投稿オブジェクト。
初期値: なし
$format
文字列/配列) (必須) 投稿のフォーマット。指定した投稿からすべてのフォーマットを削除するには、空の文字列または配列を使う。
初期値: なし

戻り値

(配列/WP_Error/false) 
投稿 ID または投稿オブジェクトが指定されないか間違っていた場合は、WP_Error または false。成功した場合は、影響を受けたターム ID の配列。
参考: 投稿フォーマットは、カスタム分類 post_format のタームとして投稿へ関連付けられます。

用例

<?php
/*
 * 投稿の投稿フォーマットを設定する (ループ内で)。
 */

set_post_format( $post->ID, 'gallery' ); // 指定された投稿を 'gallery' フォーマットにする

?>

参考

変更履歴

  • 新規導入: 3.1

ソースファイル

set_post_format()wp-includes/post-formats.php にあります。

関連項目

投稿フォーマット: set_post_format(), get_post_format(), has_post_format(), the_post_format_audio() /en, get_the_post_format_media() /en, get_content_audio() /en, the_post_format_chat() /en, get_the_post_format_chat() /en, get_content_chat() /en, add_chat_detection_format() /en, the_post_format_gallery() /en, get_content_galleries() /en, get_post_gallery_images(), the_post_format_image() /en, get_the_post_format_image() /en, get_content_images() /en, the_post_format_quote() /en, get_the_post_format_quote() /en, get_content_quote() /en, the_post_format_url() /en, get_the_post_format_url() /en, get_content_url() /en, the_post_format_video() /en, get_content_video() /en, the_remaining_content() /en, get_the_remaining_content() /en, get_post_format_meta() /en, post_format_content_class() /en, get_post_format_content_class() /en, post_formats_compat() /en


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/set_post_format最新版との差分