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



お勧め

Login rebuilderに「XML-RPC設定」を追加しました(2018年5月27日 更新)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

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

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

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

5.7の新機能:HTTPからHTTPSへの移行(2021年3月13日 更新)

先週は「WordPress 5.7 Beta 2(以降Beta 2)」が公開され、正式版リリースへ一歩進みました。WordPress 5.7の注目ポイントの1つに「HTTPからHTTPSへの移行」を手助けする機能があり、それに関連する機能を含んだhttps-detection.phpファイルとhttps-migration.phpが追加されていた。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。