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



お勧め

ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた(2019年11月5日 更新)

管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。

headタグのmeta(generator)タグを取り除く(2018年5月27日 更新)

標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。
<meta name="generator" content="WordPress 3.0.5" />

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。

5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。