云策 WordPress 开发者社区

函数文档

includes_url()

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

概述

includes_url() 函数用于获取 WordPress 核心 includes 目录的 URL，支持附加相对路径和指定协议方案。该函数通过 site_url() 构建基础 URL，并应用 includes_url 过滤器进行自定义。

关键要点

  • 函数返回 includes 目录的 URL，可选附加路径和指定协议（如 'http'、'https' 或 'relative'）。
  • 参数 $path 为字符串类型，可选，默认为空，用于指定相对于 includes URL 的路径。
  • 参数 $scheme 为字符串或 null，可选，默认为 null，用于设置 URL 的协议上下文。
  • 内部使用 site_url() 和 WPINC 常量构建 URL，并通过 apply_filters() 应用 includes_url 钩子进行过滤。
  • 相关函数包括 site_url() 和 apply_filters()，被多个核心功能如脚本注册、块资产获取等调用。

代码示例

$url = includes_url();
echo $url;

注意事项

  • 函数自 WordPress 2.6.0 引入，5.8.0 版本添加了 $scheme 参数支持。
  • 使用 includes_url 过滤器可以自定义返回的 URL，适用于主题或插件开发中的特定需求。
📄 原文内容

Retrieves the URL to the includes directory.

Parameters

$pathstringoptional
Path relative to the includes URL. Default empty.
$schemestring|nulloptional
Scheme to give the includes URL context. Accepts 'http', 'https', or 'relative'.

Default:null

Return

string Includes URL link with optional path appended.

Source

function includes_url( $path = '', $scheme = null ) {
	$url = site_url( '/' . WPINC . '/', $scheme );

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

	/**
	 * Filters the URL to the includes directory.
	 *
	 * @since 2.8.0
	 * @since 5.8.0 The `$scheme` parameter was added.
	 *
	 * @param string      $url    The complete URL to the includes directory including scheme and path.
	 * @param string      $path   Path relative to the URL to the wp-includes directory. Blank string
	 *                            if no path is specified.
	 * @param string|null $scheme Scheme to give the includes URL context. Accepts
	 *                            'http', 'https', 'relative', or null. Default null.
	 */
	return apply_filters( 'includes_url', $url, $path, $scheme );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘includes_url’, string $url, string $path, string|null $scheme )

Filters the URL to the includes directory.

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

Retrieves the URL for the current 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_default_script_modules()wp-includes/script-modules.php

Registers all the default WordPress Script Modules.
get_block_asset_url()wp-includes/blocks.php

Gets the URL to a block asset.
do_favicon()wp-includes/functions.php

Displays the favicon.ico file content.
wp_register_tinymce_scripts()wp-includes/script-loader.php

Registers TinyMCE scripts.
wp_tinymce_inline_scripts()wp-includes/script-loader.php

Adds inline scripts required for the TinyMCE in the block editor.
_WP_Editors::get_baseurl()wp-includes/class-wp-editor.php

Returns the TinyMCE base URL.
_WP_Editors::default_settings()wp-includes/class-wp-editor.php

Returns the default TinyMCE settings.
the_embed_site_title()wp-includes/embed.php

Prints the necessary markup for the site title in an embed template.
print_embed_scripts()wp-includes/embed.php

Prints the JavaScript in the embed iframe header.
get_post_embed_html()wp-includes/embed.php

Retrieves the embed code for a specific post.
wpview_media_sandbox_styles()wp-includes/media.php

Returns the URLs for CSS files used in an iframe-sandbox’d TinyMCE media view.
wp_ajax_parse_embed()wp-admin/includes/ajax-actions.php

Applies Ajax handlers to a string.
_thickbox_path_admin_subfolder()wp-admin/includes/ms.php

Prints thickbox image paths for Network Admin.
translate_smiley()wp-includes/formatting.php

Converts one smiley code to the icon graphic file equivalent.
WP_Widget_RSS::widget()wp-includes/widgets/class-wp-widget-rss.php

Outputs the content for the current RSS widget instance.
wp_mime_type_icon()wp-includes/post.php

Retrieves the icon for a MIME type or attachment.
wp_default_scripts()wp-includes/script-loader.php

Registers all WordPress scripts.

Show 12 moreShow less

Changelog

Version Description
2.6.0 Introduced.

User Contributed Notes

  2. Skip to note 4 content


    davisingh


    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    What it returns

    echo includes_url(); // <a href="https://" rel="ugc">https://</a>{domain}/wp-includes
echo includes_url('', 'https'); // <a href="https://" rel="ugc">https://</a>{domain}/wp-includes
echo includes_url('', 'http'); // <a href="http://" rel="ugc">http://</a>{domain}/wp-includes
echo includes_url('', 'relative'); // /wp-includes/