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



お勧め

3.6リリース直前チェック(2013年7月26日 更新)

$wpdbは、WordPressのデータベースにアクセスする際に使用できる便利なオブジェクト。独自テーブルの利用やデータ検索の最適化など、標準提供される関数では実現できないことを手助けしてくれる。そんな$wpdbのescapeメソッドが3.6で非推奨(deprecated)になる。

投稿ページにキーワード検索ウィジェットを追加する(2012年6月2日 更新)

「投稿の編集」ページで記事を編集していると、関連する投稿記事を検索したくなることがある。そんな時、「投稿一覧」ページに戻って「キーワード検索」を行えばいいのだが、そのひと手間がちょっとだけ煩わしい。

4.2の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2018年5月27日 更新)

ダッシュボードの「アクティビティ」ウィジェットは「投稿(post)」の状況を表示し、固定ページ(page)やカスタム投稿タイプの投稿記事の状況については標準では表示されない。このことに対して以前『3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する』を紹介したのだが、4.2では新しいフィルターが追加され、カスタマイズが少し容易になった。

スマートフォン向けの振り分けを自前で行う(2012年1月23日 更新)

PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。