Changeset 34618 for trunk/src/wp-includes/widgets/class-wp-widget-categories.php

Timestamp:

09/27/2015 01:03:31 AM (9 years ago)

Author:

DrewAPicture

Message:

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

Props leemon.
Fixes #34018. See #34013.

File:

• trunk/src/wp-includes/widgets/class-wp-widget-categories.php (modified) (7 diffs)

trunk/src/wp-includes/widgets/class-wp-widget-categories.php

@@ -18 +18 @@
 class WP_Widget_Categories extends WP_Widget {
 
+    /**
+     * Sets up a new Categories widget instance.
+     *
+     * @since 2.8.0
+     * @access public
+     */
     public function __construct() {
         $widget_ops = array( 'classname' => 'widget_categories', 'description' => __( "A list or dropdown of categories." ) );
@@ -24 +30 @@
 
     /**
-     * @staticvar bool $first_dropdown
-     *
-     * @param array $args
-     * @param array $instance
+     * Outputs the content for the current Categories 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 Categories widget instance.
      */
     public function widget( $args, $instance ) {
@@ -74 +84 @@
              */
             wp_dropdown_categories( apply_filters( 'widget_categories_dropdown_args', $cat_args ) );
-?>
+            ?>
 
 <script type='text/javascript'>
@@ -114 +124 @@
 
     /**
-     * @param array $new_instance
-     * @param array $old_instance
-     * @return array
+     * Handles updating settings for the current Categories 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 Updated settings to save.
      */
     public function update( $new_instance, $old_instance ) {
@@ -130 +146 @@
 
     /**
-     * @param array $instance
+     * Outputs the settings form for the Categories widget.
+     *
+     * @since 2.8.0
+     * @access public
+     *
+     * @param array $instance Current settings.
      */
     public function form( $instance ) {
@@ -140 +161 @@
         $dropdown = isset( $instance['dropdown'] ) ? (bool) $instance['dropdown'] : false;
         $current_taxonomy = $this->_get_current_taxonomy( $instance );
-?>
+        ?>
         <p><label for="<?php echo $this->get_field_id('title'); ?>"><?php _e( 'Title:' ); ?></label>
         <input class="widefat" id="<?php echo $this->get_field_id('title'); ?>" name="<?php echo $this->get_field_name('title'); ?>" type="text" value="<?php echo esc_attr( $title ); ?>" /></p>
@@ -166 +187 @@
         <input type="checkbox" class="checkbox" id="<?php echo $this->get_field_id('hierarchical'); ?>" name="<?php echo $this->get_field_name('hierarchical'); ?>"<?php checked( $hierarchical ); ?> />
         <label for="<?php echo $this->get_field_id('hierarchical'); ?>"><?php _e( 'Show hierarchy' ); ?></label></p>
-<?php
-    }
-
-    /**
-     * Retrieves the taxonomy for the current widget instance.
+        <?php
+    }
+
+    /**
+     * Retrieves the taxonomy for the current Categories widget instance.
      *
      * @since 4.4.0