load-(page_hook)
Fires before a particular screen is loaded.
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'.
Usage
add_action( 'load-(page_hook)', 'wp_kama_load_page_hook_action' ); /** * Function for `load-(page_hook)` action-hook. * * @return void */ function wp_kama_load_page_hook_action(){ // action... }
Changelog
Since 2.1.0 | Introduced. |
Where the hook is called
In file: /wp-admin/admin.php
load-(page_hook)
wp-admin/admin.php 237
do_action( "load-{$page_hook}" ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
Where the hook is used in WordPress
wp-admin/includes/admin-filters.php 131
add_action( 'load-plugins.php', 'wp_plugin_update_rows', 20 ); // After wp_update_plugins() is called.
wp-admin/includes/admin-filters.php 132
add_action( 'load-themes.php', 'wp_theme_update_rows', 20 ); // After wp_update_themes() is called.
wp-admin/includes/class-custom-background.php 78
add_action( "load-{$page}", array( $this, 'admin_load' ) );
wp-admin/includes/class-custom-background.php 79
add_action( "load-{$page}", array( $this, 'take_action' ), 49 );
wp-admin/includes/class-custom-background.php 80
add_action( "load-{$page}", array( $this, 'handle_upload' ), 49 );
wp-includes/update.php 1156
add_action( 'load-plugins.php', 'wp_update_plugins' );
wp-includes/update.php 1157
add_action( 'load-update.php', 'wp_update_plugins' );
wp-includes/update.php 1158
add_action( 'load-update-core.php', 'wp_update_plugins' );
wp-includes/update.php 1162
add_action( 'load-themes.php', 'wp_update_themes' );
wp-includes/update.php 1163
add_action( 'load-update.php', 'wp_update_themes' );
wp-includes/update.php 1164
add_action( 'load-update-core.php', 'wp_update_themes' );