wp_insert_category()

wp_insert_category() 関数の概要

wp_insert_category()関数は、WordPressのデータベースに新しいカテゴリを作成したり、既存のカテゴリを更新するための関数です。この関数を使用することで、カテゴリ名、スラッグ、説明、親カテゴリなど、詳細な設定を行いながらカテゴリを挿入または更新することができます。テーマやプラグインの開発時に、初期設定としてカテゴリを自動生成する場合や、既存のカテゴリ情報をプログラム的に更新する場合に便利です。

パラメータの説明

wp_insert_category()関数には、以下のパラメータを設定することができます:

  • $catarr (array) – 必須: カテゴリの情報を含む連想配列。以下のキーを含むことができます:
  • cat_ID (int): 更新するカテゴリのID。新規作成の場合は省略可能。
  • cat_name (string): カテゴリの名前。
  • category_description (string): カテゴリの説明。
  • category_nicename (string): カテゴリのスラッグ。指定しない場合、カテゴリ名から自動生成されます。
  • category_parent (int): 親カテゴリのID。デフォルトは0で、トップレベルのカテゴリとして作成されます.

使用例

以下は、wp_insert_category()関数を使用して新しいカテゴリを作成する例です:

<?php
$category_data = array(
    'cat_name' => 'New Category',
    'category_description' => 'This is a description for the new category.',
    'category_nicename' => 'new-category',
    'category_parent' => 0
);

$category_id = wp_insert_category($category_data);

if (!is_wp_error($category_id)) {
    echo 'カテゴリが正常に作成されました。ID: ' . $category_id;
} else {
    echo 'カテゴリの作成に失敗しました: ' . $category_id->get_error_message();
}
?>

この例では、”New Category”という名前のカテゴリを作成し、成功した場合はカテゴリIDを出力します。

関連する関数

  • get_categories(): 既存のカテゴリ一覧を取得するための関数です。
  • wp_create_category(): よりシンプルに新しいカテゴリを作成するための関数です。
  • wp_delete_category(): カテゴリを削除するための関数です。
  • get_category(): 特定のカテゴリ情報を取得するための関数です。