Alert: This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.
_wp_relative_upload_path() WordPress Function
The wp_relative_upload_path() function is used to generate a relative path for an uploaded file. This is useful when you want to move or rename an uploaded file without changing its URL.
_wp_relative_upload_path( string $path ) #
Return relative path to an uploaded file.
Description
The path is relative to the current upload dir.
Parameters
- $path
(string)(Required)Full path to the file.
Return
(string) Relative path on success, unchanged path on failure.
Source
File: wp-includes/post.php
function _wp_relative_upload_path( $path ) {
$new_path = $path;
$uploads = wp_get_upload_dir();
if ( 0 === strpos( $new_path, $uploads['basedir'] ) ) {
$new_path = str_replace( $uploads['basedir'], '', $new_path );
$new_path = ltrim( $new_path, '/' );
}
/**
* Filters the relative path to an uploaded file.
*
* @since 2.9.0
*
* @param string $new_path Relative path to the file.
* @param string $path Full path to the file.
*/
return apply_filters( '_wp_relative_upload_path', $new_path, $path );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.9.0 | Introduced. |