W3cubDocs

/WordPress

WP_Community_Events::get_events_transient_key( array $location )

Generates a transient key based on user location.

Description

This could be reduced to a one-liner in the calling functions, but it’s intentionally a separate function because it’s called from multiple functions, and having it abstracted keeps the logic consistent and DRY, which is less prone to errors.

Parameters

$location

(array) (Required) Should contain 'latitude' and 'longitude' indexes.

Return

(bool|string) false on failure, or a string on success.

Source

File: wp-admin/includes/class-wp-community-events.php 

protected function get_events_transient_key( $location ) {
		$key = false;

		if ( isset( $location['ip'] ) ) {
			$key = 'community-events-' . md5( $location['ip'] );
		} elseif ( isset( $location['latitude'], $location['longitude'] ) ) {
			$key = 'community-events-' . md5( $location['latitude'] . $location['longitude'] );
		}

		return $key;
	}

Changelog

Version Description
4.8.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_community_events/get_events_transient_key