説明
パラメータ
- $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 );
do_action( 'delete_postmeta', $meta_ids );
do_action( "deleted_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );
do_action( 'deleted_postmeta', $meta_ids );
ソースファイル
/wp-includes/meta.php最終更新 : 2016年02月23日 15:48
関連
お勧め
wp_titleからwp_get_document_titleへ(2018年5月27日 更新)
先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。
ツイート引用が簡単になる仕組み(2012年6月8日 更新)
WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)
WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。
サイトヘルス機能を使ってみた(2019年4月12日 更新)
先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2(以降5.2Beta2)が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。
ブロックエディターで編集したページが出力した余分な改行を削除(2019年2月22日 更新)
ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。