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

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

関数リファレンス/delete metadata

提供: WordPress Codex 日本語版
移動先: 案内検索

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

指定されたオブジェクトのメタデータを削除します。

使い方

<?php delete_metadata ( $meta_type, $object_id, $meta_key, $meta_value, $delete_all ) ?>

パラメータ

$meta_type
文字列) (必須) メタデータがついたオブジェクトの種類(例えばコメントなら 'comment'、投稿なら 'post'、ユーザーなら 'user')。
初期値: なし
$object_id
整数) (必須) メタデータがついたオブジェクトの ID。
初期値: なし
$meta_key
文字列) (必須) メタデータのキー。
初期値: なし
$meta_value
文字列) (オプション) メタデータの値。スカラー値でないときはシリアル化しなければならない。指定するとその値を持ったメタデータのエントリーだけを削除する。指定しなければキーが $meta_key であるすべてのエントリーを削除する。nullfalse または空の文字列を指定すると、このチェックは行わない。注意: 後方互換性のため、空の文字列を渡して値が空の文字列であるエントリーを削除することはできない。
初期値: ''
$delete_all
真偽値) (オプション) true を指定すると、$object_id の指定を無視してすべてのオブジェクトからマッチしたメタデータのエントリーを削除する。false なら指定された $object_id のマッチしたメタデータのエントリーを削除する。
初期値: false

戻り値

(真偽値) 
削除に成功すると true、失敗すると false。

参考

  • 値を削除する前に 'delete_{$meta_type}_meta' アクションを呼び出します。引数は削除するメタデータのエントリーの meta_id$object_id$meta_key$meta_value です。
  • 値を削除した後に 'deleted_{$meta_type}_meta' アクションを呼び出します。引数は削除されたメタデータのエントリーの meta_id$object_id$meta_key$meta_value です。

変更履歴

新規導入: 2.9

ソースファイル

delete_metadata() は wp-includes/meta.php にあります。

メタデータ API: add_metadata(), get_metadata() /en, update_metadata() /en, delete_metadata() /en


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


最新英語版: WordPress Codex » Function_Reference/delete_metadata最新版との差分