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

Timestamp:

08/11/2022 02:01:35 PM (3 years ago)

Author:

johnbillion

Message:

Docs: Correct and improve the documented types for various functions and hooks.

See #55646

File:

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

trunk/src/wp-includes/revision.php

@@ -18 +18 @@
  *                                  for insertion as a post revision. Default empty array.
  * @param bool          $deprecated Not used.
- * @return array Array of fields that can be versioned.
+ * @return string[] Array of fields that can be versioned.
  */
 function _wp_post_revision_fields( $post = array(), $deprecated = false ) {
@@ -48 +48 @@
      * @since 4.5.0 The `$post` parameter was added.
      *
-     * @param array $fields List of fields to revision. Contains 'post_title',
-     *                      'post_content', and 'post_excerpt' by default.
-     * @param array $post   A post array being processed for insertion as a post revision.
+     * @param string[] $fields List of fields to revision. Contains 'post_title',
+     *                         'post_content', and 'post_excerpt' by default.
+     * @param array    $post   A post array being processed for insertion as a post revision.
      */
     $fields = apply_filters( '_wp_post_revision_fields', $fields, $post );
@@ -490 +490 @@
  * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
  * @param array|null  $args Optional. Arguments for retrieving post revisions. Default null.
- * @return array An array of revisions, or an empty array if none.
+ * @return WP_Post[]|int[] Array of revision objects or IDs, or an empty array if none.
  */
 function wp_get_post_revisions( $post = 0, $args = null ) {