load-<plugin_page>

Fires before a particular screen is loaded.

Description

do_action( 'load-<plugin_page>' ); 

The load-* hook fires in a number of contexts. This hook is for plugin screens where the file to load is directly included, rather than the use of a function.

The dynamic portion(s) of the hook name refer to the plugin basename.


Usage

To run the hook, copy the example below.
  1. // run the action 
  2. do_action( 'load-{$plugin_page}' ); 
The following example is for adding a hook callback.
  1. // define the load-<plugin_page> callback 
  2. function action_load_plugin_page( ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( "load-{$plugin_page}", 'action_load_plugin_page', 10, 0 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( "load-{$plugin_page}", 'action_load_plugin_page', 10, 0 ); 

Defined (1)

The action is defined in the following location(s).

/wp-admin/admin.php  
  1. do_action( "load-{$plugin_page}" );