Make WordPress Core

Ticket #34021: 34021.patch

File 34021.patch, 2.1 KB (added by leemon, 9 years ago)

Improve method documentation

  • src/wp-includes/widgets/class-wp-widget-pages.php

     
    1616 */
    1717class WP_Widget_Pages 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_pages', 'description' => __( 'A list of your site’s Pages.') );
    2127                parent::__construct('pages', __('Pages'), $widget_ops);
     
    2228        }
    2329
    2430        /**
    25          * @param array $args
    26          * @param array $instance
     31         * Echoes the widget content.
     32         *
     33         * @since 2.8.0
     34         * @access public
     35         *
     36         * @param array $args     Display arguments including 'before_title', 'after_title',
     37         *                        'before_widget', and 'after_widget'.
     38         * @param array $instance The settings for the particular instance of the widget.
    2739         */
    2840        public function widget( $args, $instance ) {
    2941
     
    7587        }
    7688
    7789        /**
    78          * @param array $new_instance
    79          * @param array $old_instance
    80          * @return array
     90         * Updates a particular instance of a widget.
     91         *
     92         * This function should check that `$new_instance` is set correctly. The newly-calculated
     93         * value of `$instance` should be returned. If false is returned, the instance won't be
     94         * saved/updated.
     95         *
     96         * @since 2.8.0
     97         * @access public
     98         *
     99         * @param array $new_instance New settings for this instance as input by the user via
     100         *                            WP_Widget::form().
     101         * @param array $old_instance Old settings for this instance.
     102         * @return array Settings to save or bool false to cancel saving.
    81103         */
    82104        public function update( $new_instance, $old_instance ) {
    83105                $instance = $old_instance;
     
    94116        }
    95117
    96118        /**
    97          * @param array $instance
     119         * Outputs the settings update form.
     120         *
     121         * @since 2.8.0
     122         * @access public
     123         *
     124         * @param array $instance Current settings.
    98125         */
    99126        public function form( $instance ) {
    100127                //Defaults