Make WordPress Core

Changeset 37065


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

Docs: Improve inline documentation syntax throughout WP_Widget.

Fixes #36298.

File:
1 edited

Legend:

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

    r37064 r37065  
    3838
    3939    /**
    40      * Option array passed to {@see wp_register_sidebar_widget()}.
     40     * Option array passed to wp_register_sidebar_widget().
    4141     *
    4242     * @since 2.8.0
     
    4747
    4848    /**
    49      * Option array passed to {@see wp_register_widget_control()}.
     49     * Option array passed to wp_register_widget_control().
    5050     *
    5151     * @since 2.8.0
     
    8585    public $updated = false;
    8686
    87     // Member functions that you must over-ride.
     87    //
     88    // Member functions that must be overriden by subclasses.
     89    //
    8890
    8991    /**
     
    184186     * Constructs name attributes for use in form() fields
    185187     *
    186      * This function should be used in form() methods to create name attributes for fields to be saved by update()
     188     * This function should be used in form() methods to create name attributes for fields
     189     * to be saved by update()
    187190     *
    188191     * @since 2.8.0
     
    202205
    203206    /**
    204      * Constructs id attributes for use in {@see WP_Widget::form()} fields.
     207     * Constructs id attributes for use in WP_Widget::form() fields.
    205208     *
    206209     * This function should be used in form() methods to create id attributes
    207      * for fields to be saved by {@see WP_Widget::update()}.
     210     * for fields to be saved by WP_Widget::update().
    208211     *
    209212     * @since 2.8.0
     
    251254
    252255    /**
    253      * Set the internal order number for the widget instance.
     256     * Sets the internal order number for the widget instance.
    254257     *
    255258     * @since 2.8.0
     
    301304
    302305    /**
    303      * Determine whether the current request is inside the Customizer preview.
     306     * Determines whether the current request is inside the Customizer preview.
    304307     *
    305308     * If true -- the current request is inside the Customizer preview, then
     
    321324
    322325    /**
    323      * Generate the actual widget content (Do NOT override).
    324      *
    325      * Finds the instance and calls {@see WP_Widget::widget()}.
    326      *
    327      * @since 2.8.0
    328      * @access public
    329      *
    330      * @param array     $args        Display arguments. See {@see WP_Widget::widget()} for information
     326     * Generates the actual widget content (Do NOT override).
     327     *
     328     * Finds the instance and calls WP_Widget::widget().
     329     *
     330     * @since 2.8.0
     331     * @access public
     332     *
     333     * @param array     $args        Display arguments. See WP_Widget::widget() for information
    331334     *                               on accepted arguments.
    332335     * @param int|array $widget_args {
     
    380383
    381384    /**
    382      * Deal with changed settings (Do NOT override).
     385     * Handles changed settings (Do NOT override).
    383386     *
    384387     * @since 2.8.0
     
    465468
    466469    /**
    467      * Generate the widget control form (Do NOT override).
     470     * Generates the widget control form (Do NOT override).
    468471     *
    469472     * @since 2.8.0
     
    532535
    533536    /**
    534      * Register an instance of the widget class.
     537     * Registers an instance of the widget class.
    535538     *
    536539     * @since 2.8.0
     
    547550
    548551    /**
    549      * Save the settings for all instances of the widget class.
     552     * Saves the settings for all instances of the widget class.
    550553     *
    551554     * @since 2.8.0
     
    560563
    561564    /**
    562      * Get the settings for all instances of the widget class.
     565     * Retrieves the settings for all instances of the widget class.
    563566     *
    564567     * @since 2.8.0
Note: See TracChangeset for help on using the changeset viewer.