Changeset 44501 for trunk/src/wp-admin/admin.php

Timestamp:

01/09/2019 06:13:44 AM (5 years ago)

Author:

pento

Message:

Docs: Document the $page_hook action.

Props johnbillion.
Fixes #43643.

File:

• trunk/src/wp-admin/admin.php (modified) (1 diff)

trunk/src/wp-admin/admin.php

@@ -235 +235 @@
          * 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
          */