From 36a2ed3f568fd6757e419725e65b55cbcc51033d Mon Sep 17 00:00:00 2001 From: Gary Pendergast Date: Wed, 9 Jan 2019 06:13:44 +0000 Subject: [PATCH] Docs: Document the `$page_hook` action. Props johnbillion. Fixes #43643. git-svn-id: https://develop.svn.wordpress.org/trunk@44501 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/admin.php | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/src/wp-admin/admin.php b/src/wp-admin/admin.php index fb08b47f1a..44db62de8d 100644 --- a/src/wp-admin/admin.php +++ b/src/wp-admin/admin.php @@ -234,7 +234,18 @@ if ( isset( $plugin_page ) ) { /** * Used to call the registered callback for a plugin screen. * - * @ignore + * This hook uses a dynamic hook name, `$page_hook`, which refers to a mixture of plugin + * page information including: + * 1. The page type. If the plugin page is registered as a submenu page, such as for + * Settings, the page type would be 'settings'. Otherwise the type is 'toplevel'. + * 2. A separator of '_page_'. + * 3. The plugin basename minus the file extension. + * + * Together, the three parts form the `$page_hook`. Citing the example above, + * the hook name used would be 'settings_page_pluginbasename'. + * + * @see get_plugin_page_hook() + * * @since 1.5.0 */ do_action( $page_hook );