Changeset 51705 for trunk/tests/phpunit/tests/widgets.php

Timestamp:

08/31/2021 07:57:20 PM (3 years ago)

Author:

hellofromTonya

Message:

Widgets: Rename and soft deprecate retrieve_widgets().

The original name retrieve_widgets() was unclear as it suggested it was a getter, i.e. getting the widgets. This function does more than get: finds orphaned widgets, assigns them to the inactive sidebar, and updates the database.

The new name is sync_registered_widgets() which better represents what happens when this function is invoked.

The original retrieve_widgets() function is soft deprecated to avoid unnecessary code churn downstream for developers that support more than the latest version of WordPress.

Follow-up to [18630].

Props zieladam, timothyblynjacobs, andraganescu, hellofromTonya.
See #53811.

File:

• trunk/tests/phpunit/tests/widgets.php (modified) (13 diffs)

trunk/tests/phpunit/tests/widgets.php

@@ -844 +844 @@
      * Tests for when 'sidebars_widgets' theme mod is populated.
      *
-     * @covers ::retrieve_widgets
-     */
-    function test_retrieve_widgets_with_theme_mod() {
+     * @covers ::sync_registered_widgets
+     */
+    function test_sync_registered_widgets_with_theme_mod() {
         global $sidebars_widgets, $_wp_sidebars_widgets;
 
@@ -874 +874 @@
         );
 
-        $result = retrieve_widgets( true );
+        $result = sync_registered_widgets( true );
 
         $this->assertIsArray( $result );
@@ -907 +907 @@
      * Tests for when sidebars widgets matches registered sidebars.
      *
-     * @covers ::retrieve_widgets
-     */
-    function test_retrieve_widgets_with_sidebars_widgets_matching_registered_sidebars() {
+     * @covers ::sync_registered_widgets
+     */
+    function test_sync_registered_widgets_with_sidebars_widgets_matching_registered_sidebars() {
         global $sidebars_widgets;
 
@@ -922 +922 @@
         );
 
-        $result = retrieve_widgets( true );
+        $result = sync_registered_widgets( true );
 
         // $sidebars_widgets matches registered sidebars.
@@ -945 +945 @@
      * Tests for when sidebars widgets doesn't match registered sidebars.
      *
-     * @covers ::retrieve_widgets
-     */
-    function test_retrieve_widgets_with_sidebars_widgets_not_matching_registered_sidebars() {
+     * @covers ::sync_registered_widgets
+     */
+    function test_sync_registered_widgets_with_sidebars_widgets_not_matching_registered_sidebars() {
         global $sidebars_widgets, $_wp_sidebars_widgets;
 
@@ -961 +961 @@
 
         // Theme changed.
-        $result = retrieve_widgets( true );
+        $result = sync_registered_widgets( true );
 
         $_wp_sidebars_widgets = array();
@@ -1003 +1003 @@
 
         // Theme did not change.
-        $result = retrieve_widgets();
+        $result = sync_registered_widgets();
 
         $_wp_sidebars_widgets = array();
@@ -1037 +1037 @@
      * Tests for Customizer mode.
      *
-     * @covers ::retrieve_widgets
-     */
-    function test_retrieve_widgets_for_customizer() {
+     * @covers ::sync_registered_widgets
+     */
+    function test_sync_registered_widgets_for_customizer() {
         global $sidebars_widgets, $_wp_sidebars_widgets;
 
@@ -1054 +1054 @@
         set_theme_mod( 'sidebars_widgets', $old_sidebars_widgets );
 
-        $result = retrieve_widgets( 'customize' );
+        $result = sync_registered_widgets( 'customize' );
 
         $_wp_sidebars_widgets = array();
@@ -1083 +1083 @@
     }
 
-    function test_retrieve_widgets_with_single_widget() {
+    function test_sync_registered_widgets_with_single_widget() {
         global $sidebars_widgets;
 
@@ -1100 +1100 @@
 
         // Theme changed.
-        $result = retrieve_widgets( true );
+        $result = sync_registered_widgets( true );
 
         $this->assertContains( 'single', $result['wp_inactive_widgets'] );
@@ -1108 +1108 @@
      * Tests for orphaned widgets being moved into inactive widgets.
      *
-     * @covers ::retrieve_widgets
-     */
-    function test_retrieve_widgets_move_orphaned_widgets_to_inactive() {
+     * @covers ::sync_registered_widgets
+     */
+    function test_sync_registered_widgets_move_orphaned_widgets_to_inactive() {
         global $sidebars_widgets;
 
@@ -1123 +1123 @@
         );
 
-        retrieve_widgets();
+        sync_registered_widgets();
 
         $this->assertIsArray( $sidebars_widgets );