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

Timestamp:

09/28/2022 02:45:58 PM (2 years ago)

Author:

audrasjb

Message:

Docs: Various docblock fixes in wp-includes/revision.php, as per documentation standards.

See #55646.

File:

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

trunk/src/wp-includes/revision.php

@@ -221 +221 @@
 
 /**
- * Retrieve the autosaved data of the specified post.
+ * Retrieves the autosaved data of the specified post.
  *
  * Returns a post object with the information that was autosaved for the specified post.
@@ -232 +232 @@
  *
  * @param int $post_id The post ID.
- * @param int $user_id Optional The post author ID.
+ * @param int $user_id Optional. The post author ID.
  * @return WP_Post|false The autosaved data or false on failure or when no autosave exists.
  */
@@ -314 +314 @@
  *
  * @param int|WP_Post|array|null $post     Post ID, post object OR post array.
- * @param bool                   $autosave Optional. Is the revision an autosave?
+ * @param bool                   $autosave Optional. Whether the revision is an autosave or not.
  * @return int|WP_Error WP_Error or 0 if error, new revision ID if success.
  */
@@ -363 +363 @@
  *                            correspond to a WP_Post object, an associative array, or a numeric array,
  *                            respectively. Default OBJECT.
- * @param string      $filter Optional sanitation filter. See sanitize_post().
+ * @param string      $filter Optional sanitization filter. See sanitize_post().
  * @return WP_Post|array|null WP_Post (or array) on success, or null on failure.
  */
@@ -614 +614 @@
 
 /**
- * Determine if revisions are enabled for a given post.
+ * Determines whether revisions are enabled for a given post.
  *
  * @since 3.6.0
@@ -626 +626 @@
 
 /**
- * Determine how many revisions to retain for a given post.
+ * Determines how many revisions to retain for a given post.
  *
  * By default, an infinite number of revisions are kept.
@@ -831 +831 @@
 
 /**
- * Upgrade the revisions author, add the current post as a revision and set the revisions version to 1
+ * Upgrades the revisions author, adds the current post as a revision and sets the revisions version to 1.
  *
  * @since 3.6.0
@@ -838 +838 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param WP_Post $post      Post object
- * @param array   $revisions Current revisions of the post
- * @return bool true if the revisions were upgraded, false if problems
+ * @param WP_Post $post      Post object.
+ * @param array   $revisions Current revisions of the post.
+ * @return bool true if the revisions were upgraded, false if problems.
  */
 function _wp_upgrade_revisions_of_post( $post, $revisions ) {