WP_REST_Posts_Controller::prepare_links( WP_Post $post ): array

Compatibility

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

Parameters

$postWP_Post

Post object.

Return value

array

Links for the given post.

Performance profile

How much work a call to WP_REST_Posts_Controller::prepare_links() 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_post().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

81–208

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

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

• querycontent queryget_post()one call below WP_REST_Posts_Controller::prepare_links()
• hookthird-party callbacksapply_filters()one call below WP_REST_Posts_Controller::prepare_links()

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

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 13

• rest_url()Retrieves the URL to a REST endpoint.
• rest_get_route_for_post()Gets the REST API route for a post.
• rest_get_route_for_post_type_items()Gets the REST API route for a post type.
• post_type_supports()Checks a post type's support for a given feature.
• add_query_arg()Retrieves a modified URL query string.
• wp_get_latest_revision_id_and_total_count()Returns the latest revision ID and count of revisions for a post.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• get_post_type_object()Retrieves a post type object by name.
• get_post_thumbnail_id()Retrieves the post thumbnail ID.
• get_post_status()Retrieves the post status based on the post ID.
• current_user_can()Returns whether the current user has the specified capability.
• 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.

Used by · 4

• WP_REST_Attachments_Controller::prepare_links()Prepares attachment links for the request.
• WP_REST_Font_Families_Controller::prepare_links()Prepares font family links for the request.
• WP_REST_Menu_Items_Controller::prepare_links()Prepares links for the request.
• WP_REST_Posts_Controller::prepare_item_for_response()Prepares a single post output for response.

Source code

View on Trac ↗View on GitHub ↗

2225	protected function prepare_links( $post ) {2226		// Entity meta.2227		$links = array(2228			'self'       => array(2229				'href' => rest_url( rest_get_route_for_post( $post->ID ) ),2230			),2231			'collection' => array(2232				'href' => rest_url( rest_get_route_for_post_type_items( $this->post_type ) ),2233			),2234			'about'      => array(2235				'href' => rest_url( 'wp/v2/types/' . $this->post_type ),2236			),2237		);2238 2239		if ( ( in_array( $post->post_type, array( 'post', 'page' ), true ) || post_type_supports( $post->post_type, 'author' ) )2240			&& ! empty( $post->post_author ) ) {2241			$links['author'] = array(2242				'href'       => rest_url( 'wp/v2/users/' . $post->post_author ),2243				'embeddable' => true,2244			);2245		}2246 2247		if ( in_array( $post->post_type, array( 'post', 'page' ), true ) || post_type_supports( $post->post_type, 'comments' ) ) {2248			$replies_url = rest_url( 'wp/v2/comments' );2249			$replies_url = add_query_arg( 'post', $post->ID, $replies_url );2250 2251			$links['replies'] = array(2252				'href'       => $replies_url,2253				'embeddable' => true,2254			);2255		}2256 2257		if ( in_array( $post->post_type, array( 'post', 'page' ), true ) || post_type_supports( $post->post_type, 'revisions' ) ) {2258			$revisions       = wp_get_latest_revision_id_and_total_count( $post->ID );2259			$revisions_count = ! is_wp_error( $revisions ) ? $revisions['count'] : 0;2260			$revisions_base  = sprintf( '/%s/%s/%d/revisions', $this->namespace, $this->rest_base, $post->ID );2261 2262			$links['version-history'] = array(2263				'href'  => rest_url( $revisions_base ),2264				'count' => $revisions_count,2265			);2266 2267			if ( $revisions_count > 0 ) {2268				$links['predecessor-version'] = array(2269					'href' => rest_url( $revisions_base . '/' . $revisions['latest_id'] ),2270					'id'   => $revisions['latest_id'],2271				);2272			}2273		}2274 2275		$post_type_obj = get_post_type_object( $post->post_type );2276 2277		if ( $post_type_obj->hierarchical && ! empty( $post->post_parent ) ) {2278			$links['up'] = array(2279				'href'       => rest_url( rest_get_route_for_post( $post->post_parent ) ),2280				'embeddable' => true,2281			);2282		}2283 2284		// If we have a featured media, add that.2285		$featured_media = get_post_thumbnail_id( $post->ID );2286		if ( $featured_media && ( 'publish' === get_post_status( $featured_media ) || current_user_can( 'read_post', $featured_media ) ) ) {2287			$image_url = rest_url( rest_get_route_for_post( $featured_media ) );2288 2289			$links['https://api.w.org/featuredmedia'] = array(2290				'href'       => $image_url,2291				'embeddable' => true,2292			);2293		}2294 2295		if ( ! in_array( $post->post_type, array( 'attachment', 'nav_menu_item', 'revision' ), true ) ) {2296			$attachments_url = rest_url( rest_get_route_for_post_type_items( 'attachment' ) );2297			$attachments_url = add_query_arg( 'parent', $post->ID, $attachments_url );2298 2299			$links['https://api.w.org/attachment'] = array(2300				'href' => $attachments_url,2301			);2302		}2303 2304		$taxonomies = get_object_taxonomies( $post->post_type );

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.