esc_url_raw( string $url, string[] $protocols = null ): string

Sanitizes a URL for database or redirect usage.

Contents

Description

This function is an alias for sanitize_url() .

Top ↑

See also

Top ↑

Parameters

$url string Required
The URL to be cleaned.
$protocols string[] Optional
An array of acceptable protocols.
Defaults to return value of wp_allowed_protocols() .

Default: null

Top ↑

Return

string The cleaned URL after sanitize_url() is run.

Top ↑

More Information

The esc_url_raw() function is similar to esc_url() (and actually uses it), but unlike esc_url() it does not replace entities for display. The resulting URL is safe to use in database queries, redirects and HTTP requests.

This function is not safe to use for displaying the URL, use esc_url() instead.

Top ↑

Source

File: wp-includes/formatting.php. View all references 

function esc_url_raw( $url, $protocols = null ) {
	return sanitize_url( $url, $protocols );
}

View on Trac View on GitHub

Top ↑

Top ↑

Uses

Uses
Uses Description
sanitize_url() wp-includes/formatting.php

Sanitizes a URL for database or redirect usage.

Top ↑

Used By

Used By
Used By Description
wp_nonce_ays() wp-includes/functions.php

Displays “Are You Sure” message to confirm the action being taken.
wp_update_themes() wp-includes/update.php

Checks for available updates to themes based on the latest versions hosted on WordPress.org.

Top ↑

Changelog

Changelog
Version Description
6.1.0 Turned into an alias for sanitize_url() .
2.8.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Right and Wrong usage

    <!-- Right -->
$url = 'http://wordpress.org';
$response = wp_remote_get( esc_url_raw( $url ) ); // no need to escape entities

if ( ! is_wp_error( $response ) ) {
	echo wp_remote_retrieve_body( $response );
}
    <!-- Wrong! Use esc_url instead! -->
<img src="<?php echo esc_url_raw( $url ); ?>" />
<a href="<?php echo esc_url_raw( $url ); ?>">WordPress</a>

You must log in before being able to contribute a note or feedback.