Changeset 49173

Timestamp:

10/16/2020 09:38:17 AM (6 months ago)

Author:

SergeyBiryukov

Message:

Docs: Add @since tags for the fire_after_hooks parameter of wp_insert_post(), wp_update_post(), and wp_insert_attachment().

Document the parameter as optional.

Follow-up to [49172].

See #45114.

File:

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

trunk/src/wp-includes/post.php

@@ -3599 +3599 @@
  *
  * @since 1.0.0
+ * @since 2.6.0 Added the `$wp_error` parameter to allow a WP_Error to be returned on failure.
  * @since 4.2.0 Support was added for encoding emoji in the post title, content, and excerpt.
  * @since 4.4.0 A 'meta_input' array can now be passed to `$postarr` to add post meta data.
+ * @since 5.6.0 Added the `fire_after_hooks` parameter.
  *
  * @see sanitize_post()
@@ -3647 +3649 @@
  * }
  * @param bool  $wp_error         Optional. Whether to return a WP_Error on failure. Default false.
- * @param bool  $fire_after_hooks Whether to fire the after insert hooks. Default true.
+ * @param bool  $fire_after_hooks Optional. Whether to fire the after insert hooks. Default true.
  * @return int|WP_Error The post ID on success. The value 0 or WP_Error on failure.
  */
@@ -4326 +4328 @@
  *
  * @since 1.0.0
+ * @since 3.5.0 Added the `$wp_error` parameter to allow a WP_Error to be returned on failure.
+ * @since 5.6.0 Added the `fire_after_hooks` parameter.
  *
  * @param array|object $postarr          Optional. Post data. Arrays are expected to be escaped,
  *                                       objects are not. Default array.
- * @param bool         $wp_error         Optional. Allow return of WP_Error on failure. Default false.
- * @param bool         $fire_after_hooks Whether to fire the after insert hooks. Default true.
+ * @param bool         $wp_error         Optional. Whether to return a WP_Error on failure. Default false.
+ * @param bool         $fire_after_hooks Optional. Whether to fire the after insert hooks. Default true.
  * @return int|WP_Error The post ID on success. The value 0 or WP_Error on failure.
  */
@@ -5823 +5827 @@
  * @since 2.0.0
  * @since 4.7.0 Added the `$wp_error` parameter to allow a WP_Error to be returned on failure.
+ * @since 5.6.0 Added the `fire_after_hooks` parameter.
  *
  * @see wp_insert_post()
@@ -5830 +5835 @@
  * @param int          $parent           Optional. Parent post ID.
  * @param bool         $wp_error         Optional. Whether to return a WP_Error on failure. Default false.
- * @param bool         $fire_after_hooks Whether to fire the after insert hooks. Default true.
+ * @param bool         $fire_after_hooks Optional. Whether to fire the after insert hooks. Default true.
  * @return int|WP_Error The attachment ID on success. The value 0 or WP_Error on failure.
  */