云策 WordPress 开发者社区

函数文档

get_admin_url()

查看官方原文 ↗
💡 云策文档标注

概述

get_admin_url() 函数用于获取指定站点的管理区域 URL，支持自定义路径和协议方案。它基于 get_site_url() 构建，并可通过 'admin_url' 过滤器进行修改。

关键要点

  • 函数返回管理区域的 URL，可附加相对路径。
  • 参数包括可选的站点 ID、路径和协议方案，默认使用当前站点和 'admin' 方案。
  • 使用 'admin_url' 过滤器可以自定义生成的 URL。
  • 相关函数包括 get_site_url()、admin_url() 和 network_admin_url()。

代码示例

function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
	$url = get_site_url( $blog_id, 'wp-admin/', $scheme );

	if ( $path && is_string( $path ) ) {
		$url .= ltrim( $path, '/' );
	}

	return apply_filters( 'admin_url', $url, $path, $blog_id, $scheme );
}

注意事项

  • 协议方案 'admin' 会根据 force_ssl_admin() 和 is_ssl() 自动选择 HTTP 或 HTTPS。
  • 获取网络管理 URL 应使用 network_admin_url() 函数。
📄 原文内容

Retrieves the URL to the admin area for a given site.

Parameters

$blog_idint|nulloptional
Site ID. Default null (current site).

Default:null

$pathstringoptional
Path relative to the admin URL. Default empty.
$schemestringoptional
The scheme to use. Accepts 'http' or 'https', to force those schemes. Default 'admin', which obeys force_ssl_admin() and is_ssl() .

Return

string Admin URL link with optional path appended.

Source

function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
	$url = get_site_url( $blog_id, 'wp-admin/', $scheme );

	if ( $path && is_string( $path ) ) {
		$url .= ltrim( $path, '/' );
	}

	/**
	 * Filters the admin area URL.
	 *
	 * @since 2.8.0
	 * @since 5.8.0 The `$scheme` parameter was added.
	 *
	 * @param string      $url     The complete admin area URL including scheme and path.
	 * @param string      $path    Path relative to the admin area URL. Blank string if no path is specified.
	 * @param int|null    $blog_id Site ID, or null for the current site.
	 * @param string|null $scheme  The scheme to use. Accepts 'http', 'https',
	 *                             'admin', or null. Default 'admin', which obeys force_ssl_admin() and is_ssl().
	 */
	return apply_filters( 'admin_url', $url, $path, $blog_id, $scheme );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘admin_url’, string $url, string $path, int|null $blog_id, string|null $scheme )

Filters the admin area URL.

Uses Description
get_site_url()wp-includes/link-template.php

Retrieves the URL for a given site where WordPress application files (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible.
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.
Used by Description
wp_load_press_this()wp-admin/press-this.php
WP_MS_Sites_List_Table::handle_row_actions()wp-admin/includes/class-wp-ms-sites-list-table.php

Generates and displays row action links.
_access_denied_splash()wp-admin/includes/ms.php

Displays an access denied message when a user tries to view a site’s dashboard they do not have access to.
get_dashboard_url()wp-includes/link-template.php

Retrieves the URL to the user’s dashboard.
admin_url()wp-includes/link-template.php

Retrieves the URL to the admin area for the current site.
wp_admin_bar_my_sites_menu()wp-includes/admin-bar.php

Adds the “My Sites/[Site Name]” menu and all submenus.
wp_xmlrpc_server::initialise_blog_option_info()wp-includes/class-wp-xmlrpc-server.php

Sets up blog options property.

Show 2 moreShow less

Changelog

Version Description
3.0.0 Introduced.

User Contributed Notes