is_allowed_http_origin( string|null $origin = null ): string

In this article

Determines if the HTTP origin is an authorized one.

Parameters

$originstring|nulloptional
Origin URL. If not provided, the value of get_http_origin() is used.

Default:null

Return

string Origin URL if allowed, empty string if not.

Source

function is_allowed_http_origin( $origin = null ) {
	$origin_arg = $origin;

	if ( null === $origin ) {
		$origin = get_http_origin();
	}

	if ( $origin && ! in_array( $origin, get_allowed_http_origins(), true ) ) {
		$origin = '';
	}

	/**
	 * Change the allowed HTTP origin result.
	 *
	 * @since 3.4.0
	 *
	 * @param string $origin     Origin URL if allowed, empty string if not.
	 * @param string $origin_arg Original origin string passed into is_allowed_http_origin function.
	 */
	return apply_filters( 'allowed_http_origin', $origin, $origin_arg );
}

Hooks

apply_filters( ‘allowed_http_origin’, string $origin, string $origin_arg )

Change the allowed HTTP origin result.

Changelog

VersionDescription
3.4.0Introduced.

User Contributed Notes

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