Skip to content
Docs
Get RestroPress

Filter

rpress_united_kingdom_states

Updated
On this page

Filters the list of states returned for the United Kingdom.

Applied at the end of rpress_get_united_kingdom_states_list(), which rpress_get_states() calls when the selected country is GB. The array maps a code to a display name (county code => name). Add, remove or rename entries to change what appears in the state selector for this country.

Parameters#

ParameterTypeDescription
$statesarrayAssociative array of county code => name.

Return value#

array. The list of states for the United Kingdom.

Example#

function my_add_united_kingdom_states( $states ) {
	$states['XX'] = 'My Custom Region';
	return $states;
}
add_filter( 'rpress_united_kingdom_states', 'my_add_united_kingdom_states' );

Source#

Applied in:

  • includes/country-functions.php (line 1077), in rpress_get_united_kingdom_states_list()

See also#

Was this page helpful?