[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * REST API: WP_REST_Post_Types_Controller class
   4   *
   5   * @package WordPress
   6   * @subpackage REST_API
   7   * @since 4.7.0
   8   */
   9  
  10  /**
  11   * Core class to access post types via the REST API.
  12   *
  13   * @since 4.7.0
  14   *
  15   * @see WP_REST_Controller
  16   */
  17  class WP_REST_Post_Types_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 = 'types';
  27      }
  28  
  29      /**
  30       * Registers the routes for post types.
  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<type>[\w-]+)',
  55              array(
  56                  'args'   => array(
  57                      'type' => array(
  58                          'description' => __( 'An alphanumeric identifier for the post type.' ),
  59                          'type'        => 'string',
  60                      ),
  61                  ),
  62                  array(
  63                      'methods'             => WP_REST_Server::READABLE,
  64                      'callback'            => array( $this, 'get_item' ),
  65                      'permission_callback' => '__return_true',
  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 types.
  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              $types = get_post_types( array( 'show_in_rest' => true ), 'objects' );
  86  
  87              foreach ( $types as $type ) {
  88                  if ( current_user_can( $type->cap->edit_posts ) ) {
  89                      return true;
  90                  }
  91              }
  92  
  93              return new WP_Error(
  94                  'rest_cannot_view',
  95                  __( 'Sorry, you are not allowed to edit posts in this post type.' ),
  96                  array( 'status' => rest_authorization_required_code() )
  97              );
  98          }
  99  
 100          return true;
 101      }
 102  
 103      /**
 104       * Retrieves all public post types.
 105       *
 106       * @since 4.7.0
 107       *
 108       * @param WP_REST_Request $request Full details about the request.
 109       * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
 110       */
 111  	public function get_items( $request ) {
 112          if ( $request->is_method( 'HEAD' ) ) {
 113              // Return early as this handler doesn't add any response headers.
 114              return new WP_REST_Response( array() );
 115          }
 116  
 117          $data  = array();
 118          $types = get_post_types( array( 'show_in_rest' => true ), 'objects' );
 119  
 120          foreach ( $types as $type ) {
 121              if ( 'edit' === $request['context'] && ! current_user_can( $type->cap->edit_posts ) ) {
 122                  continue;
 123              }
 124  
 125              $post_type           = $this->prepare_item_for_response( $type, $request );
 126              $data[ $type->name ] = $this->prepare_response_for_collection( $post_type );
 127          }
 128  
 129          return rest_ensure_response( $data );
 130      }
 131  
 132      /**
 133       * Retrieves a specific post type.
 134       *
 135       * @since 4.7.0
 136       *
 137       * @param WP_REST_Request $request Full details about the request.
 138       * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
 139       */
 140  	public function get_item( $request ) {
 141          $obj = get_post_type_object( $request['type'] );
 142  
 143          if ( empty( $obj ) ) {
 144              return new WP_Error(
 145                  'rest_type_invalid',
 146                  __( 'Invalid post type.' ),
 147                  array( 'status' => 404 )
 148              );
 149          }
 150  
 151          if ( empty( $obj->show_in_rest ) ) {
 152              return new WP_Error(
 153                  'rest_cannot_read_type',
 154                  __( 'Cannot view post type.' ),
 155                  array( 'status' => rest_authorization_required_code() )
 156              );
 157          }
 158  
 159          if ( 'edit' === $request['context'] && ! current_user_can( $obj->cap->edit_posts ) ) {
 160              return new WP_Error(
 161                  'rest_forbidden_context',
 162                  __( 'Sorry, you are not allowed to edit posts in this post type.' ),
 163                  array( 'status' => rest_authorization_required_code() )
 164              );
 165          }
 166  
 167          $data = $this->prepare_item_for_response( $obj, $request );
 168  
 169          return rest_ensure_response( $data );
 170      }
 171  
 172      /**
 173       * Prepares a post type object for serialization.
 174       *
 175       * @since 4.7.0
 176       * @since 5.9.0 Renamed `$post_type` to `$item` to match parent class for PHP 8 named parameter support.
 177       *
 178       * @param WP_Post_Type    $item    Post type object.
 179       * @param WP_REST_Request $request Full details about the request.
 180       * @return WP_REST_Response Response object.
 181       */
 182  	public function prepare_item_for_response( $item, $request ) {
 183          // Restores the more descriptive, specific name for use within this method.
 184          $post_type = $item;
 185  
 186          // Don't prepare the response body for HEAD requests.
 187          if ( $request->is_method( 'HEAD' ) ) {
 188              /** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php */
 189              return apply_filters( 'rest_prepare_post_type', new WP_REST_Response( array() ), $post_type, $request );
 190          }
 191  
 192          $taxonomies = wp_list_filter( get_object_taxonomies( $post_type->name, 'objects' ), array( 'show_in_rest' => true ) );
 193          $taxonomies = wp_list_pluck( $taxonomies, 'name' );
 194          $base       = ! empty( $post_type->rest_base ) ? $post_type->rest_base : $post_type->name;
 195          $namespace  = ! empty( $post_type->rest_namespace ) ? $post_type->rest_namespace : 'wp/v2';
 196          $supports   = get_all_post_type_supports( $post_type->name );
 197  
 198          $fields = $this->get_fields_for_response( $request );
 199          $data   = array();
 200  
 201          if ( rest_is_field_included( 'capabilities', $fields ) ) {
 202              $data['capabilities'] = $post_type->cap;
 203          }
 204  
 205          if ( rest_is_field_included( 'description', $fields ) ) {
 206              $data['description'] = $post_type->description;
 207          }
 208  
 209          if ( rest_is_field_included( 'hierarchical', $fields ) ) {
 210              $data['hierarchical'] = $post_type->hierarchical;
 211          }
 212  
 213          if ( rest_is_field_included( 'has_archive', $fields ) ) {
 214              $data['has_archive'] = $post_type->has_archive;
 215          }
 216  
 217          if ( rest_is_field_included( 'visibility', $fields ) ) {
 218              $data['visibility'] = array(
 219                  'show_in_nav_menus' => (bool) $post_type->show_in_nav_menus,
 220                  'show_ui'           => (bool) $post_type->show_ui,
 221              );
 222          }
 223  
 224          if ( rest_is_field_included( 'viewable', $fields ) ) {
 225              $data['viewable'] = is_post_type_viewable( $post_type );
 226          }
 227  
 228          if ( rest_is_field_included( 'labels', $fields ) ) {
 229              $data['labels'] = $post_type->labels;
 230          }
 231  
 232          if ( rest_is_field_included( 'name', $fields ) ) {
 233              $data['name'] = $post_type->label;
 234          }
 235  
 236          if ( rest_is_field_included( 'slug', $fields ) ) {
 237              $data['slug'] = $post_type->name;
 238          }
 239  
 240          if ( rest_is_field_included( 'icon', $fields ) ) {
 241              $data['icon'] = $post_type->menu_icon;
 242          }
 243  
 244          if ( rest_is_field_included( 'supports', $fields ) ) {
 245              $data['supports'] = $supports;
 246          }
 247  
 248          if ( rest_is_field_included( 'taxonomies', $fields ) ) {
 249              $data['taxonomies'] = array_values( $taxonomies );
 250          }
 251  
 252          if ( rest_is_field_included( 'rest_base', $fields ) ) {
 253              $data['rest_base'] = $base;
 254          }
 255  
 256          if ( rest_is_field_included( 'rest_namespace', $fields ) ) {
 257              $data['rest_namespace'] = $namespace;
 258          }
 259  
 260          if ( rest_is_field_included( 'template', $fields ) ) {
 261              $data['template'] = $post_type->template ?? array();
 262          }
 263  
 264          if ( rest_is_field_included( 'template_lock', $fields ) ) {
 265              $data['template_lock'] = ! empty( $post_type->template_lock ) ? $post_type->template_lock : false;
 266          }
 267  
 268          $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
 269          $data    = $this->add_additional_fields_to_object( $data, $request );
 270          $data    = $this->filter_response_by_context( $data, $context );
 271  
 272          // Wrap the data in a response object.
 273          $response = rest_ensure_response( $data );
 274  
 275          if ( rest_is_field_included( '_links', $fields ) || rest_is_field_included( '_embedded', $fields ) ) {
 276              $response->add_links( $this->prepare_links( $post_type ) );
 277          }
 278  
 279          /**
 280           * Filters a post type returned from the REST API.
 281           *
 282           * Allows modification of the post type data right before it is returned.
 283           *
 284           * @since 4.7.0
 285           *
 286           * @param WP_REST_Response $response  The response object.
 287           * @param WP_Post_Type     $post_type The original post type object.
 288           * @param WP_REST_Request  $request   Request used to generate the response.
 289           */
 290          return apply_filters( 'rest_prepare_post_type', $response, $post_type, $request );
 291      }
 292  
 293      /**
 294       * Prepares links for the request.
 295       *
 296       * @since 6.1.0
 297       *
 298       * @param WP_Post_Type $post_type The post type.
 299       * @return array Links for the given post type.
 300       */
 301  	protected function prepare_links( $post_type ) {
 302          return array(
 303              'collection'              => array(
 304                  'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ),
 305              ),
 306              'https://api.w.org/items' => array(
 307                  'href' => rest_url( rest_get_route_for_post_type_items( $post_type->name ) ),
 308              ),
 309          );
 310      }
 311  
 312      /**
 313       * Retrieves the post type's schema, conforming to JSON Schema.
 314       *
 315       * @since 4.7.0
 316       * @since 4.8.0 The `supports` property was added.
 317       * @since 5.9.0 The `visibility` and `rest_namespace` properties were added.
 318       * @since 6.1.0 The `icon` property was added.
 319       *
 320       * @return array Item schema data.
 321       */
 322  	public function get_item_schema() {
 323          if ( $this->schema ) {
 324              return $this->add_additional_fields_schema( $this->schema );
 325          }
 326  
 327          $schema = array(
 328              '$schema'    => 'http://json-schema.org/draft-04/schema#',
 329              'title'      => 'type',
 330              'type'       => 'object',
 331              'properties' => array(
 332                  'capabilities'   => array(
 333                      'description' => __( 'All capabilities used by the post type.' ),
 334                      'type'        => 'object',
 335                      'context'     => array( 'edit' ),
 336                      'readonly'    => true,
 337                  ),
 338                  'description'    => array(
 339                      'description' => __( 'A human-readable description of the post type.' ),
 340                      'type'        => 'string',
 341                      'context'     => array( 'view', 'edit' ),
 342                      'readonly'    => true,
 343                  ),
 344                  'hierarchical'   => array(
 345                      'description' => __( 'Whether or not the post type should have children.' ),
 346                      'type'        => 'boolean',
 347                      'context'     => array( 'view', 'edit' ),
 348                      'readonly'    => true,
 349                  ),
 350                  'viewable'       => array(
 351                      'description' => __( 'Whether or not the post type can be viewed.' ),
 352                      'type'        => 'boolean',
 353                      'context'     => array( 'edit' ),
 354                      'readonly'    => true,
 355                  ),
 356                  'labels'         => array(
 357                      'description' => __( 'Human-readable labels for the post type for various contexts.' ),
 358                      'type'        => 'object',
 359                      'context'     => array( 'edit' ),
 360                      'readonly'    => true,
 361                  ),
 362                  'name'           => array(
 363                      'description' => __( 'The title for the post type.' ),
 364                      'type'        => 'string',
 365                      'context'     => array( 'view', 'edit', 'embed' ),
 366                      'readonly'    => true,
 367                  ),
 368                  'slug'           => array(
 369                      'description' => __( 'An alphanumeric identifier for the post type.' ),
 370                      'type'        => 'string',
 371                      'context'     => array( 'view', 'edit', 'embed' ),
 372                      'readonly'    => true,
 373                  ),
 374                  'supports'       => array(
 375                      'description' => __( 'All features, supported by the post type.' ),
 376                      'type'        => 'object',
 377                      'context'     => array( 'edit' ),
 378                      'readonly'    => true,
 379                  ),
 380                  'has_archive'    => array(
 381                      'description' => __( 'If the value is a string, the value will be used as the archive slug. If the value is false the post type has no archive.' ),
 382                      'type'        => array( 'string', 'boolean' ),
 383                      'context'     => array( 'view', 'edit' ),
 384                      'readonly'    => true,
 385                  ),
 386                  'taxonomies'     => array(
 387                      'description' => __( 'Taxonomies associated with post type.' ),
 388                      'type'        => 'array',
 389                      'items'       => array(
 390                          'type' => 'string',
 391                      ),
 392                      'context'     => array( 'view', 'edit' ),
 393                      'readonly'    => true,
 394                  ),
 395                  'rest_base'      => array(
 396                      'description' => __( 'REST base route for the post type.' ),
 397                      'type'        => 'string',
 398                      'context'     => array( 'view', 'edit', 'embed' ),
 399                      'readonly'    => true,
 400                  ),
 401                  'rest_namespace' => array(
 402                      'description' => __( 'REST route\'s namespace for the post type.' ),
 403                      'type'        => 'string',
 404                      'context'     => array( 'view', 'edit', 'embed' ),
 405                      'readonly'    => true,
 406                  ),
 407                  'visibility'     => array(
 408                      'description' => __( 'The visibility settings for the post type.' ),
 409                      'type'        => 'object',
 410                      'context'     => array( 'edit' ),
 411                      'readonly'    => true,
 412                      'properties'  => array(
 413                          'show_ui'           => array(
 414                              'description' => __( 'Whether to generate a default UI for managing this post type.' ),
 415                              'type'        => 'boolean',
 416                          ),
 417                          'show_in_nav_menus' => array(
 418                              'description' => __( 'Whether to make the post type available for selection in navigation menus.' ),
 419                              'type'        => 'boolean',
 420                          ),
 421                      ),
 422                  ),
 423                  'icon'           => array(
 424                      'description' => __( 'The icon for the post type.' ),
 425                      'type'        => array( 'string', 'null' ),
 426                      'context'     => array( 'view', 'edit', 'embed' ),
 427                      'readonly'    => true,
 428                  ),
 429                  'template'       => array(
 430                      'type'        => array( 'array' ),
 431                      'description' => __( 'The block template associated with the post type.' ),
 432                      'readonly'    => true,
 433                      'context'     => array( 'view', 'edit', 'embed' ),
 434                  ),
 435                  'template_lock'  => array(
 436                      'type'        => array( 'string', 'boolean' ),
 437                      'enum'        => array( 'all', 'insert', 'contentOnly', false ),
 438                      'description' => __( 'The template_lock associated with the post type, or false if none.' ),
 439                      'readonly'    => true,
 440                      'context'     => array( 'view', 'edit', 'embed' ),
 441                  ),
 442              ),
 443          );
 444  
 445          $this->schema = $schema;
 446  
 447          return $this->add_additional_fields_schema( $this->schema );
 448      }
 449  
 450      /**
 451       * Retrieves the query params for collections.
 452       *
 453       * @since 4.7.0
 454       *
 455       * @return array Collection parameters.
 456       */
 457  	public function get_collection_params() {
 458          return array(
 459              'context' => $this->get_context_param( array( 'default' => 'view' ) ),
 460          );
 461      }
 462  }