Changeset 52276

Timestamp:

11/30/2021 01:08:05 AM (3 years ago)

Author:

peterwilsoncc

Message:

REST API: Fire wp_after_insert_post later in new post object endpoints.

In the new menu items, global items and template controllers manually call the function wp_after_insert_post() to manually fire the action of the same name after all potential data is updated.

This accounts for the use case in which a theme or plugin developer has modified the endpoints use of either taxonomy or meta data.

The new parameter $fire_after_hooks is added to wp_update_nav_menu_item() to control whether the wp_after_insert_post action is fired when it in turn calls wp_insert_post().

Props spacedmonkey, peterwilsoncc, zieladam.
Fixes #54536.

Location:

trunk/src/wp-includes

Files:

• nav-menu.php (modified) (2 diffs)
• rest-api/endpoints/class-wp-rest-global-styles-controller.php (modified) (2 diffs)
• rest-api/endpoints/class-wp-rest-menu-items-controller.php (modified) (6 diffs)
• rest-api/endpoints/class-wp-rest-templates-controller.php (modified) (4 diffs)

trunk/src/wp-includes/nav-menu.php

@@ -411 +411 @@
  *
  * @since 3.0.0
+ * @since 5.9.0 Added the `$fire_after_hooks` parameter.
  *
  * @param int   $menu_id         The ID of the menu. Required. If "0", makes the menu item a draft orphan.
  * @param int   $menu_item_db_id The ID of the menu item. If "0", creates a new menu item.
  * @param array $menu_item_data  The menu item's data.
+ * @param bool  $fire_after_hooks Whether to fire the after insert hooks. Default true.
  * @return int|WP_Error The menu item's database ID or WP_Error object on failure.
  */
-function wp_update_nav_menu_item( $menu_id = 0, $menu_item_db_id = 0, $menu_item_data = array() ) {
+function wp_update_nav_menu_item( $menu_id = 0, $menu_item_db_id = 0, $menu_item_data = array(), $fire_after_hooks = true ) {
     $menu_id         = (int) $menu_id;
     $menu_item_db_id = (int) $menu_item_db_id;
@@ -527 +529 @@
         $post['ID']          = 0;
         $post['post_status'] = 'publish' === $args['menu-item-status'] ? 'publish' : 'draft';
-        $menu_item_db_id     = wp_insert_post( $post, true );
+        $menu_item_db_id     = wp_insert_post( $post, true, $fire_after_hooks );
         if ( ! $menu_item_db_id || is_wp_error( $menu_item_db_id ) ) {
             return $menu_item_db_id;

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php

@@ -147 +147 @@
      */
     public function update_item( $request ) {
-        $post = get_post( $request['id'] );
-        if ( ! $post || 'wp_global_styles' !== $post->post_type ) {
+        $post_before = get_post( $request['id'] );
+        if ( ! $post_before || 'wp_global_styles' !== $post_before->post_type ) {
             return new WP_Error( 'rest_global_styles_not_found', __( 'No global styles config exist with that id.' ), array( 'status' => 404 ) );
         }
 
         $changes = $this->prepare_item_for_database( $request );
-        $result  = wp_update_post( wp_slash( (array) $changes ), true );
+        $result  = wp_update_post( wp_slash( (array) $changes ), true, false );
         if ( is_wp_error( $result ) ) {
             return $result;
@@ -164 +164 @@
         }
 
-        return $this->prepare_item_for_response(
-            get_post( $request['id'] ),
-            $request
-        );
+        wp_after_insert_post( $post, true, $post_before );
+
+        $response = $this->prepare_item_for_response( $post, $request );
+
+        return rest_ensure_response( $response );
     }
 

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php

@@ -123 +123 @@
         $prepared_nav_item = (array) $prepared_nav_item;
 
-        $nav_menu_item_id = wp_update_nav_menu_item( $prepared_nav_item['menu-id'], $prepared_nav_item['menu-item-db-id'], wp_slash( $prepared_nav_item ) );
+        $nav_menu_item_id = wp_update_nav_menu_item( $prepared_nav_item['menu-id'], $prepared_nav_item['menu-item-db-id'], wp_slash( $prepared_nav_item ), false );
         if ( is_wp_error( $nav_menu_item_id ) ) {
             if ( 'db_insert_error' === $nav_menu_item_id->get_error_code() ) {
@@ -182 +182 @@
         do_action( 'rest_after_insert_nav_menu_item', $nav_menu_item, $request, true );
 
-        $response = $this->prepare_item_for_response( get_post( $nav_menu_item_id ), $request );
+        $post = get_post( $nav_menu_item_id );
+        wp_after_insert_post( $post, false, null );
+
+        $response = $this->prepare_item_for_response( $post, $request );
         $response = rest_ensure_response( $response );
 
@@ -205 +208 @@
             return $valid_check;
         }
-
+        $post_before       = get_post( $request['id'] );
         $prepared_nav_item = $this->prepare_item_for_database( $request );
 
@@ -214 +217 @@
         $prepared_nav_item = (array) $prepared_nav_item;
 
-        $nav_menu_item_id = wp_update_nav_menu_item( $prepared_nav_item['menu-id'], $prepared_nav_item['menu-item-db-id'], wp_slash( $prepared_nav_item ) );
+        $nav_menu_item_id = wp_update_nav_menu_item( $prepared_nav_item['menu-id'], $prepared_nav_item['menu-item-db-id'], wp_slash( $prepared_nav_item ), false );
 
         if ( is_wp_error( $nav_menu_item_id ) ) {
@@ -246 +249 @@
         }
 
+        $post          = get_post( $nav_menu_item_id );
         $nav_menu_item = $this->get_nav_menu_item( $nav_menu_item_id );
         $fields_update = $this->update_additional_fields_for_object( $nav_menu_item, $request );
@@ -257 +261 @@
         /** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php */
         do_action( 'rest_after_insert_nav_menu_item', $nav_menu_item, $request, false );
+
+        wp_after_insert_post( $post, true, $post_before );
 
         $response = $this->prepare_item_for_response( get_post( $nav_menu_item_id ), $request );

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php

@@ -267 +267 @@
         }
 
+        $post_before = get_post( $template->wp_id );
+
         if ( isset( $request['source'] ) && 'theme' === $request['source'] ) {
             wp_delete_post( $template->wp_id, true );
@@ -284 +286 @@
 
         if ( 'custom' === $template->source ) {
-            $result = wp_update_post( wp_slash( (array) $changes ), true );
+            $update = true;
+            $result = wp_update_post( wp_slash( (array) $changes ), false );
         } else {
-            $result = wp_insert_post( wp_slash( (array) $changes ), true );
+            $update      = false;
+            $post_before = null;
+            $result      = wp_insert_post( wp_slash( (array) $changes ), false );
         }
 
@@ -309 +314 @@
         /** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */
         do_action( "rest_after_insert_{$this->post_type}", $post, $request, false );
+
+        wp_after_insert_post( $post, $update, $post_before );
 
         $response = $this->prepare_item_for_response( $template, $request );
@@ -367 +374 @@
         /** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */
         do_action( "rest_after_insert_{$this->post_type}", $post, $request, true );
+
+        wp_after_insert_post( $post, false, null );
 
         $response = $this->prepare_item_for_response( $template, $request );