概要
delete_term_meta関数は、タームのメタ情報を削除するための関数です。この関数は、特定のタームに関連付けられた追加情報が不要になった時に使用されます。よくこの関数を実装する際に使われる機能には以下のようなものがあります。
- カスタムタクソノミーのメタデータ管理
- ターム情報のクリーニング
- タームに関連する設定のリセット
- プラグインでのカスタムメタ情報削除
- バルク操作によるタームメタの一括削除
- ライフサイクルイベントに基づくメタデータの削除
- 誤って追加されたメタデータの削除
- タームの権限管理に関するメタデータの削除
構文
delete_term_meta( int $term_id, string $meta_key, mixed $meta_value = '' )
パラメータ
term_id(int): 削除したいメタ情報が関連付けられているタームのID。meta_key(string): 削除したいメタ情報のキー。meta_value(mixed): （オプション）削除するメタ情報の値。指定しない場合、指定したキーのすべての値を削除される。
戻り値
- 成功した場合は、
trueを返します。失敗した場合は、falseを返します。
関連する関数
使用可能なバージョン
- WordPress 4.4以降
コアファイルのパス
wp-includes/taxonomy.php
サンプルコード
以下に、delete_term_meta関数を使用したサンプルコードを5点示します。
-
特定のタームからメタデータを削除
// タームID 5 の 'example_meta' メタを削除 $result = delete_term_meta( 5, 'example_meta' ); if ( $result ) { echo "メタデータが削除されました。"; } else { echo "メタデータの削除に失敗しました。"; }このサンプルコードは、タームID 5の
example_metaというメタデータを削除するものです。 -
特定の値のメタデータを削除
// タームID 3 の 'color' メタから 'red' の値を削除 $result = delete_term_meta( 3, 'color', 'red' ); if ( $result ) { echo "メタデータ (カラー: red) が削除されました。"; }ここでは、タームID 3に対して
colorメタの値がredであるものを削除する例です。 -
複数のメタデータを削除する
// 複数のメタデータを削除 $metas = ['meta_one', 'meta_two', 'meta_three']; foreach ($metas as $meta) { delete_term_meta( 10, $meta ); } echo "タームID 10 からメタデータを削除しました。";この例では、タームID 10から複数のメタデータを削除する方法を示しています。
-
削除結果を判定してメッセージを表示
// 特定のタームメタの削除結果によってメッセージを変更 $deleted = delete_term_meta( 12, 'status' ); echo $deleted ? "メタデータが削除されました。" : "削除するメタデータが存在しません。";このサンプルは、削除が成功したかどうかに基づいて異なるメッセージを出力します。
-
条件に基づいてメタデータを削除
// タームID 4 のメタ情報値に基づいて削除 $existing_meta = get_term_meta( 4, 'visibility', true ); if ($existing_meta === 'private') { delete_term_meta( 4, 'visibility' ); echo "タームの可視性メタが削除されました。"; }タームID 4の
visibilityメタがprivateである場合に削除する例です。
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
特定のバージョンで非推奨又は削除された場合はありません。