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

最終更新 : 2014年03月09日 12:54



お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

4.2で始まるiOSの絵文字ケア(2018年5月27日 更新)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。(2024年11月13日 更新)

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア(Clear Unknown Formatting)」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

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

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