説明
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
関連
お勧め
任意の名前でエラーログファイルを指定する(2019年2月15日 更新)
来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。
Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
Slightly troublesome permalink:プラグイン作ってみました(2021年4月20日 更新)
カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)
WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。テキストエディタの文字を変更する(2018年5月27日 更新)
テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。