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.

// run the action 
do_action( 'load-{$plugin_page}' ); 

The following example is for adding a hook callback.

// define the load-<plugin_page> callback 
function action_load_plugin_page(  ) { 
    // make action magic happen here... 
}; 
         
// add the action 
add_action( "load-{$plugin_page}", 'action_load_plugin_page', 10, 0 ); 

To remove a hook callback, use the example below.

// remove the action 
remove_action( "load-{$plugin_page}", 'action_load_plugin_page', 10, 0 );