Context Navigation

Back to Ticket #28298

Ticket #28298: 28298.register_sidebar.diff

File 28298.register_sidebar.diff, 2.4 KB (added by coffee2code, 12 years ago)
Convert documentation for default arguments in `register_sidebar()` to a hash notation.

src/wp-includes/widgets.php

  * If theme support for 'widgets' has not yet been added when this function is
  * called, it will be automatically enabled through the use of add_theme_support()
+ *
- * Arguments passed as a string should be separated by '&':
+ *
- *     e.g. 'name=Sidebar&id=my_prefix_sidebar'
+ *
- * The same arguments passed as an array:
+ *
- *     array(
- *         'name' => 'Sidebar',
- *         'id'   => 'my_prefix_sidebar',
- *     )
+ *
- * Arguments:
- *     name          - The name or title of the sidebar displayed in the admin dashboard.
- *     id            - The unique identifier by which the sidebar will be called.
- *     before_widget - HTML content that will be prepended to each widget's HTML output
- *                     when assigned to this sidebar.
- *     after_widget  - HTML content that will be appended to each widget's HTML output
- *                     when assigned to this sidebar.
- *     before_title  - HTML content that will be prepended to the sidebar title when displayed.
- *     after_title   - HTML content that will be appended to the sidebar title when displayed.
+ *
  * @since 2.2.0
  * @uses $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
+ *
+ * @param string|array $args Arguments for the sidebar being registered.
+ * @param array|string $args {
+ *     Optional. Array or string of arguments for the sidebar being registered.
+ *
+ *     @type string $name          The name or title of the sidebar displayed in the admin dashboard.
+ *     @type string $id            The unique identifier by which the sidebar will be called.
+ *     @type string $before_widget HTML content that will be prepended to each widget's HTML output
+ *                                 when assigned to this sidebar.
+ *     @type string $after_widget  HTML content that will be appended to each widget's HTML output
+ *                                 when assigned to this sidebar.
+ *     @type string $before_title  HTML content that will be prepended to the sidebar title when displayed.
+ *     @type string $after_title   HTML content that will be appended to the sidebar title when displayed.
+ * }
  * @return string Sidebar ID added to $wp_registered_sidebars global.
  */
 function register_sidebar($args = array()) {

Download in other formats:

Original Format

Make WordPress Core

Context Navigation

Ticket #28298: 28298.register_sidebar.diff

src/wp-includes/widgets.php

Download in other formats: