Changeset 53778

Timestamp:

07/25/2022 07:18:41 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Revisions: Rename the function for retrieving the latest revision ID and total count.

The new name is wp_get_latest_revision_id_and_total_count().

This aims to reduce ambiguity about what exactly is the "first" or "last" revision, and bring more consistency with similar wording elsewhere in core, e.g. latest posts, latest comments, etc.

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

Props peterwilsoncc.
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) (1 diff)
• tests/phpunit/tests/post/revisions.php (modified) (4 diffs)

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

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

trunk/src/wp-includes/revision.php

@@ -535 +535 @@
  * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
  * @return WP_Error|array {
- *     Returns associative array with last revision ID and total count.
- *
- *     @type int $revision The last revision post ID or 0 if no revisions exist.
+ *     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.
  * }
  */
-function wp_get_last_revision_id_and_total_count( $post = 0 ) {
+function wp_get_latest_revision_id_and_total_count( $post = 0 ) {
     $post = get_post( $post );
 

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

@@ -657 +657 @@
 
     /**
-     * Tests that wp_get_last_revision_id_and_total_count() returns the last revision ID and total count.
-     *
+     * Tests that wp_get_latest_revision_id_and_total_count() returns the latest revision ID and total count.
+     *
+     * @covers ::wp_get_latest_revision_id_and_total_count
      * @ticket 55857
      * @dataProvider data_wp_get_post_revisions_url
      */
-    public function test_wp_get_last_revision_id_and_total_count( $revisions ) {
+    public function test_wp_get_latest_revision_id_and_total_count( $revisions ) {
         $post_id = self::factory()->post->create();
         for ( $i = 0; $i < $revisions; ++$i ) {
@@ -673 +674 @@
         }
 
-        $post_revisions     = wp_get_post_revisions( $post_id );
-        $last_post_revision = current( $post_revisions );
-        $revision           = wp_get_last_revision_id_and_total_count( $post_id );
+        $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 );
 
         $this->assertSame(
-            $last_post_revision->ID,
+            $latest_post_revision->ID,
             $revision['revision'],
-            'The last revision ID does not match.'
+            'The latest revision ID does not match.'
         );
 
@@ -691 +692 @@
 
     /**
-     * Tests that wp_get_last_revision_id_and_total_count() returns a WP_Error when no revisions exist.
-     *
+     * Tests that wp_get_latest_revision_id_and_total_count() returns a WP_Error when no revisions exist.
+     *
+     * @covers ::wp_get_latest_revision_id_and_total_count
      * @ticket 55857
      */
-    public function test_wp_get_last_revision_id_and_total_count_no_revisions() {
-        $revision = wp_get_last_revision_id_and_total_count( null );
+    public function test_wp_get_latest_revision_id_and_total_count_no_revisions() {
+        $revision = wp_get_latest_revision_id_and_total_count( null );
 
         $this->assertWPError( $revision, 'Invalid post, no revisions should exist.' );
@@ -703 +705 @@
         add_filter( 'wp_revisions_to_keep', '__return_zero' );
         $post_id  = self::factory()->post->create();
-        $revision = wp_get_last_revision_id_and_total_count( $post_id );
+        $revision = wp_get_latest_revision_id_and_total_count( $post_id );
 
         $this->assertWPError( $revision, 'Revisions should not be enabled.' );