関数リファレンス/wp insert category

説明

新しいカテゴリーを一つ登録します（タクソノミーシステムへ追加します）。

使い方

<?php wp_insert_category( $catarr, $wp_error ); ?>

パラメータ

$catarr

（配列） （必須） カテゴリーの情報。

初期値： なし

$catarr は下記のデフォルト値を持つものとしてチェックされます：

$cat_defaults = array(
  'cat_ID' => 0,
  'cat_name' => ,
  'category_description' => ,
  'category_nicename' => ,
  'category_parent' => ,
  'taxonomy' => 'category' );

$catarr に他の値を含めることもできますが、少なくとも $cat_defaults に示した最小限の値を指定することを推奨します。category_parent はカテゴリー ID であることに注意してください。

$wp_error

（真偽値） （オプション） 失敗したときに WP_Error を返すかどうか。デフォルト（false）は真偽値を返す。

初期値： false

戻り値

(真偽値 | WP_Error | 整数) 

失敗した場合、$wp_error が false なら false を、true なら WP_Error オブジェクトを返す。成功した場合、新しいカテゴリーのカテゴリー ID を返す。

用例

新しいカテゴリーを追加するには下記のコードを使います：

// カテゴリーを定義
$my_cat = array(
    'cat_name' => '私のカテゴリー', 
    'category_description' => '格好いいカテゴリー', 
    'category_nicename' => 'category-slug', 
    'category_parent' => '' );

// カテゴリーを作成
$my_cat_id = wp_insert_category( $my_cat );

参考

• このページは $catarr に指定可能なすべてのメンバーを示していません。
• wp_create_category() は、配列の代わりに文字列の指定で済むシンプルなバージョンです。

変更履歴

バージョン 2.0.0 にて導入されました。

ソースファイル

wp_insert_category() は wp-admin/includes/taxonomy.php にあります。

関連資料

カテゴリータグ： 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() , wp_create_category()

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

最新英語版： WordPress Codex » Function_Reference/wp_insert_category （最新版との差分）