WordPress.org

Make WordPress Core

Changeset 44501


Ignore:
Timestamp:
01/09/2019 06:13:44 AM (6 months ago)
Author:
pento
Message:

Docs: Document the $page_hook action.

Props johnbillion.
Fixes #43643.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/admin.php

    r43571 r44501  
    235235         * Used to call the registered callback for a plugin screen.
    236236         *
    237          * @ignore
     237         * This hook uses a dynamic hook name, `$page_hook`, which refers to a mixture of plugin
     238         * page information including:
     239         * 1. The page type. If the plugin page is registered as a submenu page, such as for
     240         *    Settings, the page type would be 'settings'. Otherwise the type is 'toplevel'.
     241         * 2. A separator of '_page_'.
     242         * 3. The plugin basename minus the file extension.
     243         *
     244         * Together, the three parts form the `$page_hook`. Citing the example above,
     245         * the hook name used would be 'settings_page_pluginbasename'.
     246         *
     247         * @see get_plugin_page_hook()
     248         *
    238249         * @since 1.5.0
    239250         */
Note: See TracChangeset for help on using the changeset viewer.