WordPress.org

Make WordPress Core


Ignore:
Timestamp:
09/27/2015 12:31:59 AM (6 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/widgets/class-wp-widget-tag-cloud.php

    r34439 r34610  
    1717class WP_Widget_Tag_Cloud extends WP_Widget {
    1818
     19    /**
     20     * Sets up a new Tag Cloud widget instance.
     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.") );
     
    2329
    2430    /**
    25      * @param array $args
    26      * @param array $instance
     31     * Outputs the content for the current Tag Cloud widget instance.
     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 Settings for the current Tag Cloud widget instance.
    2739     */
    2840    public function widget( $args, $instance ) {
     
    7587
    7688    /**
    77      * @param array $new_instance
    78      * @param array $old_instance
    79      * @return array
     89     * Handles updating settings for the current Tag Cloud widget instance.
     90     *
     91     * @since 2.8.0
     92     * @access public
     93     *
     94     * @param array $new_instance New settings for this instance as input by the user via
     95     *                            WP_Widget::form().
     96     * @param array $old_instance Old settings for this instance.
     97     * @return array Settings to save or bool false to cancel saving.
    8098     */
    8199    public function update( $new_instance, $old_instance ) {
     
    87105
    88106    /**
    89      * @param array $instance
     107     * Outputs the Tag Cloud widget settings form.
     108     *
     109     * @since 2.8.0
     110     * @access public
     111     *
     112     * @param array $instance Current settings.
    90113     */
    91114    public function form( $instance ) {
     
    142165
    143166    /**
    144      * @param array $instance
    145      * @return string
     167     * Retrieves the taxonomy for the current Tag cloud widget instance.
     168     *
     169     * @since 4.4.0
     170     * @access public
     171     *
     172     * @param array $instance Current settings.
     173     * @return string Name of the current taxonomy if set, otherwise 'post_tag'.
    146174     */
    147175    public function _get_current_taxonomy($instance) {
Note: See TracChangeset for help on using the changeset viewer.