mirror of
https://github.com/WordPress/WordPress.git
synced 2024-12-23 09:37:42 +01:00
1f153b0d12
The previous filter failed the goal of allowing developers to filter all providers before they are registered, since it only filtered the built-in ones. The more specific `wp_sitemaps_add_provider` filter enables exactly that, as it filters every sitemap provider right before it is added to the sitemaps registry. Props pbiron, pfefferle, Chouby, swissspidy. Fixes #50660. Built from https://develop.svn.wordpress.org/trunk@48543 git-svn-id: http://core.svn.wordpress.org/trunk@48305 1a063a9b-81f0-0310-95a4-ce76da25c4cd
86 lines
1.8 KiB
PHP
86 lines
1.8 KiB
PHP
<?php
|
|
/**
|
|
* Sitemaps: WP_Sitemaps_Registry class
|
|
*
|
|
* Handles registering sitemap providers.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Sitemaps
|
|
* @since 5.5.0
|
|
*/
|
|
|
|
/**
|
|
* Class WP_Sitemaps_Registry.
|
|
*
|
|
* @since 5.5.0
|
|
*/
|
|
class WP_Sitemaps_Registry {
|
|
/**
|
|
* Registered sitemap providers.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @var WP_Sitemaps_Provider[] Array of registered sitemap providers.
|
|
*/
|
|
private $providers = array();
|
|
|
|
/**
|
|
* Adds a new sitemap provider.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param string $name Name of the sitemap provider.
|
|
* @param WP_Sitemaps_Provider $provider Instance of a WP_Sitemaps_Provider.
|
|
* @return bool Whether the provider was added successfully.
|
|
*/
|
|
public function add_provider( $name, WP_Sitemaps_Provider $provider ) {
|
|
if ( isset( $this->providers[ $name ] ) ) {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Filters the sitemap provider before it is added.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param WP_Sitemaps_Provider $provider Instance of a WP_Sitemaps_Provider.
|
|
* @param string $name Name of the sitemap provider.
|
|
*/
|
|
$provider = apply_filters( 'wp_sitemaps_add_provider', $provider, $name );
|
|
if ( ! $provider instanceof WP_Sitemaps_Provider ) {
|
|
return false;
|
|
}
|
|
|
|
$this->providers[ $name ] = $provider;
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Returns a single registered sitemap provider.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param string $name Sitemap provider name.
|
|
* @return WP_Sitemaps_Provider|null Sitemap provider if it exists, null otherwise.
|
|
*/
|
|
public function get_provider( $name ) {
|
|
if ( ! isset( $this->providers[ $name ] ) ) {
|
|
return null;
|
|
}
|
|
|
|
return $this->providers[ $name ];
|
|
}
|
|
|
|
/**
|
|
* Returns all registered sitemap providers.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @return WP_Sitemaps_Provider[] Array of sitemap providers.
|
|
*/
|
|
public function get_providers() {
|
|
return $this->providers;
|
|
}
|
|
}
|