W3cubDocs

/WordPress

_wp_relative_upload_path( string $path ): string

Returns relative path to an uploaded file.

Description

The path is relative to the current upload dir.

Parameters

$pathstringrequired
Full path to the file.

Return

string Relative path on success, unchanged path on failure.

Source

function _wp_relative_upload_path( $path ) {
	$new_path = $path;

	$uploads = wp_get_upload_dir();
	if ( str_starts_with( $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

apply_filters( ‘_wp_relative_upload_path’, string $new_path, string $path )

Filters the relative path to an uploaded file.

Changelog

Version Description
2.9.0 Introduced.

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