vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-08-11 20:30:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Widgets: Rename and soft deprecate retrieve_widgets().

Browse Source 
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.

git-svn-id: https://develop.svn.wordpress.org/trunk@51705 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Tonya Mork
2021-08-31 19:57:20 +00:00
parent 1bbc5a4737
commit b7a495d337
8 changed files with 53 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/phpunit/tests/widgets.php
+18 -18
View File
@@ -843,9 +843,9 @@ class Tests_Widgets extends WP_UnitTestCase {
/**
* Tests for when 'sidebars_widgets' theme mod is populated.
*
* @covers ::retrieve_widgets
* @covers ::sync_registered_widgets
*/
function test_retrieve_widgets_with_theme_mod() {
function test_sync_registered_widgets_with_theme_mod() {
global $sidebars_widgets, $_wp_sidebars_widgets;
wp_widgets_init();
@@ -873,7 +873,7 @@ class Tests_Widgets extends WP_UnitTestCase {
'wp_inactive_widgets' => array(),
);
$result = retrieve_widgets( true );
$result = sync_registered_widgets( true );
$this->assertIsArray( $result );
$this->assertSame( $result, $sidebars_widgets );
@@ -906,9 +906,9 @@ class Tests_Widgets extends WP_UnitTestCase {
/**
* Tests for when sidebars widgets matches registered sidebars.
*
* @covers ::retrieve_widgets
* @covers ::sync_registered_widgets
*/
function test_retrieve_widgets_with_sidebars_widgets_matching_registered_sidebars() {
function test_sync_registered_widgets_with_sidebars_widgets_matching_registered_sidebars() {
global $sidebars_widgets;
wp_widgets_init();
@@ -921,7 +921,7 @@ class Tests_Widgets extends WP_UnitTestCase {
'wp_inactive_widgets' => array(),
);
$result = retrieve_widgets( true );
$result = sync_registered_widgets( true );
// $sidebars_widgets matches registered sidebars.
$this->assertIsArray( $result );
@@ -944,9 +944,9 @@ class Tests_Widgets extends WP_UnitTestCase {
/**
* Tests for when sidebars widgets doesn't match registered sidebars.
*
* @covers ::retrieve_widgets
* @covers ::sync_registered_widgets
*/
function test_retrieve_widgets_with_sidebars_widgets_not_matching_registered_sidebars() {
function test_sync_registered_widgets_with_sidebars_widgets_not_matching_registered_sidebars() {
global $sidebars_widgets, $_wp_sidebars_widgets;
wp_widgets_init();
@@ -960,7 +960,7 @@ class Tests_Widgets extends WP_UnitTestCase {
);
// Theme changed.
$result = retrieve_widgets( true );
$result = sync_registered_widgets( true );
$_wp_sidebars_widgets = array();
$this->assertIsArray( $result );
@@ -1002,7 +1002,7 @@ class Tests_Widgets extends WP_UnitTestCase {
);
// Theme did not change.
$result = retrieve_widgets();
$result = sync_registered_widgets();
$_wp_sidebars_widgets = array();
$this->assertIsArray( $result );
@@ -1036,9 +1036,9 @@ class Tests_Widgets extends WP_UnitTestCase {
/**
* Tests for Customizer mode.
*
* @covers ::retrieve_widgets
* @covers ::sync_registered_widgets
*/
function test_retrieve_widgets_for_customizer() {
function test_sync_registered_widgets_for_customizer() {
global $sidebars_widgets, $_wp_sidebars_widgets;
wp_widgets_init();
@@ -1053,7 +1053,7 @@ class Tests_Widgets extends WP_UnitTestCase {
);
set_theme_mod( 'sidebars_widgets', $old_sidebars_widgets );
$result = retrieve_widgets( 'customize' );
$result = sync_registered_widgets( 'customize' );
$_wp_sidebars_widgets = array();
$this->assertIsArray( $result );
@@ -1082,7 +1082,7 @@ class Tests_Widgets extends WP_UnitTestCase {
$this->assertNotEquals( $sidebars_widgets, wp_get_sidebars_widgets() );
}
function test_retrieve_widgets_with_single_widget() {
function test_sync_registered_widgets_with_single_widget() {
global $sidebars_widgets;
wp_widgets_init();
@@ -1099,7 +1099,7 @@ class Tests_Widgets extends WP_UnitTestCase {
);
// Theme changed.
$result = retrieve_widgets( true );
$result = sync_registered_widgets( true );
$this->assertContains( 'single', $result['wp_inactive_widgets'] );
}
@@ -1107,9 +1107,9 @@ class Tests_Widgets extends WP_UnitTestCase {
/**
* Tests for orphaned widgets being moved into inactive widgets.
*
* @covers ::retrieve_widgets
* @covers ::sync_registered_widgets
*/
function test_retrieve_widgets_move_orphaned_widgets_to_inactive() {
function test_sync_registered_widgets_move_orphaned_widgets_to_inactive() {
global $sidebars_widgets;
wp_widgets_init();
@@ -1122,7 +1122,7 @@ class Tests_Widgets extends WP_UnitTestCase {
'orphaned_widgets_1' => array( 'calendar-1' ),
);
retrieve_widgets();
sync_registered_widgets();
$this->assertIsArray( $sidebars_widgets );