Changeset 49561

Timestamp:

11/11/2020 10:37:33 AM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Clarify sprintf() usage for the before_widget argument of register_sidebar().

Follow-up to [49203], [49560].

See #19709.

File:

• trunk/src/wp-includes/widgets.php (modified) (2 diffs)

trunk/src/wp-includes/widgets.php

@@ -235 +235 @@
  *     @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.
@@ -244 +245 @@
  *                                  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.