path_join( string $base, string $path ): string
- Since
- 2.5.0
- Source
wp-includes/functions.php:2169
Description
For example, 'give me $path relative to $base'. If the $path is absolute, then it the full path is returned.
Compatibility
- WordPress
- since 2.5.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
$basestring- Base path.
$pathstring- Path relative to $base.
Return value
string- The path with the base or absolute path.
Performance profile
How much work a call to path_join() 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
- 7–13
- Plugin surface
- None
- Called by
- 9
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 14.
Nothing here hands control to plugin code.
9 places in core call this, so the cost is paid more often than your own code shows.
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 path_join() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
path_is_absolute() | 7 | path_is_absolute() |
!path_is_absolute() | 13 | path_is_absolute(), rtrim() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 14 instructions, 7–13 executed per call, 1 branch. 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.
Uses · 1
- path_is_absolute()Tests if a given filesystem path is absolute.
Used by · 9
- WP_Filesystem_Base::search_for_folder()Locates a folder on the remote filesystem.
- _load_image_to_edit_path()Retrieves the path or URL of an attachment's attached file.
- _wp_upload_dir()A non-filtered, non-cached version of wp_upload_dir() that doesn't check the path.
- image_get_intermediate_size()Retrieves the image's intermediate size (resized) path, width, and height.
- wp_delete_attachment_files()Deletes all files that belong to the given attachment.
- wp_get_original_image_path()Retrieves the path to an uploaded image file.
- wp_get_original_image_url()Retrieves the URL to an original attachment image.
- wp_restore_image()Restores the metadata for a given attachment.
- wp_save_image()Saves image to post, along with enqueued changes in `$_REQUEST['history']`.
Source code
function path_join( $base, $path ) { if ( path_is_absolute( $path ) ) { return $path; } return rtrim( $base, '/' ) . '/' . $path;}Changelog
Introduced in 2.5.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/functions.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.