wp_delete_term() 関数の概要
wp_delete_term()関数は、WordPressのデータベースから特定のターム（用語）を削除するための関数です。この関数を使用することで、指定したタームIDとタクソノミーに基づいてタームを削除することができます。カテゴリ、タグ、カスタムタクソノミーなどのタームを削除する際に便利です。タームを削除すると、そのタームに関連付けられた投稿は「未分類」や他のタームに再分類される場合があります。
パラメータの説明
wp_delete_term()関数には、以下のパラメータを設定することができます：
$term(int) – 必須: 削除するタームのIDを指定します。例:123$taxonomy(string) – 必須: タームが属するタクソノミーの名前を指定します。例:'category'$args(array|string) – オプション: タームの削除に関する追加オプションを指定するための配列またはクエリ文字列。以下のキーを含むことができます：default(int): タームを削除した後に、そのタームに関連付けられた投稿を再分類するタームのIDを指定します。
戻り値
成功した場合、wp_delete_term()関数は true を返します。
失敗した場合、WP_Errorオブジェクトが返され、エラーメッセージを取得することができます。
使用例
以下は、wp_delete_term()関数を使用して特定のカテゴリタームを削除する例です：
<?php
$term_id = 123; // 削除するタームのID
$taxonomy = 'category'; // タクソノミーの名前
$result = wp_delete_term($term_id, $taxonomy);
if (!is_wp_error($result) && $result) {
echo 'タームが正常に削除されました。';
} else {
echo 'タームの削除に失敗しました: ' . $result->get_error_message();
}
?>この例では、IDが123のカテゴリタームを削除し、成功した場合は削除成功のメッセージを表示します。
エラーハンドリング
wp_delete_term()関数の実行に失敗した場合、WP_Errorオブジェクトが返されます。エラーメッセージを取得するには、以下のようにします：
<?php
if (is_wp_error($result)) {
echo 'エラー: ' . $result->get_error_message();
}
?>関連する関数
wp_insert_term(): タームを作成または更新するための関数です。wp_create_term(): タームを作成するための関数です。wp_insert_term()とほぼ同じ機能を持ちますが、オプション引数の構造が異なります。wp_update_term(): 既存のタームを更新するための関数です。get_term(): 特定のターム情報を取得するための関数です。get_terms(): 特定のタクソノミー内のターム一覧を取得するための関数です。
