wp_set_post_categories

説明

mixed wp_set_post_categories( [ int $post_ID = 0 [ , array $post_categories = array() ] ] )
投稿情報にカテゴリーを設定する。

パラメータ

  • $post_ID
    投稿IDを指定(省略時は0)。
  • $post_categories
    カテゴリーIDを配列で指定(省略時はarray())。

返り値

設定したカテゴリーIDの配列を返す。設定できなかった場合は、エラー内容を示す WP_Errorのオブジェクトを返す。

注意

指定したカテゴリーは投稿記事に設定された既存のカテゴリーをまるごと置き換えられる。追加したい場合は wp_set_object_terms関数を使用する。

なおパラメータ$post_categoriesにarray( '' )が指定された場合は、カテゴリーの設定は行わずにtrueを返す。

[5.5.0]'default_category_post_types'フィルターが追加され、カスタム投稿タイプの投稿情報にデフォルトカテゴリーが適用できるようになった。


使用例

  • 投稿IDが100の投稿記事にカテゴリーIDが3のカテゴリーを設定する。
    <?php wp_set_post_categories( 100, array( 3 ) ); ?>

フィルター

[5.5.0]本関数のパラメータ$post_categoriesが空の場合に'default_category_post_types'フィルターを呼び出す。パラメータ$post_typesは空の配列が格納されている。
$default_category_post_types = apply_filters( 'default_category_post_types', $post_types );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/post.php

最終更新 : 2020年08月20日 15:42



お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

4.2で始まるiOSの絵文字ケア(2018年5月27日 更新)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。(2024年11月13日 更新)

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア(Clear Unknown Formatting)」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。