wordpress / latest / functions / _wp_relative_upload_path.html

_wp_relative_upload_path( string $path ): string

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.

Returns 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. View all references

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 );
}

Hooks

Uses

Uses Description

Used By

Used By Description

Changelog

Version Description
2.9.0 Introduced.

© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/_wp_relative_upload_path