WP_Customize_Manager::get_lock_user_data( int $user_id ): array|null

Compatibility

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

Parameters

$user_idint

User ID.

Return value

array|null

User data formatted for client.

Performance profile

How much work a call to WP_Customize_Manager::get_lock_user_data() 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

3–25

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

4

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

What it touches

• optionoption read or writeget_option()called directly
• querycontent queryget_user_by()one call below WP_Customize_Manager::get_lock_user_data()
• hookthird-party callbacksapply_filters()one call below WP_Customize_Manager::get_lock_user_data()
• cacheobject cachewp_cache_get()one call below WP_Customize_Manager::get_lock_user_data()
• serializeserialisationmaybe_unserialize()one call below WP_Customize_Manager::get_lock_user_data()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 4 distinct outcomes

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

Uses · 3

• get_userdata()Retrieves user info by user ID.
• get_option()Retrieves an option value based on an option name.
• get_avatar_url()Retrieves the avatar URL.

Used by · 4

• WP_Customize_Manager::check_changeset_lock_with_heartbeat()Checks locked changeset with heartbeat API.
• WP_Customize_Manager::customize_pane_settings()Prints JavaScript settings for parent window.
• WP_Customize_Manager::handle_changeset_trash_request()Handles request to trash a changeset.
• WP_Customize_Manager::save()Handles customize_save WP Ajax request to save/update a changeset.

Source code

View on Trac ↗View on GitHub ↗

3326	protected function get_lock_user_data( $user_id ) {3327		if ( ! $user_id ) {3328			return null;3329		}3330 3331		$lock_user = get_userdata( $user_id );3332 3333		if ( ! $lock_user ) {3334			return null;3335		}3336 3337		$user_details = array(3338			'id'   => $lock_user->ID,3339			'name' => $lock_user->display_name,3340		);3341 3342		if ( get_option( 'show_avatars' ) ) {3343			$user_details['avatar'] = get_avatar_url( $lock_user->ID, array( 'size' => 128 ) );3344		}3345 3346		return $user_details;3347	}

Changelog

Introduced in 4.9.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-includes/class-wp-customize-manager.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.