From 98e774ee2e17765116dc29582161cbc4fd2614dc Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Wed, 11 Nov 2020 10:37:33 +0000 Subject: [PATCH] Docs: Clarify `sprintf()` usage for the `before_widget` argument of `register_sidebar()`. Follow-up to [49203], [49560]. See #19709. git-svn-id: https://develop.svn.wordpress.org/trunk@49561 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/widgets.php | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/wp-includes/widgets.php b/src/wp-includes/widgets.php index b30452e1fd..db06222a51 100644 --- a/src/wp-includes/widgets.php +++ b/src/wp-includes/widgets.php @@ -234,16 +234,17 @@ function register_sidebars( $number = 1, $args = array() ) { * Default empty string. * @type string $class Extra CSS class to assign to the sidebar in the Widgets interface. * Default empty. - * @type string $before_widget HTML content to prepend to each widget's HTML output when - * assigned to this sidebar. Default is an opening list item element. - * @type string $after_widget HTML content to append to each widget's HTML output when - * assigned to this sidebar. Default is a closing list item element. + * @type string $before_widget HTML content to prepend to each widget's HTML output when assigned + * to this sidebar. Receives the widget's ID attribute as `%1$s` + * and class name as `%2$s`. Default is an opening list item element. + * @type string $after_widget HTML content to append to each widget's HTML output when assigned + * to this sidebar. Default is a closing list item element. * @type string $before_title HTML content to prepend to the sidebar title when displayed. * Default is an opening h2 element. * @type string $after_title HTML content to append to the sidebar title when displayed. * Default is a closing h2 element. * @type string $before_sidebar HTML content to prepend to the sidebar when displayed. - * Receives the '$id' argument as %1$s and '$class' as %2$s. + * Receives the `$id` argument as `%1$s` and `$class` as `%2$s`. * Outputs after the {@see 'dynamic_sidebar_before'} action. * Default empty string. * @type string $after_sidebar HTML content to append to the sidebar when displayed.