Make WordPress Core

Changeset 37064


Ignore:
Timestamp:
03/23/2016 05:09:48 AM (8 years ago)
Author:
DrewAPicture
Message:

Docs: Add missing information to the WP_Widget PHP4 constructor DocBlock.

Also add several missing at @access tags to other method DocBlocks and clarify parameter docs for WP_Widget::form_callback().

Props raimy.
See #36298.

File:
1 edited

Legend:

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

    r37040 r37064  
    163163     * PHP4 constructor.
    164164     *
    165      * @param string $id_base
    166      * @param string $name
    167      * @param array  $widget_options
    168      * @param array  $control_options
     165     * @since 2.8.0
     166     * @access public
     167     *
     168     * @see __construct()
     169     *
     170     * @param string $id_base         Optional Base ID for the widget, lowercase and unique. If left empty,
     171     *                                a portion of the widget's class name will be used Has to be unique.
     172     * @param string $name            Name for the widget displayed on the configuration page.
     173     * @param array  $widget_options  Optional. Widget options. See wp_register_sidebar_widget() for information
     174     *                                on accepted arguments. Default empty array.
     175     * @param array  $control_options Optional. Widget control options. See wp_register_widget_control() for
     176     *                                information on accepted arguments. Default empty array.
    169177     */
    170178    public function WP_Widget( $id_base, $name, $widget_options = array(), $control_options = array() ) {
     
    180188     * @since 2.8.0
    181189     * @since 4.4.0 Array format field names are now accepted.
     190     * @access public
    182191     *
    183192     * @param string $field_name Field name
     
    213222     *
    214223     * @since 2.8.0
    215      * @access private
     224     * @access public
    216225     */
    217226    public function _register() {
     
    245254     *
    246255     * @since 2.8.0
    247      * @access private
     256     * @access public
    248257     *
    249258     * @param int $number The unique order number of this widget instance compared to other
     
    259268     *
    260269     * @since 2.8.0
     270     * @access public
    261271     *
    262272     * @return callable Display callback.
     
    270280     *
    271281     * @since 2.8.0
     282     * @access public
    272283     *
    273284     * @return callable Update callback.
     
    281292     *
    282293     * @since 2.8.0
     294     * @access public
    283295     *
    284296     * @return callable Form callback.
     
    458470     * @access public
    459471     *
    460      * @param int|array $widget_args Widget instance number or array of widget arguments.
     472     * @param int|array $widget_args {
     473     *     Optional. Internal order number of the widget instance, or array of multi-widget arguments.
     474     *     Default 1.
     475     *
     476     *     @type int $number Number increment used for multiples of the same widget.
     477     * }
    461478     * @return string|null
    462479     */
     
    518535     *
    519536     * @since 2.8.0
    520      * @access private
     537     * @access public
    521538     *
    522539     * @param integer $number Optional. The unique order number of this widget instance
Note: See TracChangeset for help on using the changeset viewer.