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



お勧め

投稿記事でrubyタグを使えるようにする(前編)(2012年1月25日 更新)

rubyなどのルビ関連タグはIEの独自サポートから始まり、少し前のChrome/Safariが追随して利用できるようになっている。Firefoxはいまだにサポートしていないのだが、それなりに代替表示されるので、投稿記事で使えるようにしてみた。

CSSやJavaScriptファイルのバージョン番号を変える(2017年3月14日 更新)

WordPress 4.7系の脆弱性をついた攻撃も落ち着いた感じなので、標準でヘッダーやフッター内に出力されるWordPressのバージョン番号について一考しました。

投稿日の検索が自由自在に(2015年3月7日 更新)

WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス(もちろん query_posts関数でも)で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。

絵文字画像がPNGからSVGへ(2016年8月30日 更新)

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

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

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