wp_update_term() 関数の概要
wp_update_term()
関数は、WordPressのデータベースにおいて既存のターム(用語)の情報を更新するための関数です。この関数を使用することで、指定したタームIDに対してターム名、スラッグ、説明、親タームなどの情報を更新することができます。カテゴリ、タグ、カスタムタクソノミーなどのタームを更新する際に便利です。
パラメータの説明
wp_update_term()
関数には、以下のパラメータを設定することができます:
$term_id
(int) – 必須: 更新するタームのIDを指定します。例:123
$taxonomy
(string) – 必須: タームが属するタクソノミーの名前を指定します。例:'category'
$args
(array) – オプション: タームの更新情報を指定するための連想配列。以下のキーを含むことができます:name
(string): 新しいタームの名前。例:'Updated Term Name'
slug
(string): 新しいタームのスラッグ。例:'updated-term-slug'
description
(string): 新しいタームの説明。例:'This is the updated description for the term.'
parent
(int): 新しい親タームのID。例:0
(トップレベルのタームとして設定)
戻り値
成功した場合、wp_update_term()
関数は以下の形式の配列を返します:
array(
'term_id' => 123,
'term_taxonomy_id' => 456
)
失敗した場合、WP_Error
オブジェクトが返され、エラーメッセージを取得することができます。
使用例
以下は、wp_update_term()
関数を使用して既存のカテゴリタームを更新する例です:
<?php
$term_id = 123; // 更新するタームのID
$taxonomy = 'category'; // タクソノミーの名前
$args = array(
'name' => 'Updated Category Name',
'slug' => 'updated-category-slug',
'description' => 'This is the updated description for the category.',
'parent' => 0
);
$result = wp_update_term($term_id, $taxonomy, $args);
if (!is_wp_error($result)) {
echo 'タームが正常に更新されました。タームID: ' . $result['term_id'] . '、タームタクソノミーID: ' . $result['term_taxonomy_id'];
} else {
echo 'タームの更新に失敗しました: ' . $result->get_error_message();
}
?>
この例では、IDが123の既存のカテゴリタームを更新し、成功した場合はタームIDとタームタクソノミーIDを表示します。
エラーハンドリング
wp_update_term()
関数の実行に失敗した場合、WP_Error
オブジェクトが返されます。エラーメッセージを取得するには、以下のようにします:
<?php
if (is_wp_error($result)) {
echo 'エラー: ' . $result->get_error_message();
}
?>
関連する関数
wp_insert_term()
: タームを作成または更新するための関数です。wp_create_term()
: タームを作成するための関数です。wp_insert_term()
とほぼ同じ機能を持ちますが、オプション引数の構造が異なります。get_term()
: 特定のターム情報を取得するための関数です。get_terms()
: 特定のタクソノミー内のターム一覧を取得するための関数です。wp_delete_term()
: タームを削除するための関数です。