概要
wp_get_comment_status関数は、WordPressにおいて特定のコメントのステータスを取得するために使用される関数です。この関数は、コメントがどのような状態にあるかを調べる際に役立ちます。たとえば、コメントが承認されているか、スパムとしてマークされているか、下書き状態かどうかを確認するために使用します。この関数は、コメント管理やユーザーインターフェースの改善、データの表示の条件付け、カスタム機能の開発など、さまざまなシチュエーションで活用されます。
主に使用される機能は以下の通りです：
1. コメントの表示状態を制御するため
2. コメントの管理画面におけるフロントエンド表示のカスタマイズ
3. ユーザーインタラクションの改善
4. コメントがスパムとしてマークされているかどうかを確認
5. 特定のコメントのアクションをトリガーする条件を設定
6. コメントの承認プロセスの強化
7. テーマやプラグインでのカスタムフィルタの実装
8. カスタム通知機能の実装
構文
string wp_get_comment_status( int $comment_id )
パラメータ
comment_id（整数）：ステータスを取得したいコメントのID。
戻り値
この関数は、指定したコメントのステータスを示す文字列を返します。ステータスは、’approved’, ‘pending’, ‘spam’, ‘trash’ などの値になります。
関連する関数
使用可能なバージョン
wp_get_comment_status関数は、WordPress 2.9.0以降で使用可能です。
コアファイルのパス
この関数は、wp-includes/comment.phpファイルに含まれています。
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| 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 |
サンプルコード
サンプルコード1
$comment_id = 1;
$status = wp_get_comment_status($comment_id);
echo "コメントのステータス: " . $status;
このコードは、コメントIDが1のコメントのステータスを取得し、それを出力します。引用元: WordPress Codex
サンプルコード2
$comment_id = 2;
if (wp_get_comment_status($comment_id) === 'approved') {
echo "このコメントは承認されています。";
}
このコードは、コメントIDが2のコメントが承認されているかどうかをチェックし、承認されていればメッセージを出力します。引用元: WordPress Codex
サンプルコード3
$comment_id = 3;
$status = wp_get_comment_status($comment_id);
if ($status === 'spam') {
// スパムコメントとして処理
echo "このコメントはスパムです。";
}
このコードは、コメントIDが3のコメントがスパムかどうかを確認し、スパムであればその旨を出力します。引用元: WordPress Codex
サンプルコード4
$comments = get_comments();
foreach ($comments as $comment) {
$status = wp_get_comment_status($comment->comment_ID);
echo "コメントID: " . $comment->comment_ID . " ステータス: " . $status . "<br>";
}
このコードは、全てのコメントのステータスを取得し、各コメントのIDとともに出力します。引用元: WordPress Codex
サンプルコード5
$comment_id = 4;
$status = wp_get_comment_status($comment_id);
if ($status === 'pending') {
echo "このコメントはまだ承認されていません。";
}
このコードは、コメントIDが4のコメントが承認待ちの状態であるかを確認し、承認待ちであればその旨を出力します。引用元: WordPress Codex