Revisions: Correct the function name for retrieving the last revision ID and total count.

Includes:
* Renaming the function to `wp_get_last_revision_id_and_total_count()`.
* Making the default value for `$post` consistent with `wp_get_post_revisions()`.
* Making `WP_Error` codes more specific and using them in test assertions.
* Adjusting the function description per the documentation standards.

Follow-up to [53759].

Props JustinSainton, SergeyBiryukov.
See #55857.

git-svn-id: https://develop.svn.wordpress.org/trunk@53769 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2022-07-23 15:40:10 +00:00
parent a560641179
commit 7e8feefd44
3 changed files with 24 additions and 21 deletions

View File

@@ -528,27 +528,27 @@ function wp_get_post_revisions( $post = 0, $args = null ) {
}
/**
* Get latest revision and count of revisions for a post.
* Returns the latest revision ID and count of revisions for a post.
*
* @since 6.1.0
*
* @param int|WP_Post|null $post Optional. Post ID or WP_Post object. Default is global $post.
* @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 and total count.
* Returns associative array with last revision ID and total count.
*
* @type int $revision The last revision post id or 0 if non existing.
* @type int $count The total count of revisions for $post_id.
* @type int $revision The last revision post ID or 0 if no revisions exist.
* @type int $count The total count of revisions for the given post.
* }
*/
function wp_get_lastest_revision_id_and_total_count( $post = null ) {
function wp_get_last_revision_id_and_total_count( $post = 0 ) {
$post = get_post( $post );
if ( ! $post ) {
return new WP_Error( 'revision_error', __( 'Invalid post.' ) );
return new WP_Error( 'invalid_post', __( 'Invalid post.' ) );
}
if ( ! wp_revisions_enabled( $post ) ) {
return new WP_Error( 'revision_error', __( 'Revisions not enabled.' ) );
return new WP_Error( 'revisions_not_enabled', __( 'Revisions not enabled.' ) );
}
$args = array(