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



お勧め

リクエスト応答を終了する前に何かを処理する(2013年9月26日 更新)

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

「投稿に挿入」時のタグをちょっとカスタマイズ(2011年7月29日 更新)

投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される(キャプションを指定した場合はタグも)。それらの画像をLightBox(JavaScriptライブラリ)で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。

投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)

WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。

標準で使用できる数少ないショートコード[caption]とは(2018年5月27日 更新)

画像をアップロードして「投稿に追加」ボタンをクリックすると、投稿記事内にリンク付きのimgタグか、ショートコードのが挿入される。ここではそれらの書式を整理する。

使っていないか確認しないとね!(2017年11月18日 更新)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.9.0現在、廃止予定となっている関数をまとめて紹介する。