WP_REST_Posts_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_Posts_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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

8–279

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

Plugin surface

1 hook

Third-party callbacks on 'rest_{$this->post_type}_item_schema' run inside this call, and their cost is not bounded by anything here.

Called by

6

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

What it touches

• hookthird-party callbacksapply_filters()called directly

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

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

Hooks and filters fired · 1

One hook fires while WP_REST_Posts_Controller::get_item_schema() runs, in this order:

1. 1
   apply_filters( rest_{$this->post_type}_item_schema )filterline 2818 (+414 into the body)

   Filters the post's schema.

Uses · 12

• __()Retrieves the translation of $text.
• get_post_stati()Gets a list of post statuses.
• get_post_type_object()Retrieves a post type object by name.
• is_post_type_viewable()Determines whether a post type is considered "viewable".
• post_type_supports()Checks a post type's support for a given feature.
• get_post_format_slugs()Retrieves the array of post format slugs.
• wp_list_filter()Filters a list of objects, based on a set of key => value arguments.
• get_object_taxonomies()Returns the names or objects of the taxonomies which are registered for the requested object or object type, such as a post object or post type name.
• _doing_it_wrong()Marks something as being incorrectly called.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_REST_Posts_Controller::add_additional_fields_schema()
• WP_REST_Posts_Controller::get_schema_links()Retrieves Link Description Objects that should be added to the Schema for the posts collection.

Used by · 6

• WP_REST_Attachments_Controller::get_item_schema()Retrieves the attachment's schema, conforming to JSON Schema.
• WP_REST_Blocks_Controller::get_item_schema()Retrieves the pattern's schema, conforming to JSON Schema.
• WP_REST_Posts_Controller::create_item()Creates a single post.
• WP_REST_Posts_Controller::prepare_item_for_database()Prepares a single post for create or update.
• WP_REST_Posts_Controller::register_routes()Registers the routes for posts.
• WP_REST_Posts_Controller::update_item()Updates a single post.

Source code

View on Trac ↗View on GitHub ↗

2404	public function get_item_schema() {2405		if ( $this->schema ) {2406			return $this->add_additional_fields_schema( $this->schema );2407		}2408 2409		$schema = array(2410			'$schema'    => 'http://json-schema.org/draft-04/schema#',2411			'title'      => $this->post_type,2412			'type'       => 'object',2413			// Base properties for every Post.2414			'properties' => array(2415				'date'         => array(2416					'description' => __( "The date the post was published, in the site's timezone." ),2417					'type'        => array( 'string', 'null' ),2418					'format'      => 'date-time',2419					'context'     => array( 'view', 'edit', 'embed' ),2420				),2421				'date_gmt'     => array(2422					'description' => __( 'The date the post was published, as GMT.' ),2423					'type'        => array( 'string', 'null' ),2424					'format'      => 'date-time',2425					'context'     => array( 'view', 'edit' ),2426				),2427				'guid'         => array(2428					'description' => __( 'The globally unique identifier for the post.' ),2429					'type'        => 'object',2430					'context'     => array( 'view', 'edit' ),2431					'readonly'    => true,2432					'properties'  => array(2433						'raw'      => array(2434							'description' => __( 'GUID for the post, as it exists in the database.' ),2435							'type'        => 'string',2436							'context'     => array( 'edit' ),2437							'readonly'    => true,2438						),2439						'rendered' => array(2440							'description' => __( 'GUID for the post, transformed for display.' ),2441							'type'        => 'string',2442							'context'     => array( 'view', 'edit' ),2443							'readonly'    => true,2444						),2445					),2446				),2447				'id'           => array(2448					'description' => __( 'Unique identifier for the post.' ),2449					'type'        => 'integer',2450					'context'     => array( 'view', 'edit', 'embed' ),2451					'readonly'    => true,2452				),2453				'link'         => array(2454					'description' => __( 'URL to the post.' ),2455					'type'        => 'string',2456					'format'      => 'uri',2457					'context'     => array( 'view', 'edit', 'embed' ),2458					'readonly'    => true,2459				),2460				'modified'     => array(2461					'description' => __( "The date the post was last modified, in the site's timezone." ),2462					'type'        => 'string',2463					'format'      => 'date-time',2464					'context'     => array( 'view', 'edit' ),2465					'readonly'    => true,2466				),2467				'modified_gmt' => array(2468					'description' => __( 'The date the post was last modified, as GMT.' ),2469					'type'        => 'string',2470					'format'      => 'date-time',2471					'context'     => array( 'view', 'edit' ),2472					'readonly'    => true,2473				),2474				'slug'         => array(2475					'description' => __( 'An alphanumeric identifier for the post unique to its type.' ),2476					'type'        => 'string',2477					'context'     => array( 'view', 'edit', 'embed' ),2478					'arg_options' => array(2479						'sanitize_callback' => array( $this, 'sanitize_slug' ),2480					),2481				),2482				'status'       => array(2483					'description' => __( 'A named status for the post.' ),

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 7.1.0 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-posts-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.