Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* REST API: WP_REST_Search_Handler class

[2] Fix | Delete

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage REST_API

[5] Fix | Delete

* @since 5.0.0

[6] Fix | Delete

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Core base class representing a search handler for an object type in the REST API.

[10] Fix | Delete

[11] Fix | Delete

* @since 5.0.0

[12] Fix | Delete

[13] Fix | Delete

#[AllowDynamicProperties]

[14] Fix | Delete

abstract class WP_REST_Search_Handler {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Field containing the IDs in the search result.

[18] Fix | Delete

[19] Fix | Delete

const RESULT_IDS = 'ids';

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Field containing the total count in the search result.

[23] Fix | Delete

[24] Fix | Delete

const RESULT_TOTAL = 'total';

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Object type managed by this search handler.

[28] Fix | Delete

[29] Fix | Delete

* @since 5.0.0

[30] Fix | Delete

* @var string

[31] Fix | Delete

[32] Fix | Delete

protected $type = '';

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Object subtypes managed by this search handler.

[36] Fix | Delete

[37] Fix | Delete

* @since 5.0.0

[38] Fix | Delete

* @var string[]

[39] Fix | Delete

[40] Fix | Delete

protected $subtypes = array();

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Gets the object type managed by this search handler.

[44] Fix | Delete

[45] Fix | Delete

* @since 5.0.0

[46] Fix | Delete

[47] Fix | Delete

* @return string Object type identifier.

[48] Fix | Delete

[49] Fix | Delete

public function get_type() {

[50] Fix | Delete

return $this->type;

[51] Fix | Delete

}

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* Gets the object subtypes managed by this search handler.

[55] Fix | Delete

[56] Fix | Delete

* @since 5.0.0

[57] Fix | Delete

[58] Fix | Delete

* @return string[] Array of object subtype identifiers.

[59] Fix | Delete

[60] Fix | Delete

public function get_subtypes() {

[61] Fix | Delete

return $this->subtypes;

[62] Fix | Delete

}

[63] Fix | Delete

[64] Fix | Delete

/**

[65] Fix | Delete

* Searches the object type content for a given search request.

[66] Fix | Delete

[67] Fix | Delete

* @since 5.0.0

[68] Fix | Delete

[69] Fix | Delete

* @param WP_REST_Request $request Full REST request.

[70] Fix | Delete

* @return array Associative array containing an `WP_REST_Search_Handler::RESULT_IDS` containing

[71] Fix | Delete

* an array of found IDs and `WP_REST_Search_Handler::RESULT_TOTAL` containing the

[72] Fix | Delete

* total count for the matching search results.

[73] Fix | Delete

[74] Fix | Delete

abstract public function search_items( WP_REST_Request $request );

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* Prepares the search result for a given ID.

[78] Fix | Delete

[79] Fix | Delete

* @since 5.0.0

[80] Fix | Delete

* @since 5.6.0 The `$id` parameter can accept a string.

[81] Fix | Delete

[82] Fix | Delete

* @param int|string $id Item ID.

[83] Fix | Delete

* @param array $fields Fields to include for the item.

[84] Fix | Delete

* @return array Associative array containing all fields for the item.

[85] Fix | Delete

[86] Fix | Delete

abstract public function prepare_item( $id, array $fields );

[87] Fix | Delete

[88] Fix | Delete

/**

[89] Fix | Delete

* Prepares links for the search result of a given ID.

[90] Fix | Delete

[91] Fix | Delete

* @since 5.0.0

[92] Fix | Delete

* @since 5.6.0 The `$id` parameter can accept a string.

[93] Fix | Delete

[94] Fix | Delete

* @param int|string $id Item ID.

[95] Fix | Delete

* @return array Links for the given item.

[96] Fix | Delete

[97] Fix | Delete

abstract public function prepare_item_links( $id );

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete