概要
add_comments_pageフィルタは、WordPressの管理画面でコメントのサブメニューを登録するためのフィルタです。このフィルタを利用することにより、特定の機能や設定画面をコメント管理メニューに追加することができます。これは、カスタムコメント管理オプションや追加機能を提供する際に非常に便利です。
このフィルタがよく使われる場面としては以下のような用途があります：
1. カスタムコメント設定ページの作成
2. 特定の種類のコメントを管理するためのインターフェースの追加
3. コメントのレポート機能を持つページの追加
4. コメントスパム管理ツールのインターフェース提供
5. コメント関連するデータの統計ページの作成
6. コメントフィルタリングオプションの提供
7. 他のプラグインからの統合ポイントの作成
8. ユーザー向けのヘルプやガイドページの含むインターフェースを提供
構文
add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function );
パラメータ
$page_title: サブメニューのページタイトル$menu_title: 管理メニューに表示されるタイトル$capability: このメニューを表示するために必要な権限$menu_slug: メニューのスラッグ（ユニークな識別子）$function: メニューが選択された場合に実行される関数名
戻り値
なし
関連する関数
使用可能なバージョン
add_comments_pageフィルタは、WordPress 2.7以降で使用可能です。
コアファイルのパス
wp-admin/includes/plugin.php
サンプルコード
サンプルコード 1: カスタムコメント設定ページの作成
このサンプルコードでは、管理画面のコメントメニューに「カスタム設定」というサブメニューを追加します。
add_action('admin_menu', 'my_custom_comment_settings');
function my_custom_comment_settings() {
add_comments_page('カスタム設定', 'カスタム設定', 'manage_options', 'my-custom-settings', 'my_custom_settings_page');
}
function my_custom_settings_page() {
echo '<div class="wrap"><h1>カスタムコメント設定</h1></div>';
}
サンプルコード 2: レポート機能を持つページの追加
このコードでは、「コメントレポート」というサブメニューを追加し、そこにレポートの内容を表示します。
add_action('admin_menu', 'add_comment_report_page');
function add_comment_report_page() {
add_comments_page('コメントレポート', 'コメントレポート', 'manage_options', 'comment-report', 'render_comment_report');
}
function render_comment_report() {
echo '<div class="wrap"><h1>コメントレポート</h1></div>';
}
サンプルコード 3: スパム管理ツールのページ追加
このサンプルでは、「スパム管理」というページを追加し、そのページでスパムコメントを管理します。
add_action('admin_menu', 'add_spam_management_page');
function add_spam_management_page() {
add_comments_page('スパム管理', 'スパム管理', 'manage_options', 'spam-management', 'render_spam_management');
}
function render_spam_management() {
echo '<div class="wrap"><h1>スパムコメント管理</h1></div>';
}
サンプルコード 4: カスタムメタデータの表示
この例では、コメントに関連するカスタムメタデータを表示するためのページを作成します。
add_action('admin_menu', 'add_custom_meta_page');
function add_custom_meta_page() {
add_comments_page('コメントメタデータ', 'メタデータ', 'manage_options', 'comment-meta', 'render_custom_meta_page');
}
function render_custom_meta_page() {
echo '<div class="wrap"><h1>コメントメタデータ</h1></div>';
}
サンプルコード 5: コメントフィルタリングオプションの提供
このサンプルでは、コメントのフィルタリングオプションを提供するページを作成します。
add_action('admin_menu', 'add_comment_filter_options_page');
function add_comment_filter_options_page() {
add_comments_page('コメントフィルタ', 'フィルタ', 'manage_options', 'comment-filter', 'render_comment_filter_page');
}
function render_comment_filter_page() {
echo '<div class="wrap"><h1>コメントフィルタリングオプション</h1></div>';
}
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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 |
非推奨・削除されたバージョン
現在までのところ、add_comments_pageフィルタは特定のバージョンで非推奨または削除されていません。