sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Sitemaps: Rename wp_get_sitemaps() to wp_get_sitemaps_providers()

Browse Source 
Following [48536], rename the function to match the rest of the sitemaps logic.

Also eliminates some dead code after [48523].

Props pbiron.
See #50724. See #50643.

git-svn-id: https://develop.svn.wordpress.org/trunk@48540 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Pascal Birchler 2020-07-21 15:55:21 +00:00
parent 3269e83801
commit 83b94f5cd6
5 changed files with 22 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/wp-includes/sitemaps.php
View File

@ -22,8 +22,6 @@
function wp_sitemaps_get_server() {
global $wp_sitemaps;
$is_enabled = (bool) get_option( 'blog_public' );
// If there isn't a global instance, set and bootstrap the sitemaps system.
if ( empty( $wp_sitemaps ) ) {
$wp_sitemaps = new WP_Sitemaps();
@ -51,13 +49,8 @@ function wp_sitemaps_get_server() {
*
* @return WP_Sitemaps_Provider[] Array of sitemap providers.
*/
function wp_get_sitemaps() {
function wp_get_sitemaps_providers() {
$sitemaps = wp_sitemaps_get_server();
if ( ! $sitemaps ) {
return array();
}
return $sitemaps->registry->get_providers();
}
@ -72,11 +65,6 @@ function wp_get_sitemaps() {
*/
function wp_register_sitemap( $name, WP_Sitemaps_Provider $provider ) {
$sitemaps = wp_sitemaps_get_server();
if ( ! $sitemaps ) {
return false;
}
return $sitemaps->registry->add_provider( $name, $provider );
}

2
src/wp-includes/sitemaps/class-wp-sitemaps-registry.php
View File

@ -49,7 +49,7 @@ class WP_Sitemaps_Registry {
* @since 5.5.0
*
* @param string $name Sitemap provider name.
* @return WP_Sitemaps_Provider|null Sitemaps provider if it exists, null otherwise.
* @return WP_Sitemaps_Provider|null Sitemap provider if it exists, null otherwise.
*/
public function get_provider( $name ) {
if ( ! isset( $this->providers[ $name ] ) ) {

4
tests/phpunit/tests/sitemaps/functions.php
View File

@ -43,8 +43,8 @@ class Test_Sitemaps_Functions extends WP_UnitTestCase {
/**
* Test wp_get_sitemaps default functionality
*/
public function test_wp_get_sitemaps() {
$sitemaps = wp_get_sitemaps();
public function test_wp_get_sitemaps_providers() {
$sitemaps = wp_get_sitemaps_providers();
$expected = array(
'posts' => 'WP_Sitemaps_Posts',

18
tests/phpunit/tests/sitemaps/sitemaps-registry.php
View File

@ -8,12 +8,12 @@ class Test_WP_Sitemaps_Registry extends WP_UnitTestCase {
$provider = new WP_Sitemaps_Test_Provider();
$registry = new WP_Sitemaps_Registry();
$actual = $registry->add_provider( 'foo', $provider );
$sitemaps = $registry->get_providers();
$actual = $registry->add_provider( 'foo', $provider );
$providers = $registry->get_providers();
$this->assertTrue( $actual );
$this->assertCount( 1, $sitemaps );
$this->assertSame( $sitemaps['foo'], $provider, 'Can not confirm sitemap registration is working.' );
$this->assertCount( 1, $providers );
$this->assertSame( $providers['foo'], $provider, 'Can not confirm sitemap registration is working.' );
}
public function test_add_provider_prevent_duplicates() {
@ -21,13 +21,13 @@ class Test_WP_Sitemaps_Registry extends WP_UnitTestCase {
$provider2 = new WP_Sitemaps_Test_Provider();
$registry = new WP_Sitemaps_Registry();
$actual1 = $registry->add_provider( 'foo', $provider1 );
$actual2 = $registry->add_provider( 'foo', $provider2 );
$sitemaps = $registry->get_providers();
$actual1 = $registry->add_provider( 'foo', $provider1 );
$actual2 = $registry->add_provider( 'foo', $provider2 );
$providers = $registry->get_providers();
$this->assertTrue( $actual1 );
$this->assertFalse( $actual2 );
$this->assertCount( 1, $sitemaps );
$this->assertSame( $sitemaps['foo'], $provider1, 'Can not confirm sitemap registration is working.' );
$this->assertCount( 1, $providers );
$this->assertSame( $providers['foo'], $provider1, 'Can not confirm sitemap registration is working.' );
}
}

18
tests/phpunit/tests/sitemaps/sitemaps.php
View File

@ -100,7 +100,7 @@ class Test_Sitemaps extends WP_UnitTestCase {
public function _get_sitemap_entries() {
$entries = array();
$providers = wp_get_sitemaps();
$providers = wp_get_sitemaps_providers();
foreach ( $providers as $provider ) {
// Using `array_push` is more efficient than `array_merge` in the loop.
@ -218,7 +218,7 @@ class Test_Sitemaps extends WP_UnitTestCase {
* Tests getting a URL list for post type post.
*/
public function test_get_url_list_post() {
$providers = wp_get_sitemaps();
$providers = wp_get_sitemaps_providers();
$post_list = $providers['posts']->get_url_list( 1, 'post' );
@ -234,7 +234,7 @@ class Test_Sitemaps extends WP_UnitTestCase {
// Short circuit the show on front option.
add_filter( 'pre_option_show_on_front', '__return_true' );
$providers = wp_get_sitemaps();
$providers = wp_get_sitemaps_providers();
$post_list = $providers['posts']->get_url_list( 1, 'page' );
@ -247,7 +247,7 @@ class Test_Sitemaps extends WP_UnitTestCase {
* Tests getting a URL list for post type page with included home page.
*/
public function test_get_url_list_page_with_home() {
$providers = wp_get_sitemaps();
$providers = wp_get_sitemaps_providers();
$post_list = $providers['posts']->get_url_list( 1, 'page' );
@ -270,7 +270,7 @@ class Test_Sitemaps extends WP_UnitTestCase {
public function test_get_url_list_private_post() {
wp_set_current_user( self::$editor_id );
$providers = wp_get_sitemaps();
$providers = wp_get_sitemaps_providers();
$post_list_before = $providers['posts']->get_url_list( 1, 'post' );
@ -297,7 +297,7 @@ class Test_Sitemaps extends WP_UnitTestCase {
$ids = self::factory()->post->create_many( 10, array( 'post_type' => $post_type ) );
$providers = wp_get_sitemaps();
$providers = wp_get_sitemaps_providers();
$post_list = $providers['posts']->get_url_list( 1, $post_type );
@ -320,7 +320,7 @@ class Test_Sitemaps extends WP_UnitTestCase {
self::factory()->post->create_many( 10, array( 'post_type' => $post_type ) );
$providers = wp_get_sitemaps();
$providers = wp_get_sitemaps_providers();
$post_list = $providers['posts']->get_url_list( 1, $post_type );
@ -348,7 +348,7 @@ class Test_Sitemaps extends WP_UnitTestCase {
self::factory()->post->create_many( 10, array( 'post_type' => $post_type ) );
$providers = wp_get_sitemaps();
$providers = wp_get_sitemaps_providers();
$post_list = $providers['posts']->get_url_list( 1, $post_type );
@ -391,7 +391,7 @@ class Test_Sitemaps extends WP_UnitTestCase {
public function test_register_sitemap_provider() {
wp_register_sitemap( 'test_sitemap', self::$test_provider );
$sitemaps = wp_get_sitemaps();
$sitemaps = wp_get_sitemaps_providers();
$this->assertEquals( $sitemaps['test_sitemap'], self::$test_provider, 'Can not confirm sitemap registration is working.' );
}