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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/wp_set_post_terms 13:18, 3 March 2014 Jdgrimes 版を流し込み。)
 
(最初の和訳。)
1行目: 1行目:
{{NeedTrans}}
+
<div id="Description">
 +
== 説明 ==
 +
</div>
  
== Description ==
+
投稿にタームをセットします。
Set terms for a post.
+
  
Uses <code>[[Function Reference/wp set object terms|wp_set_object_terms()]]</code>.
+
関数の内部で <code>[[関数リファレンス/wp set object terms|wp_set_object_terms()]]</code> を使用します。
 +
 
 +
<div id="Usage">
 +
== 使用法 ==
 +
</div>
  
== Usage ==
 
 
  <?php wp_set_post_terms( $post_id, $terms, $taxonomy, $append ) ?>
 
  <?php wp_set_post_terms( $post_id, $terms, $taxonomy, $append ) ?>
  
== Parameters ==
+
<div id="Parameters">
{{Parameter|$post_id|integer|Post ID.|required|0}}
+
== パラメータ ==
{{Parameter|$terms|string,array|List of terms. Can be an array or a comma separated string. If you want to enter terms of a hierarchical taxonomy like categories, then use IDs. If you want to add non-hierarchical terms like tags, then use names.|optional|array}}
+
</div>
{{Parameter|$taxonomy|string|Possible values for example: 'category', 'post_tag', 'taxonomy slug'|optional|post_tag|}}
+
{{Parameter|$append|boolean|If true, tags will be appended to the post. If false, tags will replace existing tags.|optional|false}}
+
  
== Return Values ==
+
{{Parameter|$post_id|整数|投稿 ID|必須|0}}
; <tt>(array&#124;boolean&#124;WP_Error&#124;string)</tt> :
+
{{Parameter|$terms|文字列&#124;配列|タームのリスト。配列またはコンマ区切りの文字列。カテゴリーのように階層のあるタームを入れるには、ID を使う。タグのように階層のないタームを追加するには、名前を使う。|オプション|array}}
 +
{{Parameter|$taxonomy|文字列|タームを関連づけるコンテキストであるタクソノミー。例: 'category', 'post_tag', 'taxonomy slug'|オプション|post_tag|}}
 +
{{Parameter|$append|真偽値|true ならタームが投稿に追加されます。false なら既存のタームを置き換えます。|オプション|false}}
  
* (array) An array of the terms affected if successful,
+
<div id="Returns">
* (boolean) false if integer value of $post_id evaluates as false (<tt>if ( ! (int) $post_id )</tt>),
+
== 戻り値 ==
* (WP_Error) The WordPress Error object on invalid taxonomy (<tt>'invalid_taxonomy'</tt>).
+
</div>
* (string) The first offending term if a term given in the $terms parameter is named incorrectly. (Invalid term ids are accepted and inserted).
+
  
== Hooks ==
+
; <tt>(配列&#124;真偽値&#124;WP_Error&#124;文字列)</tt> :
*Action '''set_object_terms''' in {{Trac|wp-includes/taxonomy.php}}
+
 
 +
* (配列) 成功した場合、変更されたタームの配列。
 +
* (真偽値) $post_id が整数でなかった場合、false (<tt>if ( ! (int) $post_id )</tt>) を返す。
 +
* (WP_Error) 無効なタクソノミーの場合、WordPress Error オブジェクト(<tt>'invalid_taxonomy'</tt>)。
 +
* (文字列) $terms パラメータに指定されたタームの何れかが誤って名付けられていた場合、最初の無効なターム(ただし、無効なターム ID は受け入れられ、挿入されます)。
 +
 
 +
<div id="Hooks">
 +
== フック ==
 +
</div>
 +
 
 +
* アクション '''set_object_terms''' {{Trac|wp-includes/taxonomy.php}} にあります。
 +
 
 +
<div id="Examples">
 +
== 例 ==
 +
</div>
  
== Examples ==
 
 
<!-- Need creative examples. Feel free to link to external examples. -->
 
<!-- Need creative examples. Feel free to link to external examples. -->
 +
{{募集中||クリエイティブな例を求めています。外部サイトへのリンクでも構いません。|情報}}
  
== Notes ==
+
<div id="Notes">
For hierarchical terms (such as categories), you must always pass the id rather than the term name to avoid confusion where there may be another child with the same name.
+
== 参考 ==
 +
</div>
  
To get the term id you can use:
+
階層のあるターム(カテゴリーなど)の場合、ターム名ではなく ID を指定してください。
 +
同じ名前で親が違うタームとの混同を避けるためです。
 +
 
 +
次のようにしてターム ID を取得できます:
 
<pre>$term_id = term_exists( $term, $taxonomy, $parent );</pre>
 
<pre>$term_id = term_exists( $term, $taxonomy, $parent );</pre>
  
You may also need to pass by reference:
+
さらに、パラメータを参照渡しする必要があるかもしれません:
 
<pre>wp_set_post_terms( $post_id, $term, &$taxonomy );</pre>
 
<pre>wp_set_post_terms( $post_id, $term, &$taxonomy );</pre>
  
For non-hierarchical terms (such as tags), you can pass either the term name or id. If you pass the id there is only one caveat: You must pass it as an integer, and it <em>must</em> be in an array. This is necessary because any non-array value passed will be converted to a string, which will be interpreted as a term name.
+
階層のないターム(タグなど)の場合、タームの名前または ID を指定します。
 +
ID を指定するときは一つだけ注意してください:
 +
必ず整数として、そして<em>必ず</em>配列に入れなければなりません。
 +
配列ではない値は(自動的に)文字列に変換され、(ID ではなく)ターム名だと解釈されるためです。
  
 
<pre>
 
<pre>
$tag = '5'; // Wrong. This will add the tag with the *name* '5'.
+
$tag = '5'; // 誤り。「名前」が '5' であるタグが付く。
$tag = 5; // Wrong. This will also add the tag with the name '5'.
+
$tag = 5; // 誤り。これも名前が '5' であるタグが付く。
$tag = array( '5' ); // Wrong. Again, this will be interpreted as a term name rather than an id.
+
$tag = array( '5' ); // 誤り。これでも ID ではなくタームの名前だと解釈される。
  
$tag = array( 5 ); // Correct. This will add the tag with the id 5.
+
$tag = array( 5 ); // 正しい。これで ID が 5 のタグが付く。
 
wp_set_post_terms( $post_id, $tag, $taxonomy );
 
wp_set_post_terms( $post_id, $tag, $taxonomy );
 
</pre>
 
</pre>
  
This function will only work on the native post type. For a taxonomy on a custom post type use [[Function_Reference/wp_set_object_terms|<tt>wp_set_object_terms()</tt>]]
+
* この関数は標準の投稿タイプに対してのみ使えます。カスタム投稿タイプにタクソノミー(ターム)を付けるには [[関数リファレンス/wp_set_object_terms|<tt>wp_set_object_terms()</tt>]] を使用してください。
 +
 
 +
* 内部で [[関数リファレンス/wp_set_object_terms|<tt>wp_set_object_terms()</tt>]] を使用します。
 +
 
 +
<div id="Change Log">
 +
== 改訂履歴 ==
 +
</div>
  
* Uses: [[Function_Reference/wp_set_object_terms|<tt>wp_set_object_terms()</tt>]]
+
* [[Version 2.8|2.8.0]] にて導入されました。
  
== Change Log ==
+
<div id="Source File">
Since: [[Version 2.8|2.8.0]]
+
== ソースファイル ==
 +
</div>
  
== Source File ==
+
<tt>wp_set_post_terms()</tt> {{Trac|wp-includes/post.php}} にあります。
<tt>wp_set_post_terms()</tt> is located in {{Trac|wp-includes/post.php}}.
+
  
== Related ==
+
<div id="Related">
<!--
+
== 関連項目 ==
    To Do:
+
</div>
    Need to find related functions.
+
    Need to create groups of functions and create templates to add them to a page quickly.
+
    Some functions may be related to many groups of functions.
+
-->
+
  
 
{{Term Tags}}
 
{{Term Tags}}
73行目: 99行目:
  
 
{{DEFAULTSORT:Wp_set_post_terms}}
 
{{DEFAULTSORT:Wp_set_post_terms}}
[[Category:Functions]]
+
[[Category:関数]]
  
 
[[en:Function Reference/wp_set_post_terms]]
 
[[en:Function Reference/wp_set_post_terms]]
 
[[it:Riferimento_funzioni/wp_set_post_terms]]
 
[[it:Riferimento_funzioni/wp_set_post_terms]]

2014年8月2日 (土) 08:44時点における版

投稿にタームをセットします。

関数の内部で wp_set_object_terms() を使用します。

使用法

<?php wp_set_post_terms( $post_id, $terms, $taxonomy, $append ) ?>

パラメータ

$post_id
整数) (必須) 投稿 ID
初期値: 0
$terms
文字列|配列) (オプション) タームのリスト。配列またはコンマ区切りの文字列。カテゴリーのように階層のあるタームを入れるには、ID を使う。タグのように階層のないタームを追加するには、名前を使う。
初期値: array
$taxonomy
文字列) (オプション) タームを関連づけるコンテキストであるタクソノミー。例: 'category', 'post_tag', 'taxonomy slug'
初期値: post_tag
$append
真偽値) (オプション) true ならタームが投稿に追加されます。false なら既存のタームを置き換えます。
初期値: false

戻り値

(配列|真偽値|WP_Error|文字列) 
  • (配列) 成功した場合、変更されたタームの配列。
  • (真偽値) $post_id が整数でなかった場合、false (if ( ! (int) $post_id )) を返す。
  • (WP_Error) 無効なタクソノミーの場合、WordPress Error オブジェクト('invalid_taxonomy')。
  • (文字列) $terms パラメータに指定されたタームの何れかが誤って名付けられていた場合、最初の無効なターム(ただし、無効なターム ID は受け入れられ、挿入されます)。

フック

情報募集中 クリエイティブな例を求めています。外部サイトへのリンクでも構いません。 該当部分を編集するか、このページのノートまたはフォーラム等で教えてください。


参考

階層のあるターム(カテゴリーなど)の場合、ターム名ではなく ID を指定してください。 同じ名前で親が違うタームとの混同を避けるためです。

次のようにしてターム ID を取得できます:

$term_id = term_exists( $term, $taxonomy, $parent );

さらに、パラメータを参照渡しする必要があるかもしれません:

wp_set_post_terms( $post_id, $term, &$taxonomy );

階層のないターム(タグなど)の場合、タームの名前または ID を指定します。 ID を指定するときは一つだけ注意してください: 必ず整数として、そして必ず配列に入れなければなりません。 配列ではない値は(自動的に)文字列に変換され、(ID ではなく)ターム名だと解釈されるためです。

$tag = '5'; // 誤り。「名前」が '5' であるタグが付く。
$tag = 5; // 誤り。これも名前が '5' であるタグが付く。
$tag = array( '5' ); // 誤り。これでも ID ではなくタームの名前だと解釈される。

$tag = array( 5 ); // 正しい。これで ID が 5 のタグが付く。
wp_set_post_terms( $post_id, $tag, $taxonomy );
  • この関数は標準の投稿タイプに対してのみ使えます。カスタム投稿タイプにタクソノミー(ターム)を付けるには wp_set_object_terms() を使用してください。

改訂履歴

  • 2.8.0 にて導入されました。

ソースファイル

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

タームタグ: is_term(), term_exists(), get_objects_in_term(), get_term(), get_term_by(), get_term_children(), get_term_link(), get_terms(), get_the_terms(), get_the_term_list(), has_term(), sanitize_term(), the_terms(), get_object_taxonomies() is_object_in_taxonomy() the_taxonomies() wp_get_object_terms(), wp_set_object_terms(), wp_get_post_terms(), wp_set_post_terms(), wp_delete_object_term_relationships()


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


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