Make WordPress Core

Ticket #34026: 34026.patch

File 34026.patch, 2.6 KB (added by leemon, 9 years ago)

Improve method documentation

  • src/wp-includes/widgets/class-wp-widget-tag-cloud.php

     
    1616 */
    1717class WP_Widget_Tag_Cloud 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( 'description' => __( "A cloud of your most used tags.") );
    2127                parent::__construct('tag_cloud', __('Tag Cloud'), $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                $current_taxonomy = $this->_get_current_taxonomy($instance);
     
    7486        }
    7587
    7688        /**
    77          * @param array $new_instance
    78          * @param array $old_instance
    79          * @return array
     89         * Updates a particular instance of a widget.
     90         *
     91         * This function should check that `$new_instance` is set correctly. The newly-calculated
     92         * value of `$instance` should be returned. If false is returned, the instance won't be
     93         * saved/updated.
     94         *
     95         * @since 2.8.0
     96         * @access public
     97         *
     98         * @param array $new_instance New settings for this instance as input by the user via
     99         *                            WP_Widget::form().
     100         * @param array $old_instance Old settings for this instance.
     101         * @return array Settings to save or bool false to cancel saving.
    80102         */
    81103        public function update( $new_instance, $old_instance ) {
    82104                $instance = array();
     
    86108        }
    87109
    88110        /**
    89          * @param array $instance
     111         * Outputs the settings update form.
     112         *
     113         * @since 2.8.0
     114         * @access public
     115         *
     116         * @param array $instance Current settings.
    90117         */
    91118        public function form( $instance ) {
    92119                $current_taxonomy = $this->_get_current_taxonomy($instance);
     
    141168        }
    142169
    143170        /**
    144          * @param array $instance
    145          * @return string
     171         * Retrieves the taxonomy for the current widget instance.
     172         *
     173         * @since 4.4.0
     174         * @access public
     175         *
     176         * @param array $instance Current settings.
     177         * @return string Name of the current taxonomy if set, otherwise 'post_tag'.
    146178         */
    147179        public function _get_current_taxonomy($instance) {
    148180                if ( !empty($instance['taxonomy']) && taxonomy_exists($instance['taxonomy']) )