WP_REST_Menu_Items_Controller::prepare_item_for_response( WP_Post $item, WP_REST_Request $request ): WP_REST_Response

Parameters

$itemWP_Post

Post object.

$requestWP_REST_Request

Request object.

Return

WP_REST_Response

Response object.

Hooks fired · 2

2 hooks fire while WP_REST_Menu_Items_Controller::prepare_item_for_response() runs, in this order:

1. 1
   apply_filters( the_title )filterline 516 (+23 into the body)

   Filters the post title.

2. 2
   apply_filters( rest_prepare_nav_menu_item )filterline 639 (+146 into the body)

   Filters the menu item data for a REST API response.

Uses · 16

• rest_is_field_included()Given an array of fields to include in a response, some of which may be `nested.fields`, determine whether the provided field should be included in the response body.
• add_filter()Adds a callback function to a filter hook.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• remove_filter()Removes a callback function from a filter hook.
• absint()Converts a value to non-negative integer.
• 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.
• get_the_terms()Retrieves the terms of the taxonomy that are attached to the post.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• WP_REST_Menu_Items_Controller::get_fields_for_response()
• WP_REST_Menu_Items_Controller::get_nav_menu_item()Gets the nav menu item, if the ID is valid.

Used by · 3

• WP_REST_Menu_Items_Controller::create_item()Creates a single nav menu item.
• WP_REST_Menu_Items_Controller::delete_item()Deletes a single nav menu item.
• WP_REST_Menu_Items_Controller::update_item()Updates a single nav menu item.

Source

View on Trac ↗View on GitHub ↗

493	public function prepare_item_for_response( $item, $request ) {494		// Base fields for every post.495		$fields    = $this->get_fields_for_response( $request );496		$menu_item = $this->get_nav_menu_item( $item->ID );497		$data      = array();498 499		if ( rest_is_field_included( 'id', $fields ) ) {500			$data['id'] = $menu_item->ID;501		}502 503		if ( rest_is_field_included( 'title', $fields ) ) {504			$data['title'] = array();505		}506 507		if ( rest_is_field_included( 'title.raw', $fields ) ) {508			$data['title']['raw'] = $menu_item->title;509		}510 511		if ( rest_is_field_included( 'title.rendered', $fields ) ) {512			add_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );513			add_filter( 'private_title_format', array( $this, 'protected_title_format' ) );514 515			/** This filter is documented in wp-includes/post-template.php */516			$title = apply_filters( 'the_title', $menu_item->title, $menu_item->ID );517 518			$data['title']['rendered'] = $title;519 520			remove_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );521			remove_filter( 'private_title_format', array( $this, 'protected_title_format' ) );522		}523 524		if ( rest_is_field_included( 'status', $fields ) ) {525			$data['status'] = $menu_item->post_status;526		}527 528		if ( rest_is_field_included( 'url', $fields ) ) {529			$data['url'] = $menu_item->url;530		}531 532		if ( rest_is_field_included( 'attr_title', $fields ) ) {533			// Same as post_excerpt.534			$data['attr_title'] = $menu_item->attr_title;535		}536 537		if ( rest_is_field_included( 'description', $fields ) ) {538			// Same as post_content.539			$data['description'] = $menu_item->description;540		}541 542		if ( rest_is_field_included( 'type', $fields ) ) {543			$data['type'] = $menu_item->type;544		}545 546		if ( rest_is_field_included( 'type_label', $fields ) ) {547			$data['type_label'] = $menu_item->type_label;548		}549 550		if ( rest_is_field_included( 'object', $fields ) ) {551			$data['object'] = $menu_item->object;552		}553 554		if ( rest_is_field_included( 'object_id', $fields ) ) {555			// It is stored as a string, but should be exposed as an integer.556			$data['object_id'] = absint( $menu_item->object_id );557		}558 559		if ( rest_is_field_included( 'parent', $fields ) ) {560			// Same as post_parent, exposed as an integer.561			$data['parent'] = (int) $menu_item->menu_item_parent;562		}563 564		if ( rest_is_field_included( 'menu_order', $fields ) ) {565			// Same as post_parent, exposed as an integer.566			$data['menu_order'] = (int) $menu_item->menu_order;567		}568 569		if ( rest_is_field_included( 'target', $fields ) ) {570			$data['target'] = $menu_item->target;571		}572

History

Introduced in 5.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/rest-api/endpoints/class-wp-rest-menu-items-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.