概要
add_links_page関数は、WordPressの管理画面にリンクメニューにサブメニューを登録するために使用されます。この関数を利用することで、ユーザーが特定の機能を持つページに簡単にアクセスできるようになります。一般的にこの関数は以下のような機能を実装する際によく使われます。
- 外部リンクの管理ページ
- 特定の設定オプションのカスタムメニュー
- プラグインの管理ページ
- サイトのリンク集の作成
- ユーザーのフィードバックを受け取るためのページ
- アナリティクスやトラッキングリンクの管理
- サードパーティAPIとの連携メニュー
- カスタムポストタイプの設定ページ
構文
add_links_page($page_title, $menu_title, $capability, $menu_slug, $function);
パラメータ
$page_title(string) – サブメニューのページタイトル$menu_title(string) – メニューに表示されるタイトル$capability(string) – このメニューを表示するために必要な権限$menu_slug(string) – メニューのスラッグ（名前）$function(callable) – サブメニューが表示された時に呼び出される関数
戻り値
この関数は、成功した場合はメニューのスラッグを返し、失敗した場合はfalseを返します。
関連する関数
add_menu_page
remove_menu_page
add_submenu_page
do_menu_page
使用可能なバージョン
この関数は、WordPress 2.1以降で使用可能です。
コアファイルのパス
wp-admin/includes/plugin.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 |
なお、add_links_page関数は、WordPress 3.5以降で非推奨とはなっていませんが、今後のバージョンで削除される可能性があるため、将来的には他の方法を検討する必要があります。