wp_create_term()

wp_create_term() 関数の概要

wp_create_term()関数は、WordPressのデータベースに新しいターム(用語)を作成するための関数です。この関数を使用することで、指定したタクソノミーに新しいタームをプログラム的に追加することができます。カテゴリ、タグ、カスタムタクソノミーなどに対して新しいタームを作成する際に便利です。ターム名やスラッグ、説明、親タームなどの情報を設定することができます。

パラメータの説明

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

  • $term (string) – 必須: 作成するタームの名前を指定します。例: 'My New Term'
  • $taxonomy (string) – 必須: タームが属するタクソノミーの名前を指定します。例: 'category'
  • $args (array|string) – オプション: タームの追加情報を指定するための配列またはクエリ文字列。以下のキーを含むことができます:
  • slug (string): タームのスラッグを指定します。指定しない場合、ターム名から自動生成されます。例: 'my-new-term'
  • description (string): タームの説明を指定します。例: 'This is a description for the new term.'
  • parent (int): 親タームのIDを指定します。例: 0(トップレベルのタームとして作成)

戻り値

成功した場合、wp_create_term()関数は以下の形式の配列を返します:

array(
    'term_id' => 123,
    'term_taxonomy_id' => 456
)

失敗した場合、WP_Errorオブジェクトが返され、エラーメッセージを取得することができます。

使用例

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

<?php
$term_name = 'New Category'; // 作成するタームの名前
$taxonomy = 'category'; // タクソノミーの名前
$args = array(
    'description' => 'This is a description for the new category.',
    'slug'        => 'new-category',
    'parent'      => 0
);

$result = wp_create_term($term_name, $taxonomy, $args);

if (!is_wp_error($result)) {
    echo 'タームが正常に作成されました。タームID: ' . $result['term_id'] . '、タームタクソノミーID: ' . $result['term_taxonomy_id'];
} else {
    echo 'タームの作成に失敗しました: ' . $result->get_error_message();
}
?>

この例では、”New Category”という名前のカテゴリタームを作成し、成功した場合はタームIDとタームタクソノミーIDを表示します。

エラーハンドリング

wp_create_term()関数の実行に失敗した場合、WP_Errorオブジェクトが返されます。エラーメッセージを取得するには、以下のようにします:

<?php
if (is_wp_error($result)) {
    echo 'エラー: ' . $result->get_error_message();
}
?>

関連する関数

  • wp_insert_term(): タームを作成または更新するための関数です。wp_create_term()とほぼ同じ機能を持ちますが、オプション引数の構造が異なります。
  • get_term(): 特定のターム情報を取得するための関数です。
  • get_terms(): 特定のタクソノミー内のターム一覧を取得するための関数です。
  • wp_delete_term(): タームを削除するための関数です。