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

Timestamp:

02/21/2023 04:37:03 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Document default values for optional parameters in various DocBlocks.

Props paulkevan, costdev, audrasjb, SergeyBiryukov.
See #56792.

File:

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

trunk/src/wp-includes/revision.php

@@ -261 +261 @@
  *
  * @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. Default 0.
  * @return WP_Post|false The autosaved data or false on failure or when no autosave exists.
  */
@@ -344 +344 @@
  * @param int|WP_Post|array|null $post     Post ID, post object OR post array.
  * @param bool                   $autosave Optional. Whether the revision is an autosave or not.
+ *                                         Default false.
  * @return int|WP_Error WP_Error or 0 if error, new revision ID if success.
  */
@@ -392 +393 @@
  *                            correspond to a WP_Post object, an associative array, or a numeric array,
  *                            respectively. Default OBJECT.
- * @param string      $filter Optional sanitization filter. See sanitize_post().
+ * @param string      $filter Optional sanitization filter. See sanitize_post(). Default 'raw'.
  * @return WP_Post|array|null WP_Post (or array) on success, or null on failure.
  */