Widgets: Match variable types in rss feed link filter.

The `rss_widget_feed_link` filter added in [52031] documents the parameter as a string, but recommends removing by returning false. Change the recommendation and documentation to make this consistent and update Twenty Twenty One to use the new recommended return value. Maintains documentation as possibly returning `false` for backwards compatibility.

Props sabernhardt, Mista-Flo.
Fixes #57594.
Built from https://develop.svn.wordpress.org/trunk@55409


git-svn-id: http://core.svn.wordpress.org/trunk@54942 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
joedolson 2023-02-22 22:02:23 +00:00
parent 9ddb112d51
commit 0f98f3142c
3 changed files with 5 additions and 5 deletions

View File

@ -340,7 +340,7 @@ if ( ! function_exists( 'twenty_twenty_one_setup' ) ) {
add_theme_support( 'custom-units' );
// Remove feed icon link from legacy RSS widget.
add_filter( 'rss_widget_feed_link', '__return_false' );
add_filter( 'rss_widget_feed_link', '__return_empty_string' );
}
}
add_action( 'after_setup_theme', 'twenty_twenty_one_setup' );

View File

@ -16,7 +16,7 @@
*
* @global string $wp_version
*/
$wp_version = '6.2-beta3-55408';
$wp_version = '6.2-beta3-55409';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

View File

@ -101,12 +101,12 @@ class WP_Widget_RSS extends WP_Widget {
/**
* Filters the classic RSS widget's feed icon link.
*
* Themes can remove the icon link by using `add_filter( 'rss_widget_feed_link', '__return_false' );`.
* Themes can remove the icon link by using `add_filter( 'rss_widget_feed_link', '__return_empty_string' );`.
*
* @since 5.9.0
*
* @param string $feed_link HTML for link to RSS feed.
* @param array $instance Array of settings for the current widget.
* @param string|false $feed_link HTML for link to RSS feed.
* @param array $instance Array of settings for the current widget.
*/
$feed_link = apply_filters( 'rss_widget_feed_link', $feed_link, $instance );