当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「関数リファレンス/set post format」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(少し修正。)
(クリーンアップ。原文リンクを末尾へ移動。)
 
1行目: 1行目:
{{Languages|
+
== 説明<span id="Description"></span> ==
{{en|Function Reference/set_post_format}}
+
}}
+
  
== 概要 ==
+
指定した投稿の[[投稿フォーマット]]を設定します。この関数は、投稿オブジェクトまたは投稿 ID とフォーマットを与えれば、どこで呼び出しても構いません。
[[投稿のフォーマット|post format]] を設定する.  この関数は、ポスト ID とそのフォーマットが提要されていれば、どこでも呼び出すことが可能です。
+
  
== 使い方 ==
+
== 使い方<span id="Usage"></span> ==
  
<?php set_post_format( $post , $format); ?>
+
<?php set_post_format( $post, $format ); ?>
  
== パラメータ ==
+
== パラメータ<span id="Parameters"></span> ==
  
{{Parameter|$post|整数か文字列|投稿の ID か、投稿のオブジェクト。|必須|none}}
+
{{Parameter|$post|整数/オブジェクト|投稿 ID か、投稿オブジェクト。|必須|なし}}
{{Parameter|$format|文字列か配列|投稿のフォーマット。デフォルトのフォーマットを書き換えるには、空の値か配列を使う。.|必須|none}}
+
{{Parameter|$format|文字列/配列|投稿のフォーマット。指定した投稿からすべてのフォーマットを削除するには、空の文字列または配列を使う。|必須|なし}}
  
== 戻り値 ==
+
== 戻り値<span id="Return"></span> ==
{{Return|Array|array| 関連する ID の配列。間違った投稿 ID かオブジェクトが引き渡された場合いは、WP_Errorが返される。}}
+
  
 +
{{Return||配列/WP_Error/false|投稿 ID または投稿オブジェクトが指定されないか間違っていた場合は、<code>WP_Error</code> または <code>false</code>。成功した場合は、影響を受けたターム ID の配列。}}
 +
 +
: '''参考:''' 投稿フォーマットは、[[カスタム分類]] <code>post_format</code> のタームとして投稿へ関連付けられます。
 +
 +
== 用例<span id="Examples"></span> ==
  
== 用例 ==
 
 
<pre>
 
<pre>
 
<?php
 
<?php
 
/*
 
/*
  * 投稿の投稿フォーマットを設定する (ループ内に).
+
  * 投稿の投稿フォーマットを設定する (ループ内で)
 
  */
 
  */
  
set_post_format($post->ID, 'gallery' ); // 渡された投稿を 'ギャラリー' フォーマットに設定する。
+
set_post_format( $post->ID, 'gallery' ); // 指定された投稿を 'gallery' フォーマットにする
  
 
?>
 
?>
 
</pre>
 
</pre>
  
== 更新履歴 ==
+
== 参考<span id="Notes"></span> ==
  
*  [[Version 3.1|3.1]] : 以降
+
== 変更履歴<span id="Changelog"></span> ==
  
== ソースファイル ==
+
* 新規導入: [[Version 3.1|3.1]]
 +
 
 +
== ソースファイル<span id="Source_File"></span> ==
  
 
<tt>set_post_format()</tt> は {{Trac|wp-includes/post-formats.php}} にあります。
 
<tt>set_post_format()</tt> は {{Trac|wp-includes/post-formats.php}} にあります。
  
== 関連資料 ==
+
== 関連項目<span id="Related"></span> ==
  
 
{{Post Formats}}
 
{{Post Formats}}
45行目: 47行目:
 
{{Tag Footer}}
 
{{Tag Footer}}
  
[[Category:Functions]]
+
{{原文|Function Reference/set_post_format|161220}} <!-- 20:50, 27 July 2017 Themightymo 版 -->
 +
 
 +
{{DEFAULTSORT:Set_post_format}}
 +
[[Category:関数]]
 +
 
 +
[[en:Function Reference/set_post_format]]

2017年9月25日 (月) 22:23時点における最新版

説明

指定した投稿の投稿フォーマットを設定します。この関数は、投稿オブジェクトまたは投稿 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最新版との差分