Changeset 49172 for trunk/src/wp-includes/post.php

Timestamp:

10/16/2020 03:32:11 AM (4 years ago)

Author:

peterwilsoncc

Message:

REST API, Posts: Add a hook to fire once a post, its terms and meta update.

Introduces the action wp_after_insert_post inside a wrapper function of the same name. This hook allows plugin developers to access a posts full data (including its terms and meta data) regardless of the workflow used to save it.

A new parameter is introduced to wp_insert_post() to indicate whether the hook should be fired within the function call or will be fired afterward.

Props aristath, Collizo4sky, danielbachhuber, joyously, kadamwhite, kraftbj, markparnell, mikeschroder, noisysocks, peterwilsoncc, SergeyBiryukov, talldanwp, thewebprincess, TimothyBlynJacobs.
Fixes #45114.

File:

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

trunk/src/wp-includes/post.php

@@ -3646 +3646 @@
  *     @type array  $meta_input            Array of post meta values keyed by their post meta key. Default empty.
  * }
- * @param bool  $wp_error Optional. Whether to return a WP_Error on failure. Default false.
+ * @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.
  * @return int|WP_Error The post ID on success. The value 0 or WP_Error on failure.
  */
-function wp_insert_post( $postarr, $wp_error = false ) {
+function wp_insert_post( $postarr, $wp_error = false, $fire_after_hooks = true ) {
     global $wpdb;
 
@@ -4311 +4312 @@
     do_action( 'wp_insert_post', $post_ID, $post, $update );
 
+    if ( $fire_after_hooks ) {
+        wp_after_insert_post( $post, $update );
+    }
+
     return $post_ID;
 }
@@ -4322 +4327 @@
  * @since 1.0.0
  *
- * @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 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.
  * @return int|WP_Error The post ID on success. The value 0 or WP_Error on failure.
  */
-function wp_update_post( $postarr = array(), $wp_error = false ) {
+function wp_update_post( $postarr = array(), $wp_error = false, $fire_after_hooks = true ) {
     if ( is_object( $postarr ) ) {
         // Non-escaped post was passed.
@@ -4392 +4398 @@
     }
 
-    return wp_insert_post( $postarr, $wp_error );
+    return wp_insert_post( $postarr, $wp_error, $fire_after_hooks );
 }
 
@@ -4468 +4474 @@
     /** This action is documented in wp-includes/post.php */
     do_action( 'wp_insert_post', $post->ID, $post, true );
+
+    wp_after_insert_post( $post, true );
 }
 
@@ -4915 +4923 @@
      */
     do_action( "{$new_status}_{$post->post_type}", $post->ID, $post );
+}
+
+/**
+ * Fires actions after a post, its terms and meta data has been saved.
+ *
+ * @since 5.6.0
+ *
+ * @param int|WP_Post $post   The post ID or object that has been saved.
+ * @param bool        $update Whether this is an existing post being updated.
+ */
+function wp_after_insert_post( $post, $update ) {
+    $post = get_post( $post );
+    if ( ! $post ) {
+        return;
+    }
+
+    $post_id = $post->ID;
+
+    /**
+     * Fires once a post, its terms and meta data has been saved.
+     *
+     * @since 5.6.0
+     *
+     * @param int     $post_id Post ID.
+     * @param WP_Post $post    Post object.
+     * @param bool    $update  Whether this is an existing post being updated.
+     */
+    do_action( 'wp_after_insert_post', $post_id, $post, $update );
 }
 
@@ -5790 +5826 @@
  * @see wp_insert_post()
  *
- * @param string|array $args     Arguments for inserting an attachment.
- * @param string       $file     Optional. Filename.
- * @param int          $parent   Optional. Parent post ID.
- * @param bool         $wp_error Optional. Whether to return a WP_Error on failure. Default false.
+ * @param string|array $args             Arguments for inserting an attachment.
+ * @param string       $file             Optional. Filename.
+ * @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.
  * @return int|WP_Error The attachment ID on success. The value 0 or WP_Error on failure.
  */
-function wp_insert_attachment( $args, $file = false, $parent = 0, $wp_error = false ) {
+function wp_insert_attachment( $args, $file = false, $parent = 0, $wp_error = false, $fire_after_hooks = true ) {
     $defaults = array(
         'file'        => $file,
@@ -5810 +5847 @@
     $data['post_type'] = 'attachment';
 
-    return wp_insert_post( $data, $wp_error );
+    return wp_insert_post( $data, $wp_error, $fire_after_hooks );
 }