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



お勧め

各種リンクを取得する関数一覧(2014年6月12日 更新)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

ログインページを変える(2014年9月12日 更新)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

Login rebuilderのログ表示機能を紹介(2018年5月27日 更新)

プラグイン「Login rebuilder」には、バージョン1.2.0からログ情報を保存・確認する機能が備わっています。このログ情報では直近のログインページへの不正アクセスやログイン試行を確認できます。ここでは保存しているログ情報の見方について簡単に説明します。

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

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

一定時間でログアウトする(2013年5月23日 更新)

ログイン関係を調べている関係で、 wp_set_auth_cookie関数に行き着く。ログイン画面の「ログイン状態を保持する」がチェックされた場合、クッキーの有効期限は14日間。チェックされていない場合は、ブラウザが閉じるまで常に有効となっているんだね。