wp_normalize_path() – Function | Developer.WordPress.org

Normalizes a filesystem path.

Description

On windows systems, replaces backslashes with forward slashes and forces upper-case drive letters.
Allows for two leading slashes for Windows network shares, but ensures that all other duplicate slashes are reduced to a single.

Parameters

$pathstringrequired: Path to normalize.

Return

string Normalized path.

Source

function wp_normalize_path( $path ) {
	$wrapper = '';

	if ( wp_is_stream( $path ) ) {
		list( $wrapper, $path ) = explode( '://', $path, 2 );

		$wrapper .= '://';
	}

	// Standardize all paths to use '/'.
	$path = str_replace( '\\', '/', $path );

	// Replace multiple slashes down to a singular, allowing for network shares having two slashes.
	$path = preg_replace( '|(?<=.)/+|', '/', $path );

	// Windows paths should uppercase the drive letter.
	if ( ':' === substr( $path, 1, 1 ) ) {
		$path = ucfirst( $path );
	}

	return $wrapper . $path;
}

View all references View on Trac View on GitHub

Uses	Description
wp_is_stream()`wp-includes/functions.php`	Tests if a given path is a stream URL

Used by	Description
WP_Block_Metadata_Registry::get_plugin_dir()`wp-includes/class-wp-block-metadata-registry.php`	Gets the normalized WordPress plugin directory path.
WP_Block_Metadata_Registry::get_wpinc_dir()`wp-includes/class-wp-block-metadata-registry.php`	Gets the WordPress ‘wp-includes’ directory path.
WP_Block_Metadata_Registry::find_collection_path()`wp-includes/class-wp-block-metadata-registry.php`	Finds the collection path for a given file or folder.
WP_Block_Metadata_Registry::register_collection()`wp-includes/class-wp-block-metadata-registry.php`	Registers a block metadata collection.
WP_Font_Collection::load_from_json()`wp-includes/fonts/class-wp-font-collection.php`	Loads font collection data from a JSON file or URL.
register_block_script_module_id()`wp-includes/blocks.php`	Finds a script module ID for the selected block metadata field. It detects when a path to file was provided and optionally finds a corresponding asset file with details necessary to register the script module under with an automatically generated module ID. It returns unprocessed script module ID otherwise.
get_block_asset_url()`wp-includes/blocks.php`	Gets the URL to a block asset.
wp_json_file_decode()`wp-includes/functions.php`	Reads and decodes a JSON file.
wp_generate_block_templates_export_file()`wp-includes/block-template-utils.php`	Creates an export of the current templates and template parts from the site editor at the specified path in a ZIP file.
register_block_script_handle()`wp-includes/blocks.php`	Finds a script handle for the selected block metadata field. It detects when a path to file was provided and optionally finds a corresponding asset file with details necessary to register the script under automatically generated handle name. It returns unprocessed script handle otherwise.
register_block_style_handle()`wp-includes/blocks.php`	Finds a style handle for the block metadata field. It detects when a path to file was provided and registers the style under automatically generated handle name. It returns unprocessed style handle otherwise.
register_block_type_from_metadata()`wp-includes/blocks.php`	Registers a block type from the metadata stored in the `block.json` file.
Theme_Installer_Skin::do_overwrite()`wp-admin/includes/class-theme-installer-skin.php`	Checks if the theme can be overwritten and outputs the HTML for overwriting a theme on upload.
WP_Recovery_Mode::get_extension_for_error()`wp-includes/class-wp-recovery-mode.php`	Gets the extension that the error occurred in.
_get_plugin_from_callback()`wp-admin/includes/template.php`	Internal helper function to find the plugin from a meta box callback.
wp_delete_file_from_directory()`wp-includes/functions.php`	Deletes a file if its path is within the given directory.
wp_privacy_generate_personal_data_export_file()`wp-admin/includes/privacy-tools.php`	Generate the personal data export file.
wp_validate_redirect()`wp-includes/pluggable.php`	Validates a URL for use in a redirect.
wp_debug_backtrace_summary()`wp-includes/functions.php`	Returns a comma-separated string or array of functions that have been called to get to the current point in code.
validate_file()`wp-includes/functions.php`	Validates a file name and path against an allowed set of rules.
plugins_url()`wp-includes/link-template.php`	Retrieves a URL within the plugins or mu-plugins directory.
plugin_basename()`wp-includes/plugin.php`	Gets the basename of a plugin.
wp_register_plugin_realpath()`wp-includes/plugin.php`	Register a plugin’s real path.

Show 18 more Show less

Changelog

Version	Description
4.9.7	Allows for PHP file wrappers.
4.5.0	Allows for Windows network shares.
4.4.0	Ensures upper-case drive letters on Windows systems.
3.9.0	Introduced.

User Contributed Notes

Codex 9 years ago

Example

A Simple example to normalize the theme include path

    $bS_incl_path = get_template_directory() . '/inc';

    /**
     * Define theme include path
     * 
     * Normalize the include path to be safe on windows hosts
     * @return string Normalized path
     * require min WordPress version 3.9
     * @since boot_Strap 1.0.1
     * 
     */

     if(function_exists('wp_normalize_path')){
         
        $bS_incl_path = wp_normalize_path($bS_incl_path);
     }
    
    define('THM_INC', $bS_incl_path);

    require_once (THM_INC. '/wp_bootstrap_navwalker.php');

print_r($bS_incl_path); shows

Using this function:

C:/xampp/htdocs/boot_strap/wp-content/themes/boot_Strap/inc

Without this function:

C:\xampp\htdocs\boot_strap/wp-content/themes/boot_Strap/inc

On a Windows server.

wp_normalize_path( string $path ): string

In this article

Description

Parameters

Return

Source

Changelog

User Contributed Notes

wp_normalize_path( string $path ): string

In this article

Description

Parameters

Return

Source

Related

Changelog

User Contributed Notes