Summery Summery

Fires before a particular screen is loaded.

Syntax Syntax

do_action( "load-{$page_hook}" )

Description 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:

  1. 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’.
  2. A separator of ‘_page_’.
  3. 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’.

Source Source

File: wp-admin/admin.php


Changelog Changelog

Version Description
2.1.0 Introduced.

See also See also


Leave a Reply