Changeset 53841

Timestamp:

08/05/2022 01:00:57 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Revisions: Use latest_id as the array key for the latest revision ID.

This updates wp_get_latest_revision_id_and_total_count() and its usage to be a bit more descriptive and a bit less repetitive, e.g. $revisions['latest_id'] instead of $revision['revision'].

Includes updating the @return tag to explain when the function returns a WP_Error.

Follow-up to [53759], [53769], [53778], [53779].

See #55857.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (2 diffs)
• src/wp-includes/revision.php (modified) (2 diffs)
• tests/phpunit/tests/post/revisions.php (modified) (2 diffs)

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

@@ -2065 +2065 @@
 
         if ( in_array( $post->post_type, array( 'post', 'page' ), true ) || post_type_supports( $post->post_type, 'revisions' ) ) {
-            $revision        = wp_get_latest_revision_id_and_total_count( $post->ID );
-            $revisions_count = ! is_wp_error( $revision ) ? $revision['count'] : 0;
+            $revisions       = wp_get_latest_revision_id_and_total_count( $post->ID );
+            $revisions_count = ! is_wp_error( $revisions ) ? $revisions['count'] : 0;
 
             $links['version-history'] = array(
@@ -2074 +2074 @@
 
             if ( $revisions_count > 0 ) {
-                $latest_revision = $revision['revision'];
-
                 $links['predecessor-version'] = array(
-                    'href' => rest_url( trailingslashit( $base ) . $post->ID . '/revisions/' . $latest_revision ),
-                    'id'   => $latest_revision,
+                    'href' => rest_url( trailingslashit( $base ) . $post->ID . '/revisions/' . $revisions['latest_id'] ),
+                    'id'   => $revisions['latest_id'],
                 );
             }

trunk/src/wp-includes/revision.php

@@ -534 +534 @@
  *
  * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
- * @return WP_Error|array {
- *     Returns associative array with latest revision ID and total count.
- *
- *     @type int $revision The latest revision post ID or 0 if no revisions exist.
- *     @type int $count    The total count of revisions for the given post.
+ * @return array|WP_Error {
+ *     Returns associative array with latest revision ID and total count,
+ *     or a WP_Error if the post does not exist or revisions are not enabled.
+ *
+ *     @type int $latest_id The latest revision post ID or 0 if no revisions exist.
+ *     @type int $count     The total count of revisions for the given post.
  * }
  */
@@ -568 +569 @@
     if ( ! $revisions ) {
         return array(
-            'revision' => 0,
-            'count'    => 0,
+            'latest_id' => 0,
+            'count'     => 0,
         );
     }
 
     return array(
-        'revision' => $revisions[0],
-        'count'    => $revision_query->found_posts,
+        'latest_id' => $revisions[0],
+        'count'     => $revision_query->found_posts,
     );
 }

trunk/tests/phpunit/tests/post/revisions.php

@@ -676 +676 @@
         $post_revisions       = wp_get_post_revisions( $post_id );
         $latest_post_revision = current( $post_revisions );
-        $revision             = wp_get_latest_revision_id_and_total_count( $post_id );
+        $revisions            = wp_get_latest_revision_id_and_total_count( $post_id );
 
         $this->assertSame(
             $latest_post_revision->ID,
-            $revision['revision'],
+            $revisions['latest_id'],
             'The latest revision ID does not match.'
         );
@@ -686 +686 @@
         $this->assertSame(
             count( $post_revisions ),
-            $revision['count'],
+            $revisions['count'],
             'The total count of revisions does not match.'
         );