load-(page_hook) │ action-hook │ WP 2.1.0

Fires on a particular admin page. The page on which the hook fires is specified by (page_hook).

It fires on the specified page before the page content is output—that is, before admin_print_styles, admin_print_scripts, admin_head, and admin_notices.

add_action( 'admin_menu', 'test_load' );
function test_load() {
	$page_hook = add_options_page( 'Test', 'Test', 8, 'testload' );

	add_action( "load-$page_hook", 'my_load_function' );
	// The hook name will be: load-tools_page_testload
}

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...
}

$page_hook(string)

The unique identifier of the current admin page. It is used in the hook name.

For custom pages added using add_menu_page() or add_submenu_page(), a unique $page_hook is generated and returned by the registration function. It looks like:

• toplevel_page_myplugin
• myplugin_page_settings.

The (page_hook) name can also be obtained with get_plugin_page_hook( $plugin_page, $parent_page ).

Examples

#1 Usage example

In this example, we register a settings page and separate the actions: the page HTML is handled independently, while other actions are attached to another function. The load-(page_hook) hook makes this convenient.

Suppose our plugin must be configured. Until it is configured, we display a notice on every admin page using the admin_notices hook. However, the notice should not appear on the plugin's own settings page:

<?php
add_action('admin_menu', 'my_plugin_menu');

// Here we can check whether all plugin options are configured.
// For example, check whether the plugin options exist. If they do not,
// add a hook that creates them.
// For now, the hook is always active!
add_action( 'admin_notices', 'my_plugin_admin_notices' );

function my_plugin_menu() {
	// Register the plugin settings page and obtain its suffix
	$hook_suffix = add_options_page('My Plugin Options', 'My Plugin', 'manage_options', 'my-unique-identifier', 'my_plugin_options');

	// Use the suffix to perform actions only on our page
	add_action( 'load-' . $hook_suffix , 'my_load_function' );
}

function my_load_function() {
	// Everything here runs only on the plugin settings page, so hide the notice by removing the hook added above.
	remove_action( 'admin_notices', 'my_plugin_admin_notices' );
}

function my_plugin_admin_notices() {
	echo "<div id='notice' class='updated fade'><p>You have not configured the plugin. Please do so!</p></div>\n";
}
// Plugin settings page
function my_plugin_options() {
	if( ! current_user_can('manage_options') )  {
		wp_die( __('You do not have sufficient permissions to access this page.') );
	}
	echo '<div class="wrap">';
	echo '<p>The settings HTML goes here.</p>';
	echo '</div>';
}
?>

#2 Load a plugin script only on its pages

add_action( 'admin_init', 'my_plugin_admin_init' );
add_action( 'admin_menu', 'my_plugin_admin_menu' );

function my_plugin_admin_init() {
	/* Register our script. */
	wp_register_script( 'my-plugin-script', plugins_url('/script.js', __FILE__) );
}

function my_plugin_admin_menu() {
	/* Register our plugin page */
	$page = add_submenu_page(
		'edit.php', // Parent menu page
		__( 'My plugin', 'myPlugin' ), // Menu item name
		__( 'My plugin', 'myPlugin' ), // Page heading
		'manage_options', // Capability that determines access to the menu item
		'my_plugin-options', // Plugin page slug (part of its address)
		'my_plugin_manage_menu' // Function that outputs the page
	);

	/* Use the registered page to load the script */
	add_action( "admin_print_scripts-{$page}", 'my_plugin_admin_scripts' );
}

function my_plugin_admin_scripts() {
	/*
	 * This function is called only on the plugin page; enqueue our script
	 */
	wp_enqueue_script( 'my-plugin-script' );
}

function my_plugin_manage_menu() {
	/* Output the plugin page */
}