wp_set_comment_status

説明

mixed wp_set_comment_status( int $comment_id, string $comment_status [ , bool $wp_error = false ] )
コメントのステータスを設定する。

パラメータ

  • $comment_id
    コメントIDを指定。
  • $comment_status
    ステータス('hold'(または'0')、'approve'(または'1')、'spam'、'trash')を指定。
  • $wp_error
    エラー時に WP_Errorオブジェクトを返す場合はtrue、falseを返す場合はfalseを指定(省略時はfalse)。

返り値

ステータスを設定できた場合はtrueを返す。パラメータ$comment_statusが無効なステータスか、ステータスを設定できずパラメータ$wp_errorがfalseの場合はfalseを、$wp_errorがtrueの場合はエラー理由をWP_Errorオブジェクトで返す。

注意

ステータス'hold'は'0'のエイリアス、'approve'は'1'のエイリアスである。

使用例

  • コメントIDが102のステータスを'approve'とする。
    <?php $result = wp_set_comment_status( 102, 'approve' ); ?>
  • コメントIDが102のステータスを'spam'とする(エラー時はWP_Errorオブジェクトで取得)。
    <?php $result = wp_set_comment_status( 102, 'spam', true ); ?>

フィルター

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

アクション

ステータスの変更後、'wp_set_comment_status'アクションを呼び出す。$comment_id$comment_statusには同名のパラメータの値が格納される。
do_action( 'wp_set_comment_status', $comment_id, $comment_status );

ソースファイル

/wp-includes/comment.php

最終更新 : 2013年09月06日 16:02



お勧め

Somewhere search box:プラグイン作ってみました(2018年5月8日 更新)

投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容(本文、カテゴリーや投稿タグ、カスタムフィールド)を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

get_postsとquery_postsを使い分け(2018年5月27日 更新)

get_posts query_postsは、どちらも複数の投稿情報を取得することができる便利な関数である。パラメータとして指定できる内容も共通しているものが多く、query_postsがより詳細なパラメータを指定でき、高機能になっている。

絵文字画像がPNGからSVGへ(2018年5月27日 更新)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。

使っていないか確認しないとね!(2017年11月18日 更新)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.9.0現在、廃止予定となっている関数をまとめて紹介する。