• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/wp update term

提供: WordPress Codex 日本語版
< 関数リファレンス
2015年6月21日 (日) 15:31時点におけるGblsm (トーク | 投稿記録)による版 (和訳しました。)

(差分) ← 古い版 | 最新版 (差分) | 新しい版 → (差分)
移動先: 案内検索

この項目「関数リファレンス/wp update term」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

指定された引数に従ってタームを更新します。

使い方

<?php wp_update_term( $term_id, $taxonomy, $args ) ?>

パラメータ

$term_id
整数) (必須) タームの ID
初期値: なし
$taxonomy
文字列) (必須) タクソノミー。タームをオブジェクトへ関連付けるコンテキスト。
初期値: なし
$args
配列) (オプション) タームのフィールドを上書きする値。
初期値: なし

戻り値

(配列|WP_Error) 
ターム ID とターム・タクソノミー ID(配列形式)。または WP_Error オブジェクト。

用例

「未分類」カテゴリーをフランス語に変更

<?php
wp_update_term( 1, 'category', array(
  'name' => 'Non Catégorisé',
  'slug' => 'non-categorise'
) );
?>

参考

$args は同じフィールド名があればどんな値でも無条件に上書きします。 重要な情報を上書きしないように注意してください。万一上書きすると、更新が失敗します(または、おそらく新しいタームが作られますが、いずれにせよ望ましくないでしょう)。

'alias_of', 'description', 'parent', 'slug' が $args になければデフォルト値がセットされます。

'alias_of' はタームのグループを(まだ存在しなければ)作り、$term が含まれるように更新します。

$args に 'slug' 引数がなければ、代わりに $args の 'name' が使われます。指定した 'slug' がユニークでない場合、WP_Error が返されることに注意してください。もしスラッグをまったく指定しなければ、ユニークなものが自動的に作られます。

$args で上書きできるものについては、タームのデータ構造を確かめてください。そしてタームのキーは避けてください。

$args に指定できるタームオブジェクトのフィールド:

  • term_id
  • name
  • slug
  • term_group
  • term_taxonomy_id
  • taxonomy
  • description
  • parent
  • count

変更履歴

2.3.0 : 新規導入

ソースファイル

wp_update_term()wp-includes/taxonomy.php にあります。

wp_insert_term

関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/wp_update_term最新版との差分