admin_url( string $path = '', string $scheme = 'admin' ): string

Parameters

$pathstringoptional

Path relative to the admin URL. Default empty.Default: ''

$schemestringoptional

The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.Default: 'admin'

Return

string

Admin URL link with optional path appended.

Examples

Every example is editable and runs in a real WordPress booted in your browser by WordPress Playground. Press Run, then edit the code: clicking away re-runs it. Nothing is sent anywhere until you do.

$settings_url = add_query_arg(
	array( 'page' => 'myplugin' ),
	admin_url( 'options-general.php' )
);

printf(
	'<a href="%s">%s</a>',
	esc_url( $settings_url ),
	esc_html__( 'Plugin settings', 'myplugin' )
);

Uses · 1

• get_admin_url()Retrieves the URL to the admin area for a given site.

Used by · 50

• Custom_Background::admin_page()Displays the custom background page.
• Custom_Image_Header::help()Adds contextual help.
• Custom_Image_Header::step_1()Displays first step of custom header image page.
• Featured_Content::customize_register()Adds settings to the Customizer.
• Plugin_Installer_Skin::after()Performs an action following a plugin install.
• Theme_Installer_Skin::after()Performs an action following a single theme install.
• Theme_Upgrader_Skin::after()Performs an action following a single theme update.
• WP_Automatic_Updater::send_email()Sends an email upon the completion or failure of a background core update.
• WP_Automatic_Updater::send_plugin_theme_email()Sends an email upon the completion or failure of a plugin or theme background update.
• WP_Comments_List_Table::column_author()Outputs the author column.
• WP_Comments_List_Table::get_views()Returns an array of comment status links.
• WP_Customize_Manager::customize_pane_settings()Prints JavaScript settings for parent window.

Source

View on Trac ↗View on GitHub ↗

3573function admin_url( $path = '', $scheme = 'admin' ) {3574	return get_admin_url( null, $path, $scheme );3575}

History

Introduced in 2.6.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 7.1.0 tag, from src/wp-includes/link-template.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.