Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* REST API: WP_REST_Taxonomies_Controller class

[2] Fix | Delete

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage REST_API

[5] Fix | Delete

* @since 4.7.0

[6] Fix | Delete

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Core class used to manage taxonomies via the REST API.

[10] Fix | Delete

[11] Fix | Delete

* @since 4.7.0

[12] Fix | Delete

[13] Fix | Delete

* @see WP_REST_Controller

[14] Fix | Delete

[15] Fix | Delete

class WP_REST_Taxonomies_Controller extends WP_REST_Controller {

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* Constructor.

[19] Fix | Delete

[20] Fix | Delete

* @since 4.7.0

[21] Fix | Delete

[22] Fix | Delete

public function __construct() {

[23] Fix | Delete

$this->namespace = 'wp/v2';

[24] Fix | Delete

$this->rest_base = 'taxonomies';

[25] Fix | Delete

}

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* Registers the routes for taxonomies.

[29] Fix | Delete

[30] Fix | Delete

* @since 4.7.0

[31] Fix | Delete

[32] Fix | Delete

* @see register_rest_route()

[33] Fix | Delete

[34] Fix | Delete

public function register_routes() {

[35] Fix | Delete

[36] Fix | Delete

register_rest_route(

[37] Fix | Delete

$this->namespace,

[38] Fix | Delete

'/' . $this->rest_base,

[39] Fix | Delete

array(

[40] Fix | Delete

array(

[41] Fix | Delete

'methods' => WP_REST_Server::READABLE,

[42] Fix | Delete

'callback' => array( $this, 'get_items' ),

[43] Fix | Delete

'permission_callback' => array( $this, 'get_items_permissions_check' ),

[44] Fix | Delete

'args' => $this->get_collection_params(),

[45] Fix | Delete

[46] Fix | Delete

'schema' => array( $this, 'get_public_item_schema' ),

[47] Fix | Delete

)

[48] Fix | Delete

);

[49] Fix | Delete

[50] Fix | Delete

register_rest_route(

[51] Fix | Delete

$this->namespace,

[52] Fix | Delete

'/' . $this->rest_base . '/(?P<taxonomy>[\w-]+)',

[53] Fix | Delete

array(

[54] Fix | Delete

'args' => array(

[55] Fix | Delete

'taxonomy' => array(

[56] Fix | Delete

'description' => __( 'An alphanumeric identifier for the taxonomy.' ),

[57] Fix | Delete

'type' => 'string',

[58] Fix | Delete

[59] Fix | Delete

[60] Fix | Delete

array(

[61] Fix | Delete

'methods' => WP_REST_Server::READABLE,

[62] Fix | Delete

'callback' => array( $this, 'get_item' ),

[63] Fix | Delete

'permission_callback' => array( $this, 'get_item_permissions_check' ),

[64] Fix | Delete

'args' => array(

[65] Fix | Delete

'context' => $this->get_context_param( array( 'default' => 'view' ) ),

[66] Fix | Delete

[67] Fix | Delete

[68] Fix | Delete

'schema' => array( $this, 'get_public_item_schema' ),

[69] Fix | Delete

)

[70] Fix | Delete

);

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

/**

[74] Fix | Delete

* Checks whether a given request has permission to read taxonomies.

[75] Fix | Delete

[76] Fix | Delete

* @since 4.7.0

[77] Fix | Delete

[78] Fix | Delete

* @param WP_REST_Request $request Full details about the request.

[79] Fix | Delete

* @return true|WP_Error True if the request has read access, WP_Error object otherwise.

[80] Fix | Delete

[81] Fix | Delete

public function get_items_permissions_check( $request ) {

[82] Fix | Delete

if ( 'edit' === $request['context'] ) {

[83] Fix | Delete

if ( ! empty( $request['type'] ) ) {

[84] Fix | Delete

$taxonomies = get_object_taxonomies( $request['type'], 'objects' );

[85] Fix | Delete

} else {

[86] Fix | Delete

$taxonomies = get_taxonomies( '', 'objects' );

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

foreach ( $taxonomies as $taxonomy ) {

[90] Fix | Delete

if ( ! empty( $taxonomy->show_in_rest ) && current_user_can( $taxonomy->cap->assign_terms ) ) {

[91] Fix | Delete

return true;

[92] Fix | Delete

}

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

return new WP_Error(

[96] Fix | Delete

'rest_cannot_view',

[97] Fix | Delete

__( 'Sorry, you are not allowed to manage terms in this taxonomy.' ),

[98] Fix | Delete

array( 'status' => rest_authorization_required_code() )

[99] Fix | Delete

);

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

return true;

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

/**

[106] Fix | Delete

* Retrieves all public taxonomies.

[107] Fix | Delete

[108] Fix | Delete

* @since 4.7.0

[109] Fix | Delete

[110] Fix | Delete

* @param WP_REST_Request $request Full details about the request.

[111] Fix | Delete

* @return WP_REST_Response Response object on success, or WP_Error object on failure.

[112] Fix | Delete

[113] Fix | Delete

public function get_items( $request ) {

[114] Fix | Delete

[115] Fix | Delete

// Retrieve the list of registered collection query parameters.

[116] Fix | Delete

$registered = $this->get_collection_params();

[117] Fix | Delete

[118] Fix | Delete

if ( isset( $registered['type'] ) && ! empty( $request['type'] ) ) {

[119] Fix | Delete

$taxonomies = get_object_taxonomies( $request['type'], 'objects' );

[120] Fix | Delete

} else {

[121] Fix | Delete

$taxonomies = get_taxonomies( '', 'objects' );

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

$data = array();

[125] Fix | Delete

[126] Fix | Delete

foreach ( $taxonomies as $tax_type => $value ) {

[127] Fix | Delete

if ( empty( $value->show_in_rest ) || ( 'edit' === $request['context'] && ! current_user_can( $value->cap->assign_terms ) ) ) {

[128] Fix | Delete

continue;

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

$tax = $this->prepare_item_for_response( $value, $request );

[132] Fix | Delete

$tax = $this->prepare_response_for_collection( $tax );

[133] Fix | Delete

$data[ $tax_type ] = $tax;

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

if ( empty( $data ) ) {

[137] Fix | Delete

// Response should still be returned as a JSON object when it is empty.

[138] Fix | Delete

$data = (object) $data;

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

return rest_ensure_response( $data );

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

/**

[145] Fix | Delete

* Checks if a given request has access to a taxonomy.

[146] Fix | Delete

[147] Fix | Delete

* @since 4.7.0

[148] Fix | Delete

[149] Fix | Delete

* @param WP_REST_Request $request Full details about the request.

[150] Fix | Delete

* @return true|WP_Error True if the request has read access for the item, otherwise false or WP_Error object.

[151] Fix | Delete

[152] Fix | Delete

public function get_item_permissions_check( $request ) {

[153] Fix | Delete

[154] Fix | Delete

$tax_obj = get_taxonomy( $request['taxonomy'] );

[155] Fix | Delete

[156] Fix | Delete

if ( $tax_obj ) {

[157] Fix | Delete

if ( empty( $tax_obj->show_in_rest ) ) {

[158] Fix | Delete

return false;

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

if ( 'edit' === $request['context'] && ! current_user_can( $tax_obj->cap->assign_terms ) ) {

[162] Fix | Delete

return new WP_Error(

[163] Fix | Delete

'rest_forbidden_context',

[164] Fix | Delete

__( 'Sorry, you are not allowed to manage terms in this taxonomy.' ),

[165] Fix | Delete

array( 'status' => rest_authorization_required_code() )

[166] Fix | Delete

);

[167] Fix | Delete

}

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

return true;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* Retrieves a specific taxonomy.

[175] Fix | Delete

[176] Fix | Delete

* @since 4.7.0

[177] Fix | Delete

[178] Fix | Delete

* @param WP_REST_Request $request Full details about the request.

[179] Fix | Delete

* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.

[180] Fix | Delete

[181] Fix | Delete

public function get_item( $request ) {

[182] Fix | Delete

$tax_obj = get_taxonomy( $request['taxonomy'] );

[183] Fix | Delete

[184] Fix | Delete

if ( empty( $tax_obj ) ) {

[185] Fix | Delete

return new WP_Error(

[186] Fix | Delete

'rest_taxonomy_invalid',

[187] Fix | Delete

__( 'Invalid taxonomy.' ),

[188] Fix | Delete

array( 'status' => 404 )

[189] Fix | Delete

);

[190] Fix | Delete

}

[191] Fix | Delete

[192] Fix | Delete

$data = $this->prepare_item_for_response( $tax_obj, $request );

[193] Fix | Delete

[194] Fix | Delete

return rest_ensure_response( $data );

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete

/**

[198] Fix | Delete

* Prepares a taxonomy object for serialization.

[199] Fix | Delete

[200] Fix | Delete

* @since 4.7.0

[201] Fix | Delete

* @since 5.9.0 Renamed `$taxonomy` to `$item` to match parent class for PHP 8 named parameter support.

[202] Fix | Delete

[203] Fix | Delete

* @param WP_Taxonomy $item Taxonomy data.

[204] Fix | Delete

* @param WP_REST_Request $request Full details about the request.

[205] Fix | Delete

* @return WP_REST_Response Response object.

[206] Fix | Delete

[207] Fix | Delete

public function prepare_item_for_response( $item, $request ) {

[208] Fix | Delete

// Restores the more descriptive, specific name for use within this method.

[209] Fix | Delete

$taxonomy = $item;

[210] Fix | Delete

[211] Fix | Delete

$base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;

[212] Fix | Delete

[213] Fix | Delete

$fields = $this->get_fields_for_response( $request );

[214] Fix | Delete

$data = array();

[215] Fix | Delete

[216] Fix | Delete

if ( in_array( 'name', $fields, true ) ) {

[217] Fix | Delete

$data['name'] = $taxonomy->label;

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

if ( in_array( 'slug', $fields, true ) ) {

[221] Fix | Delete

$data['slug'] = $taxonomy->name;

[222] Fix | Delete

}

[223] Fix | Delete

[224] Fix | Delete

if ( in_array( 'capabilities', $fields, true ) ) {

[225] Fix | Delete

$data['capabilities'] = $taxonomy->cap;

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

if ( in_array( 'description', $fields, true ) ) {

[229] Fix | Delete

$data['description'] = $taxonomy->description;

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

if ( in_array( 'labels', $fields, true ) ) {

[233] Fix | Delete

$data['labels'] = $taxonomy->labels;

[234] Fix | Delete

}

[235] Fix | Delete

[236] Fix | Delete

if ( in_array( 'types', $fields, true ) ) {

[237] Fix | Delete

$data['types'] = array_values( $taxonomy->object_type );

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

if ( in_array( 'show_cloud', $fields, true ) ) {

[241] Fix | Delete

$data['show_cloud'] = $taxonomy->show_tagcloud;

[242] Fix | Delete

}

[243] Fix | Delete

[244] Fix | Delete

if ( in_array( 'hierarchical', $fields, true ) ) {

[245] Fix | Delete

$data['hierarchical'] = $taxonomy->hierarchical;

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete

if ( in_array( 'rest_base', $fields, true ) ) {

[249] Fix | Delete

$data['rest_base'] = $base;

[250] Fix | Delete

}

[251] Fix | Delete

[252] Fix | Delete

if ( in_array( 'rest_namespace', $fields, true ) ) {

[253] Fix | Delete

$data['rest_namespace'] = $taxonomy->rest_namespace;

[254] Fix | Delete

}

[255] Fix | Delete

[256] Fix | Delete

if ( in_array( 'visibility', $fields, true ) ) {

[257] Fix | Delete

$data['visibility'] = array(

[258] Fix | Delete

'public' => (bool) $taxonomy->public,

[259] Fix | Delete

'publicly_queryable' => (bool) $taxonomy->publicly_queryable,

[260] Fix | Delete

'show_admin_column' => (bool) $taxonomy->show_admin_column,

[261] Fix | Delete

'show_in_nav_menus' => (bool) $taxonomy->show_in_nav_menus,

[262] Fix | Delete

'show_in_quick_edit' => (bool) $taxonomy->show_in_quick_edit,

[263] Fix | Delete

'show_ui' => (bool) $taxonomy->show_ui,

[264] Fix | Delete

);

[265] Fix | Delete

}

[266] Fix | Delete

[267] Fix | Delete

$context = ! empty( $request['context'] ) ? $request['context'] : 'view';

[268] Fix | Delete

$data = $this->add_additional_fields_to_object( $data, $request );

[269] Fix | Delete

$data = $this->filter_response_by_context( $data, $context );

[270] Fix | Delete

[271] Fix | Delete

// Wrap the data in a response object.

[272] Fix | Delete

$response = rest_ensure_response( $data );

[273] Fix | Delete

[274] Fix | Delete

if ( rest_is_field_included( '_links', $fields ) || rest_is_field_included( '_embedded', $fields ) ) {

[275] Fix | Delete

$response->add_links( $this->prepare_links( $taxonomy ) );

[276] Fix | Delete

}

[277] Fix | Delete

[278] Fix | Delete

/**

[279] Fix | Delete

* Filters a taxonomy returned from the REST API.

[280] Fix | Delete

[281] Fix | Delete

* Allows modification of the taxonomy data right before it is returned.

[282] Fix | Delete

[283] Fix | Delete

* @since 4.7.0

[284] Fix | Delete

[285] Fix | Delete

* @param WP_REST_Response $response The response object.

[286] Fix | Delete

* @param WP_Taxonomy $item The original taxonomy object.

[287] Fix | Delete

* @param WP_REST_Request $request Request used to generate the response.

[288] Fix | Delete

[289] Fix | Delete

return apply_filters( 'rest_prepare_taxonomy', $response, $taxonomy, $request );

[290] Fix | Delete

}

[291] Fix | Delete

[292] Fix | Delete

/**

[293] Fix | Delete

* Prepares links for the request.

[294] Fix | Delete

[295] Fix | Delete

* @since 6.1.0

[296] Fix | Delete

[297] Fix | Delete

* @param WP_Taxonomy $taxonomy The taxonomy.

[298] Fix | Delete

* @return array Links for the given taxonomy.

[299] Fix | Delete

[300] Fix | Delete

protected function prepare_links( $taxonomy ) {

[301] Fix | Delete

return array(

[302] Fix | Delete

'collection' => array(

[303] Fix | Delete

'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ),

[304] Fix | Delete

[305] Fix | Delete

'https://api.w.org/items' => array(

[306] Fix | Delete

'href' => rest_url( rest_get_route_for_taxonomy_items( $taxonomy->name ) ),

[307] Fix | Delete

[308] Fix | Delete

);

[309] Fix | Delete

}

[310] Fix | Delete

[311] Fix | Delete

/**

[312] Fix | Delete

* Retrieves the taxonomy's schema, conforming to JSON Schema.

[313] Fix | Delete

[314] Fix | Delete

* @since 4.7.0

[315] Fix | Delete

* @since 5.0.0 The `visibility` property was added.

[316] Fix | Delete

* @since 5.9.0 The `rest_namespace` property was added.

[317] Fix | Delete

[318] Fix | Delete

* @return array Item schema data.

[319] Fix | Delete

[320] Fix | Delete

public function get_item_schema() {

[321] Fix | Delete

if ( $this->schema ) {

[322] Fix | Delete

return $this->add_additional_fields_schema( $this->schema );

[323] Fix | Delete

}

[324] Fix | Delete

[325] Fix | Delete

$schema = array(

[326] Fix | Delete

'$schema' => 'http://json-schema.org/draft-04/schema#',

[327] Fix | Delete

'title' => 'taxonomy',

[328] Fix | Delete

'type' => 'object',

[329] Fix | Delete

'properties' => array(

[330] Fix | Delete

'capabilities' => array(

[331] Fix | Delete

'description' => __( 'All capabilities used by the taxonomy.' ),

[332] Fix | Delete

'type' => 'object',

[333] Fix | Delete

'context' => array( 'edit' ),

[334] Fix | Delete

'readonly' => true,

[335] Fix | Delete

[336] Fix | Delete

'description' => array(

[337] Fix | Delete

'description' => __( 'A human-readable description of the taxonomy.' ),

[338] Fix | Delete

'type' => 'string',

[339] Fix | Delete

'context' => array( 'view', 'edit' ),

[340] Fix | Delete

'readonly' => true,

[341] Fix | Delete

[342] Fix | Delete

'hierarchical' => array(

[343] Fix | Delete

'description' => __( 'Whether or not the taxonomy should have children.' ),

[344] Fix | Delete

'type' => 'boolean',

[345] Fix | Delete

'context' => array( 'view', 'edit' ),

[346] Fix | Delete

'readonly' => true,

[347] Fix | Delete

[348] Fix | Delete

'labels' => array(

[349] Fix | Delete

'description' => __( 'Human-readable labels for the taxonomy for various contexts.' ),

[350] Fix | Delete

'type' => 'object',

[351] Fix | Delete

'context' => array( 'edit' ),

[352] Fix | Delete

'readonly' => true,

[353] Fix | Delete

[354] Fix | Delete

'name' => array(

[355] Fix | Delete

'description' => __( 'The title for the taxonomy.' ),

[356] Fix | Delete

'type' => 'string',

[357] Fix | Delete

'context' => array( 'view', 'edit', 'embed' ),

[358] Fix | Delete

'readonly' => true,

[359] Fix | Delete

[360] Fix | Delete

'slug' => array(

[361] Fix | Delete

'description' => __( 'An alphanumeric identifier for the taxonomy.' ),

[362] Fix | Delete

'type' => 'string',

[363] Fix | Delete

'context' => array( 'view', 'edit', 'embed' ),

[364] Fix | Delete

'readonly' => true,

[365] Fix | Delete

[366] Fix | Delete

'show_cloud' => array(

[367] Fix | Delete

'description' => __( 'Whether or not the term cloud should be displayed.' ),

[368] Fix | Delete

'type' => 'boolean',

[369] Fix | Delete

'context' => array( 'edit' ),

[370] Fix | Delete

'readonly' => true,

[371] Fix | Delete

[372] Fix | Delete

'types' => array(

[373] Fix | Delete

'description' => __( 'Types associated with the taxonomy.' ),

[374] Fix | Delete

'type' => 'array',

[375] Fix | Delete

'items' => array(

[376] Fix | Delete

'type' => 'string',

[377] Fix | Delete

[378] Fix | Delete

'context' => array( 'view', 'edit' ),

[379] Fix | Delete

'readonly' => true,

[380] Fix | Delete

[381] Fix | Delete

'rest_base' => array(

[382] Fix | Delete

'description' => __( 'REST base route for the taxonomy.' ),

[383] Fix | Delete

'type' => 'string',

[384] Fix | Delete

'context' => array( 'view', 'edit', 'embed' ),

[385] Fix | Delete

'readonly' => true,

[386] Fix | Delete

[387] Fix | Delete

'rest_namespace' => array(

[388] Fix | Delete

'description' => __( 'REST namespace route for the taxonomy.' ),

[389] Fix | Delete

'type' => 'string',

[390] Fix | Delete

'context' => array( 'view', 'edit', 'embed' ),

[391] Fix | Delete

'readonly' => true,

[392] Fix | Delete

[393] Fix | Delete

'visibility' => array(

[394] Fix | Delete

'description' => __( 'The visibility settings for the taxonomy.' ),

[395] Fix | Delete

'type' => 'object',

[396] Fix | Delete

'context' => array( 'edit' ),

[397] Fix | Delete

'readonly' => true,

[398] Fix | Delete

'properties' => array(

[399] Fix | Delete

'public' => array(

[400] Fix | Delete

'description' => __( 'Whether a taxonomy is intended for use publicly either via the admin interface or by front-end users.' ),

[401] Fix | Delete

'type' => 'boolean',

[402] Fix | Delete

[403] Fix | Delete

'publicly_queryable' => array(

[404] Fix | Delete

'description' => __( 'Whether the taxonomy is publicly queryable.' ),

[405] Fix | Delete

'type' => 'boolean',

[406] Fix | Delete

[407] Fix | Delete

'show_ui' => array(

[408] Fix | Delete

'description' => __( 'Whether to generate a default UI for managing this taxonomy.' ),

[409] Fix | Delete

'type' => 'boolean',

[410] Fix | Delete

[411] Fix | Delete

'show_admin_column' => array(

[412] Fix | Delete

'description' => __( 'Whether to allow automatic creation of taxonomy columns on associated post-types table.' ),

[413] Fix | Delete

'type' => 'boolean',

[414] Fix | Delete

[415] Fix | Delete

'show_in_nav_menus' => array(

[416] Fix | Delete

'description' => __( 'Whether to make the taxonomy available for selection in navigation menus.' ),

[417] Fix | Delete

'type' => 'boolean',

[418] Fix | Delete

[419] Fix | Delete

'show_in_quick_edit' => array(

[420] Fix | Delete

'description' => __( 'Whether to show the taxonomy in the quick/bulk edit panel.' ),

[421] Fix | Delete

'type' => 'boolean',

[422] Fix | Delete

[423] Fix | Delete

[424] Fix | Delete

[425] Fix | Delete

[426] Fix | Delete

[427] Fix | Delete

);

[428] Fix | Delete

[429] Fix | Delete

$this->schema = $schema;

[430] Fix | Delete

[431] Fix | Delete

return $this->add_additional_fields_schema( $this->schema );

[432] Fix | Delete

}

[433] Fix | Delete

[434] Fix | Delete

/**

[435] Fix | Delete

* Retrieves the query params for collections.

[436] Fix | Delete

[437] Fix | Delete

* @since 4.7.0

[438] Fix | Delete

[439] Fix | Delete

* @return array Collection parameters.

[440] Fix | Delete

[441] Fix | Delete

public function get_collection_params() {

[442] Fix | Delete

$new_params = array();

[443] Fix | Delete

$new_params['context'] = $this->get_context_param( array( 'default' => 'view' ) );

[444] Fix | Delete

$new_params['type'] = array(

[445] Fix | Delete

'description' => __( 'Limit results to taxonomies associated with a specific post type.' ),

[446] Fix | Delete

'type' => 'string',

[447] Fix | Delete

);

[448] Fix | Delete

return $new_params;

[449] Fix | Delete

}

[450] Fix | Delete

}

[451] Fix | Delete

[452] Fix | Delete