do_action( "load-{$page_hook}" )
- Since
- 2.1.0
Fires before a particular screen is loaded.
Description
The load-* hook fires in a number of contexts. This hook is for plugin screens where a callback is provided when the screen is registered.
The dynamic portion of the hook name, $page_hook, refers to a mixture of plugin page information including:
- 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'.
- A separator of 'page'.
- 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 'load-settings_page_pluginbasename'.
Compatibility
- WordPress
- since 2.1.0
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0).
Where this hook fires · 1
wp-admin/admin.php:238file scope
Source code
* the hook name used would be 'load-settings_page_pluginbasename'. * * @see get_plugin_page_hook() * * @since 2.1.0 */ do_action( "load-{$page_hook}" ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores if ( ! isset( $_GET['noheader'] ) ) { require_once ABSPATH . 'wp-admin/admin-header.php'; } /** * Used to call the registered callback for a plugin screen.Changelog
Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
- Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.