wp_update_term() の使い方|説明・引数・注意点

説明

wp_update_term() は、既存のタームを更新する関数です。

基本構文

wp_update_term( int $term_id, string $taxonomy, array $args = array() ): array|WP_Error

引数

  • $term_id:タームID
  • $taxonomy:タクソノミー名
  • $args:更新する項目(name、slug、description など)

戻り値

term_id を含む配列。失敗時は WP_Error。

使い方(サンプル)

wp_update_term( 5, 'category', array( 'name' => '新しい名前' ) );

注意点

  • 指定しなかった項目は変更されません。

実務での使いどころ

  • タームの名前や、スラッグ、説明を、プログラムから変更するとき。

よくあるミスと対処

  • $taxonomy を指定していない。
  • 戻り値が WP_Error のときを、考えていない。
  • スラッグを変更し、アーカイブページのURLが変わる。検索エンジンやリンクに、影響する。

NG例

wp_update_term( $term_id, 'news_cat', array( 'slug' => 'new-slug' ) ); // URL が変わることを、考えていない

OK例

$result = wp_update_term( $term_id, 'news_cat', array( 'name' => '新しい名前' ) );
if ( is_wp_error( $result ) ) {
	return;
}

使い分け早見表

やりたいこと 使うもの
タームを更新する wp_update_term()
タームを作る wp_insert_term()
タームを削除する wp_delete_term()

関連項目

wp_insert_term()、wp_delete_term()

公式リファレンス:wp_update_term() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました