[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * REST API: WP_REST_Taxonomies_Controller class
   4   *
   5   * @package WordPress
   6   * @subpackage REST_API
   7   * @since 4.7.0
   8   */
   9  
  10  /**
  11   * Core class used to manage taxonomies via the REST API.
  12   *
  13   * @since 4.7.0
  14   *
  15   * @see WP_REST_Controller
  16   */
  17  class WP_REST_Taxonomies_Controller extends WP_REST_Controller {
  18  
  19      /**
  20       * Constructor.
  21       *
  22       * @since 4.7.0
  23       */
  24  	public function __construct() {
  25          $this->namespace = 'wp/v2';
  26          $this->rest_base = 'taxonomies';
  27      }
  28  
  29      /**
  30       * Registers the routes for taxonomies.
  31       *
  32       * @since 4.7.0
  33       *
  34       * @see register_rest_route()
  35       */
  36  	public function register_routes() {
  37  
  38          register_rest_route(
  39              $this->namespace,
  40              '/' . $this->rest_base,
  41              array(
  42                  array(
  43                      'methods'             => WP_REST_Server::READABLE,
  44                      'callback'            => array( $this, 'get_items' ),
  45                      'permission_callback' => array( $this, 'get_items_permissions_check' ),
  46                      'args'                => $this->get_collection_params(),
  47                  ),
  48                  'schema' => array( $this, 'get_public_item_schema' ),
  49              )
  50          );
  51  
  52          register_rest_route(
  53              $this->namespace,
  54              '/' . $this->rest_base . '/(?P<taxonomy>[\w-]+)',
  55              array(
  56                  'args'   => array(
  57                      'taxonomy' => array(
  58                          'description' => __( 'An alphanumeric identifier for the taxonomy.' ),
  59                          'type'        => 'string',
  60                      ),
  61                  ),
  62                  array(
  63                      'methods'             => WP_REST_Server::READABLE,
  64                      'callback'            => array( $this, 'get_item' ),
  65                      'permission_callback' => array( $this, 'get_item_permissions_check' ),
  66                      'args'                => array(
  67                          'context' => $this->get_context_param( array( 'default' => 'view' ) ),
  68                      ),
  69                  ),
  70                  'schema' => array( $this, 'get_public_item_schema' ),
  71              )
  72          );
  73      }
  74  
  75      /**
  76       * Checks whether a given request has permission to read taxonomies.
  77       *
  78       * @since 4.7.0
  79       *
  80       * @param WP_REST_Request $request Full details about the request.
  81       * @return true|WP_Error True if the request has read access, WP_Error object otherwise.
  82       */
  83  	public function get_items_permissions_check( $request ) {
  84          if ( 'edit' === $request['context'] ) {
  85              if ( ! empty( $request['type'] ) ) {
  86                  $taxonomies = get_object_taxonomies( $request['type'], 'objects' );
  87              } else {
  88                  $taxonomies = get_taxonomies( '', 'objects' );
  89              }
  90  
  91              foreach ( $taxonomies as $taxonomy ) {
  92                  if ( ! empty( $taxonomy->show_in_rest ) && current_user_can( $taxonomy->cap->assign_terms ) ) {
  93                      return true;
  94                  }
  95              }
  96  
  97              return new WP_Error(
  98                  'rest_cannot_view',
  99                  __( 'Sorry, you are not allowed to manage terms in this taxonomy.' ),
 100                  array( 'status' => rest_authorization_required_code() )
 101              );
 102          }
 103  
 104          return true;
 105      }
 106  
 107      /**
 108       * Retrieves all public taxonomies.
 109       *
 110       * @since 4.7.0
 111       *
 112       * @param WP_REST_Request $request Full details about the request.
 113       * @return WP_REST_Response Response object on success, or WP_Error object on failure.
 114       */
 115  	public function get_items( $request ) {
 116          if ( $request->is_method( 'HEAD' ) ) {
 117              // Return early as this handler doesn't add any response headers.
 118              return new WP_REST_Response( array() );
 119          }
 120  
 121          // Retrieve the list of registered collection query parameters.
 122          $registered = $this->get_collection_params();
 123  
 124          if ( isset( $registered['type'] ) && ! empty( $request['type'] ) ) {
 125              $taxonomies = get_object_taxonomies( $request['type'], 'objects' );
 126          } else {
 127              $taxonomies = get_taxonomies( '', 'objects' );
 128          }
 129  
 130          $data = array();
 131  
 132          foreach ( $taxonomies as $tax_type => $value ) {
 133              if ( empty( $value->show_in_rest ) || ( 'edit' === $request['context'] && ! current_user_can( $value->cap->assign_terms ) ) ) {
 134                  continue;
 135              }
 136  
 137              $tax               = $this->prepare_item_for_response( $value, $request );
 138              $tax               = $this->prepare_response_for_collection( $tax );
 139              $data[ $tax_type ] = $tax;
 140          }
 141  
 142          if ( empty( $data ) ) {
 143              // Response should still be returned as a JSON object when it is empty.
 144              $data = (object) $data;
 145          }
 146  
 147          return rest_ensure_response( $data );
 148      }
 149  
 150      /**
 151       * Checks if a given request has access to a taxonomy.
 152       *
 153       * @since 4.7.0
 154       *
 155       * @param WP_REST_Request $request Full details about the request.
 156       * @return bool|WP_Error True if the request has read access for the item, otherwise false or WP_Error object.
 157       */
 158  	public function get_item_permissions_check( $request ) {
 159  
 160          $tax_obj = get_taxonomy( $request['taxonomy'] );
 161  
 162          if ( $tax_obj ) {
 163              if ( empty( $tax_obj->show_in_rest ) ) {
 164                  return false;
 165              }
 166  
 167              if ( 'edit' === $request['context'] && ! current_user_can( $tax_obj->cap->assign_terms ) ) {
 168                  return new WP_Error(
 169                      'rest_forbidden_context',
 170                      __( 'Sorry, you are not allowed to manage terms in this taxonomy.' ),
 171                      array( 'status' => rest_authorization_required_code() )
 172                  );
 173              }
 174          }
 175  
 176          return true;
 177      }
 178  
 179      /**
 180       * Retrieves a specific taxonomy.
 181       *
 182       * @since 4.7.0
 183       *
 184       * @param WP_REST_Request $request Full details about the request.
 185       * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
 186       */
 187  	public function get_item( $request ) {
 188          $tax_obj = get_taxonomy( $request['taxonomy'] );
 189  
 190          if ( empty( $tax_obj ) ) {
 191              return new WP_Error(
 192                  'rest_taxonomy_invalid',
 193                  __( 'Invalid taxonomy.' ),
 194                  array( 'status' => 404 )
 195              );
 196          }
 197  
 198          $data = $this->prepare_item_for_response( $tax_obj, $request );
 199  
 200          return rest_ensure_response( $data );
 201      }
 202  
 203      /**
 204       * Prepares a taxonomy object for serialization.
 205       *
 206       * @since 4.7.0
 207       * @since 5.9.0 Renamed `$taxonomy` to `$item` to match parent class for PHP 8 named parameter support.
 208       *
 209       * @param WP_Taxonomy     $item    Taxonomy data.
 210       * @param WP_REST_Request $request Full details about the request.
 211       * @return WP_REST_Response Response object.
 212       */
 213  	public function prepare_item_for_response( $item, $request ) {
 214          // Restores the more descriptive, specific name for use within this method.
 215          $taxonomy = $item;
 216  
 217          // Don't prepare the response body for HEAD requests.
 218          if ( $request->is_method( 'HEAD' ) ) {
 219              /** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-taxonomies-controller.php */
 220              return apply_filters( 'rest_prepare_taxonomy', new WP_REST_Response( array() ), $taxonomy, $request );
 221          }
 222  
 223          $base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
 224  
 225          $fields = $this->get_fields_for_response( $request );
 226          $data   = array();
 227  
 228          if ( in_array( 'name', $fields, true ) ) {
 229              $data['name'] = $taxonomy->label;
 230          }
 231  
 232          if ( in_array( 'slug', $fields, true ) ) {
 233              $data['slug'] = $taxonomy->name;
 234          }
 235  
 236          if ( in_array( 'capabilities', $fields, true ) ) {
 237              $data['capabilities'] = $taxonomy->cap;
 238          }
 239  
 240          if ( in_array( 'description', $fields, true ) ) {
 241              $data['description'] = $taxonomy->description;
 242          }
 243  
 244          if ( in_array( 'labels', $fields, true ) ) {
 245              $data['labels'] = $taxonomy->labels;
 246          }
 247  
 248          if ( in_array( 'types', $fields, true ) ) {
 249              $data['types'] = array_values( $taxonomy->object_type );
 250          }
 251  
 252          if ( in_array( 'show_cloud', $fields, true ) ) {
 253              $data['show_cloud'] = $taxonomy->show_tagcloud;
 254          }
 255  
 256          if ( in_array( 'hierarchical', $fields, true ) ) {
 257              $data['hierarchical'] = $taxonomy->hierarchical;
 258          }
 259  
 260          if ( in_array( 'rest_base', $fields, true ) ) {
 261              $data['rest_base'] = $base;
 262          }
 263  
 264          if ( in_array( 'rest_namespace', $fields, true ) ) {
 265              $data['rest_namespace'] = $taxonomy->rest_namespace;
 266          }
 267  
 268          if ( in_array( 'visibility', $fields, true ) ) {
 269              $data['visibility'] = array(
 270                  'public'             => (bool) $taxonomy->public,
 271                  'publicly_queryable' => (bool) $taxonomy->publicly_queryable,
 272                  'show_admin_column'  => (bool) $taxonomy->show_admin_column,
 273                  'show_in_nav_menus'  => (bool) $taxonomy->show_in_nav_menus,
 274                  'show_in_quick_edit' => (bool) $taxonomy->show_in_quick_edit,
 275                  'show_ui'            => (bool) $taxonomy->show_ui,
 276              );
 277          }
 278  
 279          $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
 280          $data    = $this->add_additional_fields_to_object( $data, $request );
 281          $data    = $this->filter_response_by_context( $data, $context );
 282  
 283          // Wrap the data in a response object.
 284          $response = rest_ensure_response( $data );
 285  
 286          if ( rest_is_field_included( '_links', $fields ) || rest_is_field_included( '_embedded', $fields ) ) {
 287              $response->add_links( $this->prepare_links( $taxonomy ) );
 288          }
 289  
 290          /**
 291           * Filters a taxonomy returned from the REST API.
 292           *
 293           * Allows modification of the taxonomy data right before it is returned.
 294           *
 295           * @since 4.7.0
 296           *
 297           * @param WP_REST_Response $response The response object.
 298           * @param WP_Taxonomy      $item     The original taxonomy object.
 299           * @param WP_REST_Request  $request  Request used to generate the response.
 300           */
 301          return apply_filters( 'rest_prepare_taxonomy', $response, $taxonomy, $request );
 302      }
 303  
 304      /**
 305       * Prepares links for the request.
 306       *
 307       * @since 6.1.0
 308       *
 309       * @param WP_Taxonomy $taxonomy The taxonomy.
 310       * @return array Links for the given taxonomy.
 311       */
 312  	protected function prepare_links( $taxonomy ) {
 313          return array(
 314              'collection'              => array(
 315                  'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ),
 316              ),
 317              'https://api.w.org/items' => array(
 318                  'href' => rest_url( rest_get_route_for_taxonomy_items( $taxonomy->name ) ),
 319              ),
 320          );
 321      }
 322  
 323      /**
 324       * Retrieves the taxonomy's schema, conforming to JSON Schema.
 325       *
 326       * @since 4.7.0
 327       * @since 5.0.0 The `visibility` property was added.
 328       * @since 5.9.0 The `rest_namespace` property was added.
 329       *
 330       * @return array Item schema data.
 331       */
 332  	public function get_item_schema() {
 333          if ( $this->schema ) {
 334              return $this->add_additional_fields_schema( $this->schema );
 335          }
 336  
 337          $schema = array(
 338              '$schema'    => 'http://json-schema.org/draft-04/schema#',
 339              'title'      => 'taxonomy',
 340              'type'       => 'object',
 341              'properties' => array(
 342                  'capabilities'   => array(
 343                      'description' => __( 'All capabilities used by the taxonomy.' ),
 344                      'type'        => 'object',
 345                      'context'     => array( 'edit' ),
 346                      'readonly'    => true,
 347                  ),
 348                  'description'    => array(
 349                      'description' => __( 'A human-readable description of the taxonomy.' ),
 350                      'type'        => 'string',
 351                      'context'     => array( 'view', 'edit' ),
 352                      'readonly'    => true,
 353                  ),
 354                  'hierarchical'   => array(
 355                      'description' => __( 'Whether or not the taxonomy should have children.' ),
 356                      'type'        => 'boolean',
 357                      'context'     => array( 'view', 'edit' ),
 358                      'readonly'    => true,
 359                  ),
 360                  'labels'         => array(
 361                      'description' => __( 'Human-readable labels for the taxonomy for various contexts.' ),
 362                      'type'        => 'object',
 363                      'context'     => array( 'edit' ),
 364                      'readonly'    => true,
 365                  ),
 366                  'name'           => array(
 367                      'description' => __( 'The title for the taxonomy.' ),
 368                      'type'        => 'string',
 369                      'context'     => array( 'view', 'edit', 'embed' ),
 370                      'readonly'    => true,
 371                  ),
 372                  'slug'           => array(
 373                      'description' => __( 'An alphanumeric identifier for the taxonomy.' ),
 374                      'type'        => 'string',
 375                      'context'     => array( 'view', 'edit', 'embed' ),
 376                      'readonly'    => true,
 377                  ),
 378                  'show_cloud'     => array(
 379                      'description' => __( 'Whether or not the term cloud should be displayed.' ),
 380                      'type'        => 'boolean',
 381                      'context'     => array( 'edit' ),
 382                      'readonly'    => true,
 383                  ),
 384                  'types'          => array(
 385                      'description' => __( 'Types associated with the taxonomy.' ),
 386                      'type'        => 'array',
 387                      'items'       => array(
 388                          'type' => 'string',
 389                      ),
 390                      'context'     => array( 'view', 'edit' ),
 391                      'readonly'    => true,
 392                  ),
 393                  'rest_base'      => array(
 394                      'description' => __( 'REST base route for the taxonomy.' ),
 395                      'type'        => 'string',
 396                      'context'     => array( 'view', 'edit', 'embed' ),
 397                      'readonly'    => true,
 398                  ),
 399                  'rest_namespace' => array(
 400                      'description' => __( 'REST namespace route for the taxonomy.' ),
 401                      'type'        => 'string',
 402                      'context'     => array( 'view', 'edit', 'embed' ),
 403                      'readonly'    => true,
 404                  ),
 405                  'visibility'     => array(
 406                      'description' => __( 'The visibility settings for the taxonomy.' ),
 407                      'type'        => 'object',
 408                      'context'     => array( 'edit' ),
 409                      'readonly'    => true,
 410                      'properties'  => array(
 411                          'public'             => array(
 412                              'description' => __( 'Whether a taxonomy is intended for use publicly either via the admin interface or by front-end users.' ),
 413                              'type'        => 'boolean',
 414                          ),
 415                          'publicly_queryable' => array(
 416                              'description' => __( 'Whether the taxonomy is publicly queryable.' ),
 417                              'type'        => 'boolean',
 418                          ),
 419                          'show_ui'            => array(
 420                              'description' => __( 'Whether to generate a default UI for managing this taxonomy.' ),
 421                              'type'        => 'boolean',
 422                          ),
 423                          'show_admin_column'  => array(
 424                              'description' => __( 'Whether to allow automatic creation of taxonomy columns on associated post-types table.' ),
 425                              'type'        => 'boolean',
 426                          ),
 427                          'show_in_nav_menus'  => array(
 428                              'description' => __( 'Whether to make the taxonomy available for selection in navigation menus.' ),
 429                              'type'        => 'boolean',
 430                          ),
 431                          'show_in_quick_edit' => array(
 432                              'description' => __( 'Whether to show the taxonomy in the quick/bulk edit panel.' ),
 433                              'type'        => 'boolean',
 434                          ),
 435  
 436                      ),
 437                  ),
 438              ),
 439          );
 440  
 441          $this->schema = $schema;
 442  
 443          return $this->add_additional_fields_schema( $this->schema );
 444      }
 445  
 446      /**
 447       * Retrieves the query params for collections.
 448       *
 449       * @since 4.7.0
 450       *
 451       * @return array Collection parameters.
 452       */
 453  	public function get_collection_params() {
 454          $new_params            = array();
 455          $new_params['context'] = $this->get_context_param( array( 'default' => 'view' ) );
 456          $new_params['type']    = array(
 457              'description' => __( 'Limit results to taxonomies associated with a specific post type.' ),
 458              'type'        => 'string',
 459          );
 460          return $new_params;
 461      }
 462  }