| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * REST API: WP_REST_Revisions_Controller class 4 * 5 * @package WordPress 6 * @subpackage REST_API 7 * @since 4.7.0 8 */ 9 10 /** 11 * Core class used to access revisions via the REST API. 12 * 13 * @since 4.7.0 14 * 15 * @see WP_REST_Controller 16 */ 17 class WP_REST_Revisions_Controller extends WP_REST_Controller { 18 19 /** 20 * Parent post type. 21 * 22 * @since 4.7.0 23 * @var string 24 */ 25 private $parent_post_type; 26 27 /** 28 * Instance of a revision meta fields object. 29 * 30 * @since 6.4.0 31 * @var WP_REST_Post_Meta_Fields 32 */ 33 protected $meta; 34 35 /** 36 * Parent controller. 37 * 38 * @since 4.7.0 39 * @var WP_REST_Controller 40 */ 41 private $parent_controller; 42 43 /** 44 * The base of the parent controller's route. 45 * 46 * @since 4.7.0 47 * @var string 48 */ 49 private $parent_base; 50 51 /** 52 * Constructor. 53 * 54 * @since 4.7.0 55 * 56 * @param string $parent_post_type Post type of the parent. 57 */ 58 public function __construct( $parent_post_type ) { 59 $this->parent_post_type = $parent_post_type; 60 $post_type_object = get_post_type_object( $parent_post_type ); 61 $parent_controller = $post_type_object->get_rest_controller(); 62 63 if ( ! $parent_controller ) { 64 $parent_controller = new WP_REST_Posts_Controller( $parent_post_type ); 65 } 66 67 $this->parent_controller = $parent_controller; 68 $this->rest_base = 'revisions'; 69 $this->parent_base = ! empty( $post_type_object->rest_base ) ? $post_type_object->rest_base : $post_type_object->name; 70 $this->namespace = ! empty( $post_type_object->rest_namespace ) ? $post_type_object->rest_namespace : 'wp/v2'; 71 $this->meta = new WP_REST_Post_Meta_Fields( $parent_post_type ); 72 } 73 74 /** 75 * Registers the routes for revisions based on post types supporting revisions. 76 * 77 * @since 4.7.0 78 * 79 * @see register_rest_route() 80 */ 81 public function register_routes() { 82 83 register_rest_route( 84 $this->namespace, 85 '/' . $this->parent_base . '/(?P<parent>[\d]+)/' . $this->rest_base, 86 array( 87 'args' => array( 88 'parent' => array( 89 'description' => __( 'The ID for the parent of the revision.' ), 90 'type' => 'integer', 91 ), 92 ), 93 array( 94 'methods' => WP_REST_Server::READABLE, 95 'callback' => array( $this, 'get_items' ), 96 'permission_callback' => array( $this, 'get_items_permissions_check' ), 97 'args' => $this->get_collection_params(), 98 ), 99 'schema' => array( $this, 'get_public_item_schema' ), 100 ) 101 ); 102 103 register_rest_route( 104 $this->namespace, 105 '/' . $this->parent_base . '/(?P<parent>[\d]+)/' . $this->rest_base . '/(?P<id>[\d]+)', 106 array( 107 'args' => array( 108 'parent' => array( 109 'description' => __( 'The ID for the parent of the revision.' ), 110 'type' => 'integer', 111 ), 112 'id' => array( 113 'description' => __( 'Unique identifier for the revision.' ), 114 'type' => 'integer', 115 ), 116 ), 117 array( 118 'methods' => WP_REST_Server::READABLE, 119 'callback' => array( $this, 'get_item' ), 120 'permission_callback' => array( $this, 'get_item_permissions_check' ), 121 'args' => array( 122 'context' => $this->get_context_param( array( 'default' => 'view' ) ), 123 ), 124 ), 125 array( 126 'methods' => WP_REST_Server::DELETABLE, 127 'callback' => array( $this, 'delete_item' ), 128 'permission_callback' => array( $this, 'delete_item_permissions_check' ), 129 'args' => array( 130 'force' => array( 131 'type' => 'boolean', 132 'default' => false, 133 'description' => __( 'Required to be true, as revisions do not support trashing.' ), 134 ), 135 ), 136 ), 137 'schema' => array( $this, 'get_public_item_schema' ), 138 ) 139 ); 140 } 141 142 /** 143 * Get the parent post, if the ID is valid. 144 * 145 * @since 4.7.2 146 * 147 * @param int $parent_post_id Supplied ID. 148 * @return WP_Post|WP_Error Post object if ID is valid, WP_Error otherwise. 149 */ 150 protected function get_parent( $parent_post_id ) { 151 $error = new WP_Error( 152 'rest_post_invalid_parent', 153 __( 'Invalid post parent ID.' ), 154 array( 'status' => 404 ) 155 ); 156 157 if ( (int) $parent_post_id <= 0 ) { 158 return $error; 159 } 160 161 $parent_post = get_post( (int) $parent_post_id ); 162 163 if ( empty( $parent_post ) || empty( $parent_post->ID ) 164 || $this->parent_post_type !== $parent_post->post_type 165 ) { 166 return $error; 167 } 168 169 return $parent_post; 170 } 171 172 /** 173 * Checks if a given request has access to get revisions. 174 * 175 * @since 4.7.0 176 * 177 * @param WP_REST_Request $request Full details about the request. 178 * @return true|WP_Error True if the request has read access, WP_Error object otherwise. 179 */ 180 public function get_items_permissions_check( $request ) { 181 $parent = $this->get_parent( $request['parent'] ); 182 if ( is_wp_error( $parent ) ) { 183 return $parent; 184 } 185 186 if ( ! current_user_can( 'edit_post', $parent->ID ) ) { 187 return new WP_Error( 188 'rest_cannot_read', 189 __( 'Sorry, you are not allowed to view revisions of this post.' ), 190 array( 'status' => rest_authorization_required_code() ) 191 ); 192 } 193 194 return true; 195 } 196 197 /** 198 * Get the revision, if the ID is valid. 199 * 200 * @since 4.7.2 201 * 202 * @param int $id Supplied ID. 203 * @return WP_Post|WP_Error Revision post object if ID is valid, WP_Error otherwise. 204 */ 205 protected function get_revision( $id ) { 206 $error = new WP_Error( 207 'rest_post_invalid_id', 208 __( 'Invalid revision ID.' ), 209 array( 'status' => 404 ) 210 ); 211 212 if ( (int) $id <= 0 ) { 213 return $error; 214 } 215 216 $revision = get_post( (int) $id ); 217 if ( empty( $revision ) || empty( $revision->ID ) || 'revision' !== $revision->post_type ) { 218 return $error; 219 } 220 221 return $revision; 222 } 223 224 /** 225 * Gets a collection of revisions. 226 * 227 * @since 4.7.0 228 * 229 * @param WP_REST_Request $request Full details about the request. 230 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. 231 */ 232 public function get_items( $request ) { 233 $parent = $this->get_parent( $request['parent'] ); 234 if ( is_wp_error( $parent ) ) { 235 return $parent; 236 } 237 238 // Ensure a search string is set in case the orderby is set to 'relevance'. 239 if ( ! empty( $request['orderby'] ) && 'relevance' === $request['orderby'] && empty( $request['search'] ) ) { 240 return new WP_Error( 241 'rest_no_search_term_defined', 242 __( 'You need to define a search term to order by relevance.' ), 243 array( 'status' => 400 ) 244 ); 245 } 246 247 // Ensure an include parameter is set in case the orderby is set to 'include'. 248 if ( ! empty( $request['orderby'] ) && 'include' === $request['orderby'] && empty( $request['include'] ) ) { 249 return new WP_Error( 250 'rest_orderby_include_missing_include', 251 __( 'You need to define an include parameter to order by include.' ), 252 array( 'status' => 400 ) 253 ); 254 } 255 256 $is_head_request = $request->is_method( 'HEAD' ); 257 258 if ( wp_revisions_enabled( $parent ) ) { 259 $registered = $this->get_collection_params(); 260 $args = array( 261 'post_parent' => $parent->ID, 262 'post_type' => 'revision', 263 'post_status' => 'inherit', 264 'posts_per_page' => -1, 265 'orderby' => 'date ID', 266 'order' => 'DESC', 267 'suppress_filters' => true, 268 ); 269 270 $parameter_mappings = array( 271 'exclude' => 'post__not_in', 272 'include' => 'post__in', 273 'offset' => 'offset', 274 'order' => 'order', 275 'orderby' => 'orderby', 276 'page' => 'paged', 277 'per_page' => 'posts_per_page', 278 'search' => 's', 279 ); 280 281 foreach ( $parameter_mappings as $api_param => $wp_param ) { 282 if ( isset( $registered[ $api_param ], $request[ $api_param ] ) ) { 283 $args[ $wp_param ] = $request[ $api_param ]; 284 } 285 } 286 287 // For backward-compatibility, 'date' needs to resolve to 'date ID'. 288 if ( isset( $args['orderby'] ) && 'date' === $args['orderby'] ) { 289 $args['orderby'] = 'date ID'; 290 } 291 292 if ( $is_head_request ) { 293 // Force the 'fields' argument. For HEAD requests, only post IDs are required to calculate pagination. 294 $args['fields'] = 'ids'; 295 // Disable priming post meta for HEAD requests to improve performance. 296 $args['update_post_term_cache'] = false; 297 $args['update_post_meta_cache'] = false; 298 } 299 300 /** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */ 301 $args = apply_filters( 'rest_revision_query', $args, $request ); 302 $query_args = $this->prepare_items_query( $args, $request ); 303 304 $revisions_query = new WP_Query(); 305 $revisions = $revisions_query->query( $query_args ); 306 $offset = isset( $query_args['offset'] ) ? (int) $query_args['offset'] : 0; 307 $page = isset( $query_args['paged'] ) ? (int) $query_args['paged'] : 0; 308 $total_revisions = $revisions_query->found_posts; 309 310 if ( $total_revisions < 1 ) { 311 // Out-of-bounds, run the query again without LIMIT for total count. 312 unset( $query_args['paged'], $query_args['offset'] ); 313 314 $count_query = new WP_Query(); 315 $count_query->query( $query_args ); 316 317 $total_revisions = $count_query->found_posts; 318 } 319 320 if ( $revisions_query->query_vars['posts_per_page'] > 0 ) { 321 $max_pages = (int) ceil( $total_revisions / (int) $revisions_query->query_vars['posts_per_page'] ); 322 } else { 323 $max_pages = $total_revisions > 0 ? 1 : 0; 324 } 325 326 if ( $total_revisions > 0 ) { 327 if ( $offset >= $total_revisions ) { 328 return new WP_Error( 329 'rest_revision_invalid_offset_number', 330 __( 'The offset number requested is larger than or equal to the number of available revisions.' ), 331 array( 'status' => 400 ) 332 ); 333 } elseif ( ! $offset && $page > $max_pages ) { 334 return new WP_Error( 335 'rest_revision_invalid_page_number', 336 __( 'The page number requested is larger than the number of pages available.' ), 337 array( 'status' => 400 ) 338 ); 339 } 340 } 341 } else { 342 $revisions = array(); 343 $total_revisions = 0; 344 $max_pages = 0; 345 $page = (int) $request['page']; 346 } 347 348 if ( ! $is_head_request ) { 349 $response = array(); 350 351 foreach ( $revisions as $revision ) { 352 $data = $this->prepare_item_for_response( $revision, $request ); 353 $response[] = $this->prepare_response_for_collection( $data ); 354 } 355 356 $response = rest_ensure_response( $response ); 357 } else { 358 $response = new WP_REST_Response( array() ); 359 } 360 361 $response->header( 'X-WP-Total', (int) $total_revisions ); 362 $response->header( 'X-WP-TotalPages', (int) $max_pages ); 363 364 $request_params = $request->get_query_params(); 365 $base_path = rest_url( sprintf( '%s/%s/%d/%s', $this->namespace, $this->parent_base, $request['parent'], $this->rest_base ) ); 366 $base = add_query_arg( urlencode_deep( $request_params ), $base_path ); 367 368 if ( $page > 1 ) { 369 $prev_page = $page - 1; 370 371 if ( $prev_page > $max_pages ) { 372 $prev_page = $max_pages; 373 } 374 375 $prev_link = add_query_arg( 'page', $prev_page, $base ); 376 $response->link_header( 'prev', $prev_link ); 377 } 378 if ( $max_pages > $page ) { 379 $next_page = $page + 1; 380 $next_link = add_query_arg( 'page', $next_page, $base ); 381 382 $response->link_header( 'next', $next_link ); 383 } 384 385 return $response; 386 } 387 388 /** 389 * Checks if a given request has access to get a specific revision. 390 * 391 * @since 4.7.0 392 * 393 * @param WP_REST_Request $request Full details about the request. 394 * @return true|WP_Error True if the request has read access for the item, WP_Error object otherwise. 395 */ 396 public function get_item_permissions_check( $request ) { 397 return $this->get_items_permissions_check( $request ); 398 } 399 400 /** 401 * Retrieves one revision from the collection. 402 * 403 * @since 4.7.0 404 * @since 6.5.0 Added a condition to check that parent id matches revision parent id. 405 * 406 * @param WP_REST_Request $request Full details about the request. 407 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. 408 */ 409 public function get_item( $request ) { 410 $parent = $this->get_parent( $request['parent'] ); 411 if ( is_wp_error( $parent ) ) { 412 return $parent; 413 } 414 415 $revision = $this->get_revision( $request['id'] ); 416 if ( is_wp_error( $revision ) ) { 417 return $revision; 418 } 419 420 if ( (int) $parent->ID !== (int) $revision->post_parent ) { 421 return new WP_Error( 422 'rest_revision_parent_id_mismatch', 423 /* translators: %d: A post id. */ 424 sprintf( __( 'The revision does not belong to the specified parent with id of "%d"' ), $parent->ID ), 425 array( 'status' => 404 ) 426 ); 427 } 428 429 $response = $this->prepare_item_for_response( $revision, $request ); 430 return rest_ensure_response( $response ); 431 } 432 433 /** 434 * Checks if a given request has access to delete a revision. 435 * 436 * @since 4.7.0 437 * 438 * @param WP_REST_Request $request Full details about the request. 439 * @return true|WP_Error True if the request has access to delete the item, WP_Error object otherwise. 440 */ 441 public function delete_item_permissions_check( $request ) { 442 $parent = $this->get_parent( $request['parent'] ); 443 if ( is_wp_error( $parent ) ) { 444 return $parent; 445 } 446 447 if ( ! current_user_can( 'delete_post', $parent->ID ) ) { 448 return new WP_Error( 449 'rest_cannot_delete', 450 __( 'Sorry, you are not allowed to delete revisions of this post.' ), 451 array( 'status' => rest_authorization_required_code() ) 452 ); 453 } 454 455 $revision = $this->get_revision( $request['id'] ); 456 if ( is_wp_error( $revision ) ) { 457 return $revision; 458 } 459 460 $response = $this->get_items_permissions_check( $request ); 461 if ( ! $response || is_wp_error( $response ) ) { 462 return $response; 463 } 464 465 if ( ! current_user_can( 'delete_post', $revision->ID ) ) { 466 return new WP_Error( 467 'rest_cannot_delete', 468 __( 'Sorry, you are not allowed to delete this revision.' ), 469 array( 'status' => rest_authorization_required_code() ) 470 ); 471 } 472 473 return true; 474 } 475 476 /** 477 * Deletes a single revision. 478 * 479 * @since 4.7.0 480 * 481 * @param WP_REST_Request $request Full details about the request. 482 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. 483 */ 484 public function delete_item( $request ) { 485 $revision = $this->get_revision( $request['id'] ); 486 if ( is_wp_error( $revision ) ) { 487 return $revision; 488 } 489 490 $force = isset( $request['force'] ) ? (bool) $request['force'] : false; 491 492 // We don't support trashing for revisions. 493 if ( ! $force ) { 494 return new WP_Error( 495 'rest_trash_not_supported', 496 /* translators: %s: force=true */ 497 sprintf( __( "Revisions do not support trashing. Set '%s' to delete." ), 'force=true' ), 498 array( 'status' => 501 ) 499 ); 500 } 501 502 $previous = $this->prepare_item_for_response( $revision, $request ); 503 504 $result = wp_delete_post( $request['id'], true ); 505 506 /** 507 * Fires after a revision is deleted via the REST API. 508 * 509 * @since 4.7.0 510 * 511 * @param WP_Post|false|null $result The revision object (if it was deleted or moved to the Trash successfully) 512 * or false or null (failure). If the revision was moved to the Trash, $result represents 513 * its new state; if it was deleted, $result represents its state before deletion. 514 * @param WP_REST_Request $request The request sent to the API. 515 */ 516 do_action( 'rest_delete_revision', $result, $request ); 517 518 if ( ! $result ) { 519 return new WP_Error( 520 'rest_cannot_delete', 521 __( 'The post cannot be deleted.' ), 522 array( 'status' => 500 ) 523 ); 524 } 525 526 $response = new WP_REST_Response(); 527 $response->set_data( 528 array( 529 'deleted' => true, 530 'previous' => $previous->get_data(), 531 ) 532 ); 533 return $response; 534 } 535 536 /** 537 * Determines the allowed query_vars for a get_items() response and prepares 538 * them for WP_Query. 539 * 540 * @since 5.0.0 541 * 542 * @param array $prepared_args Optional. Prepared WP_Query arguments. Default empty array. 543 * @param WP_REST_Request $request Optional. Full details about the request. 544 * @return array Items query arguments. 545 */ 546 protected function prepare_items_query( $prepared_args = array(), $request = null ) { 547 $query_args = array(); 548 549 foreach ( $prepared_args as $key => $value ) { 550 /** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */ 551 $query_args[ $key ] = apply_filters( "rest_query_var-{$key}", $value ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores 552 } 553 554 // Map to proper WP_Query orderby param. 555 if ( isset( $query_args['orderby'] ) && isset( $request['orderby'] ) ) { 556 $orderby_mappings = array( 557 'id' => 'ID', 558 'include' => 'post__in', 559 'slug' => 'post_name', 560 'include_slugs' => 'post_name__in', 561 ); 562 563 if ( isset( $orderby_mappings[ $request['orderby'] ] ) ) { 564 $query_args['orderby'] = $orderby_mappings[ $request['orderby'] ]; 565 } 566 } 567 568 return $query_args; 569 } 570 571 /** 572 * Prepares the revision for the REST response. 573 * 574 * @since 4.7.0 575 * @since 5.9.0 Renamed `$post` to `$item` to match parent class for PHP 8 named parameter support. 576 * 577 * @global WP_Post $post Global post object. 578 * 579 * @param WP_Post $item Post revision object. 580 * @param WP_REST_Request $request Request object. 581 * @return WP_REST_Response Response object. 582 */ 583 public function prepare_item_for_response( $item, $request ) { 584 // Restores the more descriptive, specific name for use within this method. 585 $post = $item; 586 587 $GLOBALS['post'] = $post; 588 589 setup_postdata( $post ); 590 591 // Don't prepare the response body for HEAD requests. 592 if ( $request->is_method( 'HEAD' ) ) { 593 /** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php */ 594 return apply_filters( 'rest_prepare_revision', new WP_REST_Response( array() ), $post, $request ); 595 } 596 597 $fields = $this->get_fields_for_response( $request ); 598 $data = array(); 599 600 if ( in_array( 'author', $fields, true ) ) { 601 $data['author'] = (int) $post->post_author; 602 } 603 604 if ( in_array( 'date', $fields, true ) ) { 605 $data['date'] = $this->prepare_date_response( $post->post_date_gmt, $post->post_date ); 606 } 607 608 if ( in_array( 'date_gmt', $fields, true ) ) { 609 $data['date_gmt'] = $this->prepare_date_response( $post->post_date_gmt ); 610 } 611 612 if ( in_array( 'id', $fields, true ) ) { 613 $data['id'] = $post->ID; 614 } 615 616 if ( in_array( 'modified', $fields, true ) ) { 617 $data['modified'] = $this->prepare_date_response( $post->post_modified_gmt, $post->post_modified ); 618 } 619 620 if ( in_array( 'modified_gmt', $fields, true ) ) { 621 $data['modified_gmt'] = $this->prepare_date_response( $post->post_modified_gmt ); 622 } 623 624 if ( in_array( 'parent', $fields, true ) ) { 625 $data['parent'] = (int) $post->post_parent; 626 } 627 628 if ( in_array( 'slug', $fields, true ) ) { 629 $data['slug'] = $post->post_name; 630 } 631 632 if ( in_array( 'guid', $fields, true ) ) { 633 $data['guid'] = array( 634 /** This filter is documented in wp-includes/post-template.php */ 635 'rendered' => apply_filters( 'get_the_guid', $post->guid, $post->ID ), 636 'raw' => $post->guid, 637 ); 638 } 639 640 if ( in_array( 'title', $fields, true ) ) { 641 $data['title'] = array( 642 'raw' => $post->post_title, 643 'rendered' => get_the_title( $post->ID ), 644 ); 645 } 646 647 if ( in_array( 'content', $fields, true ) ) { 648 649 $data['content'] = array( 650 'raw' => $post->post_content, 651 /** This filter is documented in wp-includes/post-template.php */ 652 'rendered' => apply_filters( 'the_content', $post->post_content ), 653 ); 654 } 655 656 if ( in_array( 'excerpt', $fields, true ) ) { 657 $data['excerpt'] = array( 658 'raw' => $post->post_excerpt, 659 'rendered' => $this->prepare_excerpt_response( $post->post_excerpt, $post ), 660 ); 661 } 662 663 if ( rest_is_field_included( 'meta', $fields ) ) { 664 $data['meta'] = $this->meta->get_value( $post->ID, $request ); 665 } 666 667 $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; 668 $data = $this->add_additional_fields_to_object( $data, $request ); 669 $data = $this->filter_response_by_context( $data, $context ); 670 $response = rest_ensure_response( $data ); 671 672 if ( ! empty( $data['parent'] ) ) { 673 $response->add_link( 'parent', rest_url( rest_get_route_for_post( $data['parent'] ) ) ); 674 } 675 676 /** 677 * Filters a revision returned from the REST API. 678 * 679 * Allows modification of the revision right before it is returned. 680 * 681 * @since 4.7.0 682 * 683 * @param WP_REST_Response $response The response object. 684 * @param WP_Post $post The original revision object. 685 * @param WP_REST_Request $request Request used to generate the response. 686 */ 687 return apply_filters( 'rest_prepare_revision', $response, $post, $request ); 688 } 689 690 /** 691 * Checks the post_date_gmt or modified_gmt and prepare any post or 692 * modified date for single post output. 693 * 694 * @since 4.7.0 695 * 696 * @param string $date_gmt GMT publication time. 697 * @param string|null $date Optional. Local publication time. Default null. 698 * @return string|null ISO8601/RFC3339 formatted datetime, otherwise null. 699 */ 700 protected function prepare_date_response( $date_gmt, $date = null ) { 701 if ( '0000-00-00 00:00:00' === $date_gmt ) { 702 return null; 703 } 704 705 if ( isset( $date ) ) { 706 return mysql_to_rfc3339( $date ); 707 } 708 709 return mysql_to_rfc3339( $date_gmt ); 710 } 711 712 /** 713 * Retrieves the revision's schema, conforming to JSON Schema. 714 * 715 * @since 4.7.0 716 * 717 * @return array Item schema data. 718 */ 719 public function get_item_schema() { 720 if ( $this->schema ) { 721 return $this->add_additional_fields_schema( $this->schema ); 722 } 723 724 $schema = array( 725 '$schema' => 'http://json-schema.org/draft-04/schema#', 726 'title' => "{$this->parent_post_type}-revision", 727 'type' => 'object', 728 // Base properties for every Revision. 729 'properties' => array( 730 'author' => array( 731 'description' => __( 'The ID for the author of the revision.' ), 732 'type' => 'integer', 733 'context' => array( 'view', 'edit', 'embed' ), 734 ), 735 'date' => array( 736 'description' => __( "The date the revision was published, in the site's timezone." ), 737 'type' => 'string', 738 'format' => 'date-time', 739 'context' => array( 'view', 'edit', 'embed' ), 740 ), 741 'date_gmt' => array( 742 'description' => __( 'The date the revision was published, as GMT.' ), 743 'type' => 'string', 744 'format' => 'date-time', 745 'context' => array( 'view', 'edit' ), 746 ), 747 'guid' => array( 748 'description' => __( 'GUID for the revision, as it exists in the database.' ), 749 'type' => 'string', 750 'context' => array( 'view', 'edit' ), 751 ), 752 'id' => array( 753 'description' => __( 'Unique identifier for the revision.' ), 754 'type' => 'integer', 755 'context' => array( 'view', 'edit', 'embed' ), 756 ), 757 'modified' => array( 758 'description' => __( "The date the revision was last modified, in the site's timezone." ), 759 'type' => 'string', 760 'format' => 'date-time', 761 'context' => array( 'view', 'edit' ), 762 ), 763 'modified_gmt' => array( 764 'description' => __( 'The date the revision was last modified, as GMT.' ), 765 'type' => 'string', 766 'format' => 'date-time', 767 'context' => array( 'view', 'edit' ), 768 ), 769 'parent' => array( 770 'description' => __( 'The ID for the parent of the revision.' ), 771 'type' => 'integer', 772 'context' => array( 'view', 'edit', 'embed' ), 773 ), 774 'slug' => array( 775 'description' => __( 'An alphanumeric identifier for the revision unique to its type.' ), 776 'type' => 'string', 777 'context' => array( 'view', 'edit', 'embed' ), 778 ), 779 ), 780 ); 781 782 $parent_schema = $this->parent_controller->get_item_schema(); 783 784 if ( ! empty( $parent_schema['properties']['title'] ) ) { 785 $schema['properties']['title'] = $parent_schema['properties']['title']; 786 } 787 788 if ( ! empty( $parent_schema['properties']['content'] ) ) { 789 $schema['properties']['content'] = $parent_schema['properties']['content']; 790 } 791 792 if ( ! empty( $parent_schema['properties']['excerpt'] ) ) { 793 $schema['properties']['excerpt'] = $parent_schema['properties']['excerpt']; 794 } 795 796 if ( ! empty( $parent_schema['properties']['guid'] ) ) { 797 $schema['properties']['guid'] = $parent_schema['properties']['guid']; 798 } 799 800 $schema['properties']['meta'] = $this->meta->get_field_schema(); 801 802 $this->schema = $schema; 803 804 return $this->add_additional_fields_schema( $this->schema ); 805 } 806 807 /** 808 * Retrieves the query params for collections. 809 * 810 * @since 4.7.0 811 * 812 * @return array Collection parameters. 813 */ 814 public function get_collection_params() { 815 $query_params = parent::get_collection_params(); 816 817 $query_params['context']['default'] = 'view'; 818 819 unset( $query_params['per_page']['default'] ); 820 821 $query_params['exclude'] = array( 822 'description' => __( 'Ensure result set excludes specific IDs.' ), 823 'type' => 'array', 824 'items' => array( 825 'type' => 'integer', 826 ), 827 'default' => array(), 828 ); 829 830 $query_params['include'] = array( 831 'description' => __( 'Limit result set to specific IDs.' ), 832 'type' => 'array', 833 'items' => array( 834 'type' => 'integer', 835 ), 836 'default' => array(), 837 ); 838 839 $query_params['offset'] = array( 840 'description' => __( 'Offset the result set by a specific number of items.' ), 841 'type' => 'integer', 842 ); 843 844 $query_params['order'] = array( 845 'description' => __( 'Order sort attribute ascending or descending.' ), 846 'type' => 'string', 847 'default' => 'desc', 848 'enum' => array( 'asc', 'desc' ), 849 ); 850 851 $query_params['orderby'] = array( 852 'description' => __( 'Sort collection by object attribute.' ), 853 'type' => 'string', 854 'default' => 'date', 855 'enum' => array( 856 'date', 857 'id', 858 'include', 859 'relevance', 860 'slug', 861 'include_slugs', 862 'title', 863 ), 864 ); 865 866 return $query_params; 867 } 868 869 /** 870 * Checks the post excerpt and prepare it for single post output. 871 * 872 * @since 4.7.0 873 * 874 * @param string $excerpt The post excerpt. 875 * @param WP_Post $post Post revision object. 876 * @return string Prepared excerpt or empty string. 877 */ 878 protected function prepare_excerpt_response( $excerpt, $post ) { 879 880 /** This filter is documented in wp-includes/post-template.php */ 881 $excerpt = apply_filters( 'the_excerpt', $excerpt, $post ); 882 883 if ( empty( $excerpt ) ) { 884 return ''; 885 } 886 887 return $excerpt; 888 } 889 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Thu Apr 10 08:20:01 2025 | Cross-referenced by PHPXref |