WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

_remove_qs_args_if_not_in_url()

_remove_qs_args_if_not_in_url( string $query_string, array $args_to_check, string $url ): string

In this article

Back to top

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.

Removes arguments from a query string if they are not present in a URL DO NOT use this in plugin code.

Parameters

$query_stringstringrequired
$args_to_checkarrayrequired
$urlstringrequired

Return

string The altered query string

Source

function _remove_qs_args_if_not_in_url( $query_string, array $args_to_check, $url ) {
	$parsed_url = parse_url( $url );

	if ( ! empty( $parsed_url['query'] ) ) {
		parse_str( $parsed_url['query'], $parsed_query );

		foreach ( $args_to_check as $qv ) {
			if ( ! isset( $parsed_query[ $qv ] ) ) {
				$query_string = remove_query_arg( $qv, $query_string );
			}
		}
	} else {
		$query_string = remove_query_arg( $args_to_check, $query_string );
	}

	return $query_string;
}

View all references View on Trac View on GitHub

UsesDescription
remove_query_arg()wp-includes/functions.php

Removes an item or items from a query string.

Used byDescription
redirect_canonical()wp-includes/canonical.php

Redirects incoming links to the proper URL based on the site url.

Changelog

VersionDescription
3.4.0Introduced.

User Contributed Notes

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