includes_url( string $path = '', string|null $scheme = null ): string
- Since
- 2.6.0
- Source
wp-includes/link-template.php:3621
Compatibility
- WordPress
- since 2.6.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$pathstringoptional- Path relative to the includes URL. Default empty.Default:
'' $schemestring|nulloptional- Scheme to give the includes URL context. Accepts 'http', 'https', or 'relative'. Default null.Default:
null
Return value
string- Includes URL link with optional path appended.
Performance profile
How much work a call to includes_url() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 18–25
- Plugin surface
- 1 hook
- Called by
- 20
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 25.
Third-party callbacks on 'includes_url' run inside this call, and their cost is not bounded by anything here.
20 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost includes_url() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 18–20 | site_url(), apply_filters() |
is_string($path) | 25 | site_url(), ltrim(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 25 instructions, 18–25 executed per call, 2 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while includes_url() runs, in this order:
- apply_filters( includes_url )filterline 3640 (+19 into the body)
Filters the URL to the includes directory.
Uses · 2
- site_url()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()Calls the callback functions that have been added to a filter hook.
Used by · 20
- WP_Widget_RSS::widget()Outputs the content for the current RSS widget instance.
- _WP_Editors::default_settings()Returns the default TinyMCE settings.
- _WP_Editors::get_baseurl()Returns the TinyMCE base URL.
- _print_emoji_detection_script()Prints inline Emoji detection script.
- _thickbox_path_admin_subfolder()Prints thickbox image paths for Network Admin.
- do_favicon()Displays the favicon.ico file content.
- get_block_asset_url()Gets the URL to a block asset.
- get_post_embed_html()Retrieves the embed code for a specific post.
- print_embed_scripts()Prints the JavaScript in the embed iframe header.
- register_core_block_style_handles()Registers core block style handles.
- the_embed_site_title()Prints the necessary markup for the site title in an embed template.
- translate_smiley()Converts one smiley code to the icon graphic file equivalent.
Show all 20
- wp_ajax_parse_embed()Applies [embed] Ajax handlers to a string.
- wp_default_script_modules()Registers all the default WordPress Script Modules.
- wp_default_scripts()Registers all WordPress scripts.
- wp_get_code_editor_settings()Generates and returns code editor settings.
- wp_mime_type_icon()Retrieves the icon for a MIME type or attachment.
- wp_register_tinymce_scripts()Registers TinyMCE scripts.
- wp_tinymce_inline_scripts()Adds inline scripts required for the TinyMCE in the block editor.
- wpview_media_sandbox_styles()Returns the URLs for CSS files used in an iframe-sandbox'd TinyMCE media view.
Source code
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 );}Changelog
Introduced in 2.6.0. Unchanged from 6.7.7 through 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.