Changeset 56984

Timestamp:

10/23/2023 01:15:17 PM (14 months ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for meta revision functions.

Includes:

• Correcting the position of @since 6.4.0 in a few places.
• Adding missing @return documentation.
• Adjusting parameter spacing.

Follow-up to [56714].

Props jeremyfelt, mukesh27.
Fixes #59666.

File:

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

trunk/src/wp-includes/revision.php

@@ -517 +517 @@
  * Restore the revisioned meta values for a post.
  *
+ * @since 6.4.0
+ *
  * @param int $post_id     The ID of the post to restore the meta to.
  * @param int $revision_id The ID of the revision to restore the meta from.
- *
- * @since 6.4.0
  */
 function wp_restore_post_revision_meta( $post_id, $revision_id ) {
@@ -541 +541 @@
  * Copy post meta for the given key from one post to another.
  *
+ * @since 6.4.0
+ *
  * @param int    $source_post_id Post ID to copy meta value(s) from.
  * @param int    $target_post_id Post ID to copy meta value(s) to.
  * @param string $meta_key       Meta key to copy.
- *
- * @since 6.4.0
  */
 function _wp_copy_post_meta( $source_post_id, $target_post_id, $meta_key ) {
@@ -564 +564 @@
  *
  * @param string $post_type The post type being revisioned.
- *
  * @return array An array of meta keys to be revisioned.
  */
@@ -588 +587 @@
      * @since 6.4.0
      *
-     * @param array $keys       An array of meta fields to be revisioned.
+     * @param array  $keys      An array of meta fields to be revisioned.
      * @param string $post_type The post type being revisioned.
      */
@@ -597 +596 @@
  * Check whether revisioned post meta fields have changed.
  *
+ * @since 6.4.0
+ *
  * @param bool    $post_has_changed Whether the post has changed.
  * @param WP_Post $last_revision    The last revision post object.
  * @param WP_Post $post             The post object.
- *
- * @since 6.4.0
+ * @return bool Whether the post has changed.
  */
 function wp_check_revisioned_meta_fields_have_changed( $post_has_changed, WP_Post $last_revision, WP_Post $post ) {