WP_REST_Users_Controller::get_item_schema(): array

Compatibility

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

Return value

array

Item schema data.

Performance profile

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

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

8–201

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

3

3 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
• hookthird-party callbacksapply_filters()one call below WP_REST_Users_Controller::get_item_schema()
• cacheobject cachewp_cache_get()one call below WP_REST_Users_Controller::get_item_schema()
• serializeserialisationmaybe_unserialize()one call below WP_REST_Users_Controller::get_item_schema()

Further down the call graph this can also reach 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 · 3 distinct outcomes

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

Uses · 5

• __()Retrieves the translation of $text.
• get_available_languages()Gets all available languages based on the presence of *.mo and *.l10n.php files in a given directory.
• get_option()Retrieves an option value based on an option name.
• rest_get_avatar_sizes()Retrieves the pixel sizes for avatars.
• WP_REST_Users_Controller::add_additional_fields_schema()

Used by · 3

• WP_REST_Users_Controller::create_item()Creates a single user.
• WP_REST_Users_Controller::prepare_item_for_database()Prepares a single user for creation or update.
• WP_REST_Users_Controller::update_item()Updates a single user.

Source code

View on Trac ↗View on GitHub ↗

1396	public function get_item_schema() {1397		if ( $this->schema ) {1398			return $this->add_additional_fields_schema( $this->schema );1399		}1400 1401		$schema = array(1402			'$schema'    => 'http://json-schema.org/draft-04/schema#',1403			'title'      => 'user',1404			'type'       => 'object',1405			'properties' => array(1406				'id'                 => array(1407					'description' => __( 'Unique identifier for the user.' ),1408					'type'        => 'integer',1409					'context'     => array( 'embed', 'view', 'edit' ),1410					'readonly'    => true,1411				),1412				'username'           => array(1413					'description' => __( 'Login name for the user.' ),1414					'type'        => 'string',1415					'context'     => array( 'edit' ),1416					'required'    => true,1417					'arg_options' => array(1418						'sanitize_callback' => array( $this, 'check_username' ),1419					),1420				),1421				'name'               => array(1422					'description' => __( 'Display name for the user.' ),1423					'type'        => 'string',1424					'context'     => array( 'embed', 'view', 'edit' ),1425					'arg_options' => array(1426						'sanitize_callback' => 'sanitize_text_field',1427					),1428				),1429				'first_name'         => array(1430					'description' => __( 'First name for the user.' ),1431					'type'        => 'string',1432					'context'     => array( 'edit' ),1433					'arg_options' => array(1434						'sanitize_callback' => 'sanitize_text_field',1435					),1436				),1437				'last_name'          => array(1438					'description' => __( 'Last name for the user.' ),1439					'type'        => 'string',1440					'context'     => array( 'edit' ),1441					'arg_options' => array(1442						'sanitize_callback' => 'sanitize_text_field',1443					),1444				),1445				'email'              => array(1446					'description' => __( 'The email address for the user.' ),1447					'type'        => 'string',1448					'format'      => 'email',1449					'context'     => array( 'edit' ),1450					'required'    => true,1451				),1452				'url'                => array(1453					'description' => __( 'URL of the user.' ),1454					'type'        => 'string',1455					'format'      => 'uri',1456					'context'     => array( 'embed', 'view', 'edit' ),1457				),1458				'description'        => array(1459					'description' => __( 'Description of the user.' ),1460					'type'        => 'string',1461					'context'     => array( 'embed', 'view', 'edit' ),1462				),1463				'link'               => array(1464					'description' => __( 'Author URL of the user.' ),1465					'type'        => 'string',1466					'format'      => 'uri',1467					'context'     => array( 'embed', 'view', 'edit' ),1468					'readonly'    => true,1469				),1470				'locale'             => array(1471					'description' => __( 'Locale for the user.' ),1472					'type'        => 'string',1473					'enum'        => array_merge( array( '', 'en_US' ), get_available_languages() ),1474					'context'     => array( 'edit' ),1475				),

Changelog

Introduced in 4.7.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-includes/rest-api/endpoints/class-wp-rest-users-controller.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.