update_comment_meta

(2.9.0以降)
update_comment_meta - コメントメタ情報の値を更新する

説明

bool update_comment_meta( int $comment_id, string $meta_key, mixed $meta_value [ , mixed $prev_value = '' ] )
コメントメタ情報の値を更新する。

パラメータ

  • $comment_id
    コメントIDを指定。
  • $meta_key
    コメントメタ情報のキー名を指定。
  • $meta_value
    コメントメタ情報のキー名に対応する値を指定。
  • $prev_value
    コメントメタ情報のキー名に対応する前の値を指定(省略時は'')。

返り値

コメントメタ情報の値を更新した場合はtrueを、失敗した場合はfalseを返す。

注意

使い方は投稿情報のメタ情報を更新するupdate_post_meta関数と同じ。キー名で指定したコメントメタ情報が存在しない場合は追加され、すでに存在する場合はそのコメントメタ情報の値が更新される。必ずコメントメタ情報を追加する場合は、add_comment_meta関数を使用すること。

なお、同じキー名のコメントメタ情報は、パラメータ$prev_valueを指定することで、更新対象のコメントメタ情報を絞り込める。

使用例

  • コメントIDが2014で、キー名が'judge'の値として10を設定する。
    <?php update_comment_meta( 2014, 'judge', 10 ); ?>
  • コメントIDが2014で、キー名が'judge'、直前の値が9のコメントメタ情報の値を10に変更する。
    <?php update_comment_meta( 2014, 'judge', 10, 9 ); ?>

フィルター

直接実行するフィルターはありません。

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/comment.php

関連

お勧めコンテンツ

プラグインのヘッダー情報を国際化対応しよう(2017年6月19日 登録)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。

Slightly troublesome permalink:プラグイン作ってみました(2012年2月9日 登録)

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

管理画面の'アイキャッチ画像'を'写真'に変える(2013年1月23日 登録)

クライアント向けに専用のテーマを提供する際、稀に管理画面内の用語の変更を依頼されることがある。今回は、'アイキャッチ画像'だとわかりにくいので'写真'に変えてほしいということだった。

公式ディレクトリに登録するならajax.googleapis.comのライブラリは利用しない(2015年3月15日 登録)

数日前、投稿一覧ページの絞り込みドロップダウンメニューを複数選択可能にするプラグイン「Posts filter multiselect」を公開したのですが、その際に指摘されたポイントを紹介します。

管理画面でツールバー(Admin bar)を非表示にする(2013年3月5日 登録)

WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。

最終更新日時 : 2014-03-09 12:54