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

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

関数リファレンス/wp set post categories

提供: WordPress Codex 日本語版
< 関数リファレンス
2014年8月17日 (日) 23:05時点におけるGblsm (トーク | 投稿記録)による版 (関連資料)

(差分) ← 古い版 | 最新版 (差分) | 新しい版 → (差分)
移動先: 案内検索

投稿にカテゴリーを付けます。

使い方

<?php wp_set_post_categories( $post_ID, $post_categories, $append ) ?>

パラメータ

$post_ID
整数) (オプション) 投稿 ID
初期値: 0
$post_categories
配列) (オプション) カテゴリー ID の配列。
初期値: array
$append
真偽値) (オプション) true ならカテゴリーが投稿へ追加される。false なら指定したカテゴリーが既存のカテゴリーを置き換えて投稿に付けられる。
初期値: false

戻り値

(真偽値|mixed)
投稿に付けられたカテゴリーの ID の配列を返す。失敗すると WP_Error または false を返す。

用例

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


参考

  • カテゴリーを指定せず、投稿タイプが post である投稿の ID を指定すると、デフォルトのカテゴリーが使われます。
  • 注意$append を true にしないと、wp_set_post_categories は投稿に以前から付いていたカテゴリーを消して(上書きして)しまいます。
  • 有効なカテゴリーのものではない ID を配列に入れて指定すると、それはオブジェクトのターム(投稿のカテゴリー)を更新する前に取り除かれて、戻り値の配列に含まれません。
  • wp_set_object_terms() は同じ機能を実行しますが、WordPress 組み込みのカテゴリーに対してもっと詳細な制御を行うことができます。またカスタム分類に対しても使うことができます。

変更履歴

バージョン 2.1.0 から導入されました。

ソースファイル

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

wp_set_object_terms(), wp_set_post_tags(), wp_set_post_terms()

カテゴリータグ: the_category(), the_category_rss(), single_cat_title(), category_description(), wp_dropdown_categories(), wp_list_categories(), get_the_category(), get_the_category_by_ID(), get_category_by_slug(), get_the_category_list(), get_category_parents(), get_category_link(), is_category(), in_category()


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


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