Changeset 57230

Timestamp:

12/28/2023 03:17:16 PM (9 months ago)

Author:

SergeyBiryukov

Message:

Docs: Document the $post global in REST API posts and revisions controllers.

Follow-up to [38832], [40601].

Props viralsampat.
See #60021.

Location:

trunk/src/wp-includes/rest-api/endpoints

Files:

• class-wp-rest-posts-controller.php (modified) (1 diff)
• class-wp-rest-revisions-controller.php (modified) (1 diff)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

@@ -1742 +1742 @@
      * @since 4.7.0
      * @since 5.9.0 Renamed `$post` to `$item` to match parent class for PHP 8 named parameter support.
+     *
+     * @global WP_Post $post Global post object.
      *
      * @param WP_Post         $item    Post object.

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

@@ -561 +561 @@
      * @since 5.9.0 Renamed `$post` to `$item` to match parent class for PHP 8 named parameter support.
      *
+     * @global WP_Post $post Global post object.
+     *
      * @param WP_Post         $item    Post revision object.
      * @param WP_REST_Request $request Request object.