WP_Community_Events::get_events( string $location_search = '', string $timezone = '' ): array|WP_Error

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$location_searchstringoptional

City name to help determine the location.
e.g., "Seattle". Default empty string.Default: ''

$timezonestringoptional

Timezone to help determine the location.
Default empty string.Default: ''

Return value

array|WP_Error

A WP_Error on failure; an array with location and events on success.

Performance profile

How much work a call to WP_Community_Events::get_events() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Expensive

Reaches an outbound HTTP request via wp_remote_get().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

8–121

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 140.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• httpoutbound HTTP requestwp_remote_get()called directly
• serializeserialisationjson_decode()called directly
• hookthird-party callbacksapply_filters()one call below WP_Community_Events::get_events()

Further down the call graph this can also reach option, cache, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 13 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Community_Events::get_events() can have, taken from its control-flow graph on PHP 8.5.

Uses · 14

• home_url()Retrieves the URL for the current site where the front end is accessible.
• wp_http_supports()Determines if there is an HTTP Transport that can process this request.
• set_url_scheme()Sets the scheme for a URL.
• wp_remote_get()Performs an HTTP request using the GET method and returns its response.
• wp_remote_retrieve_response_code()Retrieves only the response code from the raw response.
• wp_remote_retrieve_body()Retrieves only the body from the raw response.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• __()Retrieves the translation of $text.
• WP_Community_Events::get_cached_events()Gets cached events.
• WP_Community_Events::get_request_args()Builds an array of args to use in an HTTP request to the w.org Events API.
• WP_Error::__construct()Initializes the error.
• WP_Community_Events::coordinates_match()Test if two pairs of latitude/longitude coordinates match each other.

Source code

View on Trac ↗View on GitHub ↗

91	public function get_events( $location_search = '', $timezone = '' ) {92		$cached_events = $this->get_cached_events();93 94		if ( ! $location_search && $cached_events ) {95			return $cached_events;96		}97 98		// Include an unmodified $wp_version.99		require ABSPATH . WPINC . '/version.php';100 101		$api_url                    = 'http://api.wordpress.org/events/1.0/';102		$request_args               = $this->get_request_args( $location_search, $timezone );103		$request_args['user-agent'] = 'WordPress/' . $wp_version . '; ' . home_url( '/' );104 105		if ( wp_http_supports( array( 'ssl' ) ) ) {106			$api_url = set_url_scheme( $api_url, 'https' );107		}108 109		$response       = wp_remote_get( $api_url, $request_args );110		$response_code  = wp_remote_retrieve_response_code( $response );111		$response_body  = json_decode( wp_remote_retrieve_body( $response ), true );112		$response_error = null;113 114		if ( is_wp_error( $response ) ) {115			$response_error = $response;116		} elseif ( 200 !== $response_code ) {117			$response_error = new WP_Error(118				'api-error',119				/* translators: %d: Numeric HTTP status code, e.g. 400, 403, 500, 504, etc. */120				sprintf( __( 'Invalid API response code (%d).' ), $response_code )121			);122		} elseif ( ! isset( $response_body['location'], $response_body['events'] ) ) {123			$response_error = new WP_Error(124				'api-invalid-response',125				isset( $response_body['error'] ) ? $response_body['error'] : __( 'Unknown API error.' )126			);127		}128 129		if ( is_wp_error( $response_error ) ) {130			return $response_error;131		} else {132			$expiration = false;133 134			if ( isset( $response_body['ttl'] ) ) {135				$expiration = $response_body['ttl'];136				unset( $response_body['ttl'] );137			}138 139			/*140			 * The IP in the response is usually the same as the one that was sent141			 * in the request, but in some cases it is different. In those cases,142			 * it's important to reset it back to the IP from the request.143			 *144			 * For example, if the IP sent in the request is private (e.g., 192.168.1.100),145			 * then the API will ignore that and use the corresponding public IP instead,146			 * and the public IP will get returned. If the public IP were saved, though,147			 * then get_cached_events() would always return `false`, because the transient148			 * would be generated based on the public IP when saving the cache, but generated149			 * based on the private IP when retrieving the cache.150			 */151			if ( ! empty( $response_body['location']['ip'] ) ) {152				$response_body['location']['ip'] = $request_args['body']['ip'];153			}154 155			/*156			 * The API doesn't return a description for latitude/longitude requests,157			 * but the description is already saved in the user location, so that158			 * one can be used instead.159			 */160			if ( $this->coordinates_match( $request_args['body'], $response_body['location'] ) && empty( $response_body['location']['description'] ) ) {161				$response_body['location']['description'] = $this->user_location['description'];162			}163 164			/*165			 * Store the raw response, because events will expire before the cache does.166			 * The response will need to be processed every page load.167			 */168			$this->cache_events( $response_body, $expiration );169 170			$response_body['events'] = $this->trim_events( $response_body['events'] );

Changelog

Introduced in 4.8.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.9.7 tag, from src/wp-admin/includes/class-wp-community-events.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.