説明
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
関連
お勧め
個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)
先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。
決まった値を返すだけの関数群(2018年5月27日 更新)
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)
ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)
先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。