WordPress.org

Make WordPress Core

Changeset 30770


Ignore:
Timestamp:
12/07/2014 11:03:51 AM (5 years ago)
Author:
DrewAPicture
Message:

Document the default arguments for the_widget() in the hash notation style.

Props coffee2code.
See #28298.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/widgets.php

    r30769 r30770  
    14461446 * @since 2.8.0
    14471447 *
    1448  * @param string $widget the widget's PHP class name (see default-widgets.php)
    1449  * @param array $instance the widget's instance settings
    1450  * @param array $args the widget's sidebar args
    1451  * @return void
    1452  **/
    1453 function the_widget($widget, $instance = array(), $args = array()) {
     1448 * @param string $widget   The widget's PHP class name (see default-widgets.php).
     1449 * @param array  $instance Optional. The widget's instance settings. Default empty array.
     1450 * @param array  $args {
     1451 *     Optional. Array of arguments to configure the display of the widget.
     1452 *
     1453 *     @type string $before_widget HTML content that will be prepended to the widget's HTML output.
     1454 *                                 Default `<div class="widget %s">`, where `%s` is the widget's class name.
     1455 *     @type string $after_widget  HTML content that will be appended to the widget's HTML output.
     1456 *                                 Default `</div>`.
     1457 *     @type string $before_title  HTML content that will be prepended to the widget's title when displayed.
     1458 *                                 Default `<h2 class="widgettitle">`.
     1459 *     @type string $after_title   HTML content that will be appended to the widget's title when displayed.
     1460 *                                 Default `</h2>`.
     1461 * }
     1462 */
     1463function the_widget( $widget, $instance = array(), $args = array() ) {
    14541464    global $wp_widget_factory;
    14551465
Note: See TracChangeset for help on using the changeset viewer.