概要
wp_set_comment_status関数は、指定したコメントのステータスを設定するための関数です。この関数は、コメントの管理や状態変更の自動化を行う際に頻繁に使用されます。たとえば、新しいコメントを公開したり、スパムとしてマークしたりする際に利用されます。具体的には以下の機能実装に使用されることが多いです。
- コメントの承認
- コメントの非表示設定（スパム化）
- コメントの再公開
- コメントの保留状態の管理
- コメント投稿時のフック処理
- ユーザーに対する通知のトリガー
- コメントの履歴管理
- コメントに対する自動応答機能の統合
構文
wp_set_comment_status( $comment_id, $status );
パラメータ
$comment_id(int) — ステータスを設定したいコメントのID。$status(string) — 設定したいコメントのステータス（例：”approved”, “hold”, “spam”, “trash”など）。
戻り値
- 成功した場合は
true、失敗した場合はfalseを返します。
関連する関数
使用可能なバージョン
この関数は、WordPress 1.5.0以降で使用可能です。
コアファイルのパス
この関数は、wp-includes/comment.php ファイルに含まれています。
サンプルコード
サンプルコード1: コメントを承認する
// コメントのIDが123の場合、そのコメントを承認する
$comment_id = 123;
$result = wp_set_comment_status( $comment_id, 'approved' );
if ( $result ) {
echo 'コメントが承認されました。';
}
説明: これは特定のコメントを承認するためのコードです。
サンプルコード2: スパムとしてコメントをマークする
// コメントのIDが456の場合、そのコメントをスパムとしてマークする
$comment_id = 456;
$result = wp_set_comment_status( $comment_id, 'spam' );
if ( $result ) {
echo 'コメントがスパムとしてマークされました。';
}
説明: これはスパムとして特定のコメントを設定するためのコードです。
サンプルコード3: コメントを保留状態にする
// コメントのIDが789の場合、そのコメントを保留状態にする
$comment_id = 789;
$result = wp_set_comment_status( $comment_id, 'hold' );
if ( $result ) {
echo 'コメントが保留状態になりました。';
}
説明: こちらはコメントを保留状態にするためのコードサンプルです。
サンプルコード4: コメントをゴミ箱に移動する
// コメントのIDが321の場合、そのコメントをゴミ箱に移動する
$comment_id = 321;
$result = wp_set_comment_status( $comment_id, 'trash' );
if ( $result ) {
echo 'コメントがゴミ箱に移動されました。';
}
説明: このコードは特定のコメントをゴミ箱に移動するためのものです。
サンプルコード5: コメント状態の確認と変更
// コメントのIDが654の場合、そのコメントの状態を確認して変更する
$comment_id = 654;
$current_status = wp_get_comment_status( $comment_id );
if ( $current_status == 'hold' ) {
wp_set_comment_status( $comment_id, 'approved' );
echo 'コメントが承認されました。';
} else {
echo 'コメントのステータスは承認できません。';
}
説明: これはコメントの現在のステータスを確認し、必要に応じて承認するコードです。
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
この関数は、特定のバージョンで非推奨または削除されることはありませんでした。