Changeset 53841 for trunk/src/wp-includes/revision.php

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.

File:

• trunk/src/wp-includes/revision.php (modified) (2 diffs)

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,
     );
 }