wppaste
WordPress

WP_Community_Events::get_request_args( string $search = '', string $timezone = '' ): array

Since
4.8.0
Source
wp-admin/includes/class-wp-community-events.php:185
Builds an array of args to use in an HTTP request to the w.org Events API.

Compatibility

WordPress
since 4.8.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$searchstringoptional
City search string. Default empty string.Default: ''
$timezonestringoptional
Timezone string. Default empty string.Default: ''

Return value

array
The request args.

Performance profile

How much work a call to WP_Community_Events::get_request_args() 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
Heavy

Reaches the database via get_user_by().

Scaling
Constant

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

Instructions
20–30

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

  • querycontent queryget_user_by()one call below WP_Community_Events::get_request_args()

Further down the call graph this can also reach hook, option, cache, serialize 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 · 2 distinct outcomes

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

WhenInstructionsCalls it makes
always20–30::get_unsafe_client_ip(), get_user_locale()
empty($search) && isset($value)26::get_unsafe_client_ip()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 39 instructions, 20–30 executed per call, 5 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

Used by · 1

Source code

View on Trac View on GitHub 

	protected function get_request_args( $search = '', $timezone = '' ) {		$args = array(			'number' => 5, // Get more than three in case some get trimmed out.			'ip'     => self::get_unsafe_client_ip(),		); 		/*		 * Include the minimal set of necessary arguments, in order to increase the		 * chances of a cache-hit on the API side.		 */		if ( empty( $search ) && isset( $this->user_location['latitude'], $this->user_location['longitude'] ) ) {			$args['latitude']  = $this->user_location['latitude'];			$args['longitude'] = $this->user_location['longitude'];		} else {			$args['locale'] = get_user_locale( $this->user_id ); 			if ( $timezone ) {				$args['timezone'] = $timezone;			} 			if ( $search ) {				$args['location'] = $search;			}		} 		// Wrap the args in an array compatible with the second parameter of `wp_remote_get()`.		return array(			'body' => $args,		);	}

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.7.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.