wp_set_comment_status

（1.0.0以降）
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

参考

Code Reference: wp_set_comment_status

お勧め

ログインページのタイトルを変更してみる（2018年5月27日更新）

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう（2011年12月8日更新）

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

meta_compare_key使ってみた（2019年3月19日更新）

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。

各種リンクを取得する関数一覧（2014年6月12日更新）

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク（パーマリンク）を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

昨年投稿した「ログインページを変える」をプラグイン化。ログインページを独自の名前のページ変更し、標準のログインページwp-login.phpを使用できないようにするプラグインです。部外者によるwp-login.phpのアクセスにお悩みの方にお勧めします。また2.0.0では「XML-RPCリクエストの管理機能」を追加。2.2.0では管理者のログイン時にメールで通知する機能を追加しました。