path_is_absolute( string $path ): bool
- Since
- 2.5.0
- Source
wp-includes/functions.php:2120
Description
For example, '/foo/bar', or 'c:\windows'.
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
$pathstring- File path.
Return value
bool- True if path is absolute, false is not absolute.
Performance profile
How much work a call to path_is_absolute() 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
- Heavy
- Scaling
- Constant
- Instructions
- 10–32
- Plugin surface
- None
- Called by
- 1
Reads or writes the filesystem via is_dir().
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 36.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- filesystemfilesystem access
is_dir()called directly
What one call costs · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost path_is_absolute() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
wp_is_stream() && is_dir() | 10 | wp_is_stream(), is_dir() |
!wp_is_stream() | 11–24 | wp_is_stream(), realpath() |
wp_is_stream() && !is_dir() && is_file() | 14 | wp_is_stream(), is_dir(), is_file() |
wp_is_stream() && !is_dir() && !is_file() | 19–32 | wp_is_stream(), is_dir(), is_file(), realpath() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 36 | 10–32 | 8 | |
| 8.5 | 36 | 10–32 | 8 | |
| 8.4 | 36 | 10–32 | 8 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 39 | 10–35 | 8 | |
| 8.2 | 39 | 10–35 | 8 | |
| 8.1 | 39 | 10–35 | 8 | |
| 7.4 | 39 | 10–35 | 8 |
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
- wp_is_stream()Tests if a given path is a stream URL
Used by · 1
- path_join()Joins two filesystem paths together.
Source code
function path_is_absolute( $path ) { /* * Check to see if the path is a stream and check to see if its an actual * path or file as realpath() does not support stream wrappers. */ if ( wp_is_stream( $path ) && ( is_dir( $path ) || is_file( $path ) ) ) { return true; } /* * This is definitive if true but fails if $path does not exist or contains * a symbolic link. */ if ( realpath( $path ) === $path ) { return true; } if ( strlen( $path ) === 0 || '.' === $path[0] ) { return false; } // Windows allows absolute paths like this. if ( preg_match( '#^[a-zA-Z]:\\\\#', $path ) ) { return true; } // A path starting with / or \ is absolute; anything else is relative. return ( '/' === $path[0] || '\\' === $path[0] );}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 6.9.7 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.