Changeset 51071

Timestamp:

06/04/2021 10:47:01 AM (4 years ago)

Author:

SergeyBiryukov

Message:

REST API: Rename the $creating parameter of rest_after_save_widget action to $update.

This brings some consistency with similar actions for posts, e.g. save_post or wp_insert_post.

Follow-up to [51068], [51069].

See #53317.

Location:

trunk/src/wp-includes/rest-api/endpoints

Files:

• class-wp-rest-sidebars-controller.php (modified) (1 diff)
• class-wp-rest-widgets-controller.php (modified) (4 diffs)

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

@@ -214 +214 @@
          *
          * @since 5.8.0
-         * @param array           $sidebar  The updated sidebar.
-         * @param WP_REST_Request $request  Request object.
+         *
+         * @param array           $sidebar The updated sidebar.
+         * @param WP_REST_Request $request Request object.
          */
         do_action( 'rest_save_sidebar', $sidebar, $request );

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

@@ -361 +361 @@
          *
          * @since 5.8.0
+         *
          * @param string           $widget_id  ID of the widget marked for deletion.
          * @param string           $sidebar_id ID of the sidebar the widget was deleted from.
@@ -414 +415 @@
             $number        = isset( $parsed_id['number'] ) ? $parsed_id['number'] : null;
             $widget_object = $wp_widget_factory->get_widget_object( $id_base );
-            $creating      = false;
+            $update        = true;
         } elseif ( $request['id_base'] ) {
             // Saving a new widget.
@@ -421 +422 @@
             $number        = $widget_object ? next_widget_id_number( $id_base ) : null;
             $id            = $widget_object ? $id_base . '-' . $number : $id_base;
-            $creating      = true;
+            $update        = false;
         } else {
             return new WP_Error(
@@ -521 +522 @@
          *
          * @since 5.8.0
+         *
          * @param string          $id         ID of the widget being saved.
          * @param string          $sidebar_id ID of the sidebar containing the widget being saved.
          * @param WP_REST_Request $request    Request object.
-         * @param bool            $creating   True when creating a widget, false when updating.
+         * @param bool            $update     Whether this is an existing widget being updated.
          */
-        do_action( 'rest_after_save_widget', $id, $sidebar_id, $request, $creating );
+        do_action( 'rest_after_save_widget', $id, $sidebar_id, $request, $update );
 
         return $id;