add_query_arg( $args ): string

Description

Parameters

$args

Return

string

New URL query string (unescaped).

Uses · 5

• stripos()
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• wp_parse_str()Parses a string into variables to be stored in an array.
• urlencode_deep()Navigates through an array, object, or scalar, and encodes the values to be used in a URL.
• build_query()Builds URL query based on an associative and, or indexed array.

Used by · 50

• Custom_Image_Header::step_1()Displays first step of custom header image page.
• Custom_Image_Header::step_2()Displays second step of custom header image page.
• Featured_Content::customize_register()Add settings to the Customizer.
• Plugin_Installer_Skin::do_overwrite()Checks if the plugin can be overwritten and outputs the HTML for overwriting a plugin on upload.
• Theme_Installer_Skin::after()Performs an action following a single theme install.
• Theme_Installer_Skin::do_overwrite()Checks if the theme can be overwritten and outputs the HTML for overwriting a theme on upload.
• Theme_Upgrader_Skin::after()Performs an action following a single theme update.
• WP_Automatic_Updater::has_fatal_error()Performs a loopback request to check for potential fatal errors.
• WP_Comments_List_Table::column_author()
• WP_Comments_List_Table::get_views()
• WP_Customize_Manager::add_state_query_params()Adds customize state query params to a given URL if preview is allowed.
• WP_Customize_Manager::customize_pane_settings()Prints JavaScript settings for parent window.

Source

View on Trac ↗View on GitHub ↗

1132function add_query_arg( ...$args ) {1133	if ( is_array( $args[0] ) ) {1134		if ( count( $args ) < 2 || false === $args[1] ) {1135			$uri = $_SERVER['REQUEST_URI'];1136		} else {1137			$uri = $args[1];1138		}1139	} else {1140		if ( count( $args ) < 3 || false === $args[2] ) {1141			$uri = $_SERVER['REQUEST_URI'];1142		} else {1143			$uri = $args[2];1144		}1145	}1146 1147	$frag = strstr( $uri, '#' );1148	if ( $frag ) {1149		$uri = substr( $uri, 0, -strlen( $frag ) );1150	} else {1151		$frag = '';1152	}1153 1154	if ( 0 === stripos( $uri, 'http://' ) ) {1155		$protocol = 'http://';1156		$uri      = substr( $uri, 7 );1157	} elseif ( 0 === stripos( $uri, 'https://' ) ) {1158		$protocol = 'https://';1159		$uri      = substr( $uri, 8 );1160	} else {1161		$protocol = '';1162	}1163 1164	if ( str_contains( $uri, '?' ) ) {1165		list( $base, $query ) = explode( '?', $uri, 2 );1166		$base                .= '?';1167	} elseif ( $protocol || ! str_contains( $uri, '=' ) ) {1168		$base  = $uri . '?';1169		$query = '';1170	} else {1171		$base  = '';1172		$query = $uri;1173	}1174 1175	wp_parse_str( $query, $qs );1176	$qs = urlencode_deep( $qs ); // This re-URL-encodes things that were already in the query string.1177	if ( is_array( $args[0] ) ) {1178		foreach ( $args[0] as $k => $v ) {1179			$qs[ $k ] = $v;1180		}1181	} else {1182		$qs[ $args[0] ] = $args[1];1183	}1184 1185	foreach ( $qs as $k => $v ) {1186		if ( false === $v ) {1187			unset( $qs[ $k ] );1188		}1189	}1190 1191	$ret = build_query( $qs );1192	$ret = trim( $ret, '?' );1193	$ret = preg_replace( '#=(&|$)#', '$1', $ret );1194	$ret = $protocol . $base . $ret . $frag;1195	$ret = rtrim( $ret, '?' );1196	$ret = str_replace( '?#', '#', $ret );1197	return $ret;1198}

History

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.