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
This commit is contained in:
Gary Pendergast
2019-01-09 06:13:44 +00:00
parent 31fdd577b4
commit 36a2ed3f56

View File

@@ -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 );