Make WordPress Core


Ignore:
Timestamp:
07/27/2017 12:40:27 AM (7 years ago)
Author:
DrewAPicture
Message:

Docs: Remove @access notations from method DocBlocks in wp-includes/* classes.

Prior to about 2013, many class methods lacked even access modifiers which made the @access notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs.

See #41452.

File:
1 edited

Legend:

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

    r39051 r41162  
    2424     *
    2525     * @since 2.8.0
    26      * @access public
    2726     * @var mixed|string
    2827     */
     
    3332     *
    3433     * @since 2.8.0
    35      * @access public
    3634     * @var string
    3735     */
     
    4240     *
    4341     * @since 2.8.0
    44      * @access public
    4542     * @var string
    4643     */
     
    5148     *
    5249     * @since 2.8.0
    53      * @access public
    5450     * @var string
    5551     */
     
    6056     *
    6157     * @since 2.8.0
    62      * @access public
    6358     * @var array
    6459     */
     
    6964     *
    7065     * @since 2.8.0
    71      * @access public
    7266     * @var array
    7367     */
     
    7872     *
    7973     * @since 2.8.0
    80      * @access public
    8174     * @var bool|int
    8275     */
     
    8780     *
    8881     * @since 2.8.0
    89      * @access public
    9082     * @var bool|string
    9183     */
     
    9991     *
    10092     * @since 2.8.0
    101      * @access public
    10293     * @var bool
    10394     */
     
    114105     *
    115106     * @since 2.8.0
    116      * @access public
    117107     *
    118108     * @param array $args     Display arguments including 'before_title', 'after_title',
     
    132122     *
    133123     * @since 2.8.0
    134      * @access public
    135124     *
    136125     * @param array $new_instance New settings for this instance as input by the user via
     
    147136     *
    148137     * @since 2.8.0
    149      * @access public
    150138     *
    151139     * @param array $instance Current settings.
     
    163151     *
    164152     * @since 2.8.0
    165      * @access public
    166153     *
    167154     * @param string $id_base         Optional Base ID for the widget, lowercase and unique. If left empty,
     
    185172     *
    186173     * @since 2.8.0
    187      * @access public
    188174     *
    189175     * @see __construct()
     
    210196     * @since 2.8.0
    211197     * @since 4.4.0 Array format field names are now accepted.
    212      * @access public
    213198     *
    214199     * @param string $field_name Field name
     
    231216     * @since 2.8.0
    232217     * @since 4.4.0 Array format field IDs are now accepted.
    233      * @access public
    234218     *
    235219     * @param string $field_name Field name.
     
    244228     *
    245229     * @since 2.8.0
    246      * @access public
    247230     */
    248231    public function _register() {
     
    276259     *
    277260     * @since 2.8.0
    278      * @access public
    279261     *
    280262     * @param int $number The unique order number of this widget instance compared to other
     
    290272     *
    291273     * @since 2.8.0
    292      * @access public
    293274     *
    294275     * @return callable Display callback.
     
    302283     *
    303284     * @since 2.8.0
    304      * @access public
    305285     *
    306286     * @return callable Update callback.
     
    314294     *
    315295     * @since 2.8.0
    316      * @access public
    317296     *
    318297     * @return callable Form callback.
     
    331310     *
    332311     * @since 3.9.0
    333      * @access public
    334312     *
    335313     * @global WP_Customize_Manager $wp_customize
     
    348326     *
    349327     * @since 2.8.0
    350      * @access public
    351328     *
    352329     * @param array     $args        Display arguments. See WP_Widget::widget() for information
     
    405382     *
    406383     * @since 2.8.0
    407      * @access public
    408384     *
    409385     * @global array $wp_registered_widgets
     
    490466     *
    491467     * @since 2.8.0
    492      * @access public
    493468     *
    494469     * @param int|array $widget_args {
     
    557532     *
    558533     * @since 2.8.0
    559      * @access public
    560534     *
    561535     * @param integer $number Optional. The unique order number of this widget instance
     
    572546     *
    573547     * @since 2.8.0
    574      * @access public
    575548     *
    576549     * @param array $settings Multi-dimensional array of widget instance settings.
     
    585558     *
    586559     * @since 2.8.0
    587      * @access public
    588560     *
    589561     * @return array Multi-dimensional array of widget instance settings.
Note: See TracChangeset for help on using the changeset viewer.