get_plugin_page_hookname( string $plugin_page, string $parent_page ): string

Parameters

$plugin_pagestring

The slug name of the plugin page.

$parent_pagestring

The slug name for the parent menu (or the file name of a standard WordPress admin page).

Return

string

Hook name for the plugin page.

Uses · 1

• get_admin_page_parent()Gets the parent file of the current admin page.

Used by · 4

• add_menu_page()Adds a top-level menu page.
• add_submenu_page()Adds a submenu page.
• get_plugin_page_hook()Gets the hook attached to the administrative page of a plugin.
• user_can_access_admin_page()Determines whether the current user can access the current admin page.

Source

View on Trac ↗View on GitHub ↗

2145function get_plugin_page_hookname( $plugin_page, $parent_page ) {2146	global $admin_page_hooks;2147 2148	$parent = get_admin_page_parent( $parent_page );2149 2150	$page_type = 'admin';2151	if ( empty( $parent_page ) || 'admin.php' === $parent_page || isset( $admin_page_hooks[ $plugin_page ] ) ) {2152		if ( isset( $admin_page_hooks[ $plugin_page ] ) ) {2153			$page_type = 'toplevel';2154		} elseif ( isset( $admin_page_hooks[ $parent ] ) ) {2155			$page_type = $admin_page_hooks[ $parent ];2156		}2157	} elseif ( isset( $admin_page_hooks[ $parent ] ) ) {2158		$page_type = $admin_page_hooks[ $parent ];2159	}2160 2161	$plugin_name = preg_replace( '!\.php!', '', $plugin_page );2162 2163	return $page_type . '_page_' . $plugin_name;2164}

History

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-admin/includes/plugin.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.