WP_Community_Events

17#[AllowDynamicProperties]18class WP_Community_Events {19	/**20	 * ID for a WordPress user account.21	 *22	 * @since 4.8.023	 *24	 * @var int25	 */26	protected $user_id = 0;27 28	/**29	 * Stores location data for the user.30	 *31	 * @since 4.8.032	 *33	 * @var false|array34	 */35	protected $user_location = false;36 37	/**38	 * Constructor for WP_Community_Events.39	 *40	 * @since 4.8.041	 *42	 * @param int        $user_id       WP user ID.43	 * @param false|array $user_location {44	 *     Stored location data for the user. false to pass no location.45	 *46	 *     @type string $description The name of the location47	 *     @type string $latitude    The latitude in decimal degrees notation, without the degree48	 *                               symbol. e.g.: 47.615200.49	 *     @type string $longitude   The longitude in decimal degrees notation, without the degree50	 *                               symbol. e.g.: -122.341100.51	 *     @type string $country     The ISO 3166-1 alpha-2 country code. e.g.: BR52	 * }53	 */54	public function __construct( $user_id, $user_location = false ) {55		$this->user_id       = absint( $user_id );56		$this->user_location = $user_location;57	}58 59	/**60	 * Gets data about events near a particular location.61	 *62	 * Cached events will be immediately returned if the `user_location` property63	 * is set for the current user, and cached events exist for that location.64	 *65	 * Otherwise, this method sends a request to the w.org Events API with location66	 * data. The API will send back a recognized location based on the data, along67	 * with nearby events.68	 *69	 * The browser's request for events is proxied with this method, rather70	 * than having the browser make the request directly to api.wordpress.org,71	 * because it allows results to be cached server-side and shared with other72	 * users and sites in the network. This makes the process more efficient,73	 * since increasing the number of visits that get cached data means users74	 * don't have to wait as often; if the user's browser made the request75	 * directly, it would also need to make a second request to WP in order to76	 * pass the data for caching. Having WP make the request also introduces77	 * the opportunity to anonymize the IP before sending it to w.org, which78	 * mitigates possible privacy concerns.79	 *80	 * @since 4.8.081	 * @since 5.5.2 Response no longer contains formatted date field. They're added82	 *              in `wp.communityEvents.populateDynamicEventFields()` now.83	 *84	 * @param string $location_search Optional. City name to help determine the location.85	 *                                e.g., "Seattle". Default empty string.86	 * @param string $timezone        Optional. Timezone to help determine the location.87	 *                                Default empty string.88	 * @return array|WP_Error A WP_Error on failure; an array with location and events on89	 *                        success.90	 */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		}