Make WordPress Core

Ticket #34022: 34022.patch

File 34022.patch, 2.5 KB (added by leemon, 9 years ago)

Improve method documentation

  • src/wp-includes/widgets/class-wp-widget-recent-comments.php

     
    1616 */
    1717class WP_Widget_Recent_Comments extends WP_Widget {
    1818
     19        /**
     20         * PHP5 constructor.
     21         *
     22         * @since 2.8.0
     23         * @access public
     24         */
    1925        public function __construct() {
    2026                $widget_ops = array('classname' => 'widget_recent_comments', 'description' => __( 'Your site’s most recent comments.' ) );
    2127                parent::__construct('recent-comments', __('Recent Comments'), $widget_ops);
     
    2531                        add_action( 'wp_head', array($this, 'recent_comments_style') );
    2632        }
    2733
    28         /**
     34        /**
     35         * Outputs the Recent Comments default widget styles.
     36         *
     37         * @since 3.1.0
    2938         * @access public
    3039         */
    3140        public function recent_comments_style() {
     
    4655        }
    4756
    4857        /**
    49          * @param array $args
    50          * @param array $instance
     58         * Echoes the widget content.
     59         *
     60         * @since 2.8.0
     61         * @access public
     62         *
     63         * @param array $args     Display arguments including 'before_title', 'after_title',
     64         *                        'before_widget', and 'after_widget'.
     65         * @param array $instance The settings for the particular instance of the widget.
    5166         */
    5267        public function widget( $args, $instance ) {
    5368                if ( ! isset( $args['widget_id'] ) )
     
    107122        }
    108123
    109124        /**
    110          * @param array $new_instance
    111          * @param array $old_instance
    112          * @return array
     125         * Updates a particular instance of a widget.
     126         *
     127         * This function should check that `$new_instance` is set correctly. The newly-calculated
     128         * value of `$instance` should be returned. If false is returned, the instance won't be
     129         * saved/updated.
     130         *
     131         * @since 2.8.0
     132         * @access public
     133         *
     134         * @param array $new_instance New settings for this instance as input by the user via
     135         *                            WP_Widget::form().
     136         * @param array $old_instance Old settings for this instance.
     137         * @return array Settings to save or bool false to cancel saving.
    113138         */
    114139        public function update( $new_instance, $old_instance ) {
    115140                $instance = $old_instance;
     
    119144        }
    120145
    121146        /**
    122          * @param array $instance
     147         * Outputs the settings update form.
     148         *
     149         * @since 2.8.0
     150         * @access public
     151         *
     152         * @param array $instance Current settings.
    123153         */
    124154        public function form( $instance ) {
    125155                $title = isset( $instance['title'] ) ? $instance['title'] : '';