delete_metadata

説明

bool delete_metadata( string $meta_type, int $object_id, string $meta_key [ , mixed $meta_value = '' [ , bool $delete_all = false ] ] )
メタ情報の値を削除する。

パラメータ

  • $meta_type
    メタ情報タイプ('comment'、'post'、'user')を指定。
  • $object_id
    メタ情報タイプで指定した情報のID(コメントID、投稿ID、ユーザID)を指定。
  • $meta_key
    メタ情報のキー名を指定。
  • $meta_value
    メタ情報のキー名に対応する値を指定(省略時は'')。
  • $delete_all
    すべてのメタ情報のキー名の値を削除する場合はtrueを指定(省略時はfalse)。

返り値

メタ情報の値を削除した場合はtrueを、失敗した場合はfalseを返す。

注意

delete_post_meta関数や delete_comment_meta関数の下位関数で、個別のメタ情報だけでなく、同じキー名のメタ情報を一括して削除することができる(パラメータ$delete_allがtrueの場合は、$object_idは無視される)。


使用例

  • キー名が'judge'のコメントメタ情報を削除する。
    <?php delete_metadata( 'comment', 0, 'judge', '', true ); ?>

フィルター

メタ情報を削除する前に"delete_{$meta_type}_metadata"(例: delete_comment_metadata)フィルターを呼び出す。各パラメータは本関数が受け取ったパラメータの値で、falseを返すことで削除は行われない。
$check = apply_filters( "delete_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $delete_all );

アクション

削除対象のメタ情報を検索した後で"delete_{$meta_type}_meta"(例: delete_comment_meta)アクションを呼び出す。パラメータ$meta_idsには削除対象のメタ情報IDを格納した配列が、その他のパラメータは本関数が受け取ったパラメータとなる。
do_action( "delete_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );
パラメータ$meta_typeが'post'の場合のみ、削除対象のメタ情報を検索した後で"delete_postmeta"アクションを呼び出す(旧スタイル)。パラメータ$meta_idsには削除対象のメタ情報IDを格納した配列となる。
do_action( 'delete_postmeta', $meta_ids );
メタ情報を削除した後で"deleted_{$meta_type}_meta"(例: deleted_comment_meta)アクションを呼び出す。パラメータ$meta_idsには削除したメタ情報IDを格納した配列が、その他のパラメータは本関数が受け取ったパラメータとなる。
do_action( "deleted_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );
パラメータ$meta_typeが'post'の場合のみ、削除対象のメタ情報を検索した後で"delete_postmeta"アクションを呼び出す(旧スタイル)。パラメータ$meta_idsには削除したメタ情報IDを格納した配列となる。
do_action( 'deleted_postmeta', $meta_ids );

ソースファイル

/wp-includes/meta.php

最終更新 : 2016年02月23日 15:48



お勧め

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

the_date関数で投稿日を確実に表示する(2011年12月20日 更新)

投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

さくらのVPSでKUSANAGI(2018年5月27日 更新)

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

絵文字画像がPNGからSVGへ(2018年5月27日 更新)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。