Changeset 34610

Timestamp:

09/27/2015 12:31:59 AM (11 years ago)

Author:

DrewAPicture

Message:

Docs: Improve the documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Tag_Cloud.

Props leemon.
Fixes #34026. See #34013.

File:

• trunk/src/wp-includes/widgets/class-wp-widget-tag-cloud.php (modified) (5 diffs)

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

@@ -17 +17 @@
 class WP_Widget_Tag_Cloud extends WP_Widget {
 
+        /**
+         * Sets up a new Tag Cloud widget instance.
+         *
+         * @since 2.8.0
+         * @access public
+         */
         public function __construct() {
                 $widget_ops = array( 'description' => __( "A cloud of your most used tags.") );
@@ -23 +29 @@
 
         /**
-         * @param array $args
-         * @param array $instance
+         * Outputs the content for the current Tag Cloud widget instance.
+         *
+         * @since 2.8.0
+         * @access public
+         *
+         * @param array $args     Display arguments including 'before_title', 'after_title',
+         *                        'before_widget', and 'after_widget'.
+         * @param array $instance Settings for the current Tag Cloud widget instance.
          */
         public function widget( $args, $instance ) {
@@ -75 +87 @@
 
         /**
-         * @param array $new_instance
-         * @param array $old_instance
-         * @return array
+         * Handles updating settings for the current Tag Cloud widget instance.
+         *
+         * @since 2.8.0
+         * @access public
+         *
+         * @param array $new_instance New settings for this instance as input by the user via
+         *                            WP_Widget::form().
+         * @param array $old_instance Old settings for this instance.
+         * @return array Settings to save or bool false to cancel saving.
          */
         public function update( $new_instance, $old_instance ) {
@@ -87 +105 @@
 
         /**
-         * @param array $instance
+         * Outputs the Tag Cloud widget settings form.
+         *
+         * @since 2.8.0
+         * @access public
+         *
+         * @param array $instance Current settings.
          */
         public function form( $instance ) {
@@ -142 +165 @@
 
         /**
-         * @param array $instance
-         * @return string
+         * Retrieves the taxonomy for the current Tag cloud widget instance.
+         *
+         * @since 4.4.0
+         * @access public
+         *
+         * @param array $instance Current settings.
+         * @return string Name of the current taxonomy if set, otherwise 'post_tag'.
          */
         public function _get_current_taxonomy($instance) {