WordPress.org

Make WordPress Core

Changeset 20349


Ignore:
Timestamp:
04/04/12 17:32:03 (3 years ago)
Author:
duck_
Message:

Add some missing documentation and fix a couple of typos. Props roscius. Fixes #19756.

Location:
trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-admin/includes/template.php

    r20217 r20349  
    1414 
    1515/** 
    16  * {@internal Missing Short Description}} 
    17  * 
     16 * Walker to output an unordered list of category checkbox <input> elements. 
     17 * 
     18 * @see Walker 
     19 * @see wp_category_checklist() 
     20 * @see wp_terms_checklist() 
    1821 * @since 2.5.1 
    1922 */ 
     
    5255 
    5356/** 
    54  * {@internal Missing Short Description}} 
    55  * 
     57 * Output an unordered list of checkbox <input> elements labelled 
     58 * with category names. 
     59 * 
     60 * @see wp_terms_checklist() 
    5661 * @since 2.5.1 
    5762 * 
    58  * @param unknown_type $post_id 
    59  * @param unknown_type $descendants_and_self 
    60  * @param unknown_type $selected_cats 
    61  * @param unknown_type $popular_cats 
     63 * @param int $post_id Mark categories associated with this post as checked. $selected_cats must not be an array. 
     64 * @param int $descendants_and_self ID of the category to output along with its descendents. 
     65 * @param bool|array $selected_cats List of categories to mark as checked. 
     66 * @param bool|array $popular_cats Override the list of categories that receive the "popular-category" class. 
     67 * @param object $walker Walker object to use to build the output. 
     68 * @param bool $checked_ontop Move checked items out of the hierarchy and to the top of the list. 
    6269 */ 
    6370function wp_category_checklist( $post_id = 0, $descendants_and_self = 0, $selected_cats = false, $popular_cats = false, $walker = null, $checked_ontop = true ) { 
    64     wp_terms_checklist($post_id, 
    65         array( 
    66             'taxonomy' => 'category', 
    67             'descendants_and_self' => $descendants_and_self, 
    68             'selected_cats' => $selected_cats, 
    69             'popular_cats' => $popular_cats, 
    70             'walker' => $walker, 
    71             'checked_ontop' => $checked_ontop 
    72   )); 
    73 } 
    74  
    75 /** 
    76  * Taxonomy independent version of wp_category_checklist 
     71    wp_terms_checklist( $post_id, array( 
     72        'taxonomy' => 'category', 
     73        'descendants_and_self' => $descendants_and_self, 
     74        'selected_cats' => $selected_cats, 
     75        'popular_cats' => $popular_cats, 
     76        'walker' => $walker, 
     77        'checked_ontop' => $checked_ontop 
     78    ) ); 
     79} 
     80 
     81/** 
     82 * Output an unordered list of checkbox <input> elements labelled 
     83 * with term names. Taxonomy independent version of wp_category_checklist(). 
    7784 * 
    7885 * @since 3.0.0 
     
    142149 
    143150/** 
    144  * {@internal Missing Short Description}} 
     151 * Retrieve a list of the most popular terms from the specified taxonomy. 
     152 * 
     153 * If the $echo argument is true then the elements for a list of checkbox 
     154 * <input> elements labelled with the names of the selected terms is output. 
     155 * If the $post_ID global isn't empty then the terms associated with that 
     156 * post will be marked as checked. 
    145157 * 
    146158 * @since 2.5.0 
    147159 * 
    148  * @param unknown_type $taxonomy 
    149  * @param unknown_type $default 
    150  * @param unknown_type $number 
    151  * @param unknown_type $echo 
    152  * @return unknown 
     160 * @param string $taxonomy Taxonomy to retrieve terms from. 
     161 * @param int $default Unused. 
     162 * @param int $number Number of terms to retrieve. Defaults to 10. 
     163 * @param bool $echo Optionally output the list as well. Defaults to true. 
     164 * @return array List of popular term IDs. 
    153165 */ 
    154166function wp_popular_terms_checklist( $taxonomy, $default = 0, $number = 10, $echo = true ) { 
  • trunk/wp-includes/class-wp-customize-control.php

    r20319 r20349  
    141141 
    142142    /** 
    143      * Check capabiliites and render the control. 
     143     * Check capabilities and render the control. 
    144144     * 
    145145     * @since 3.4.0 
  • trunk/wp-includes/class-wp-customize-section.php

    r20295 r20349  
    5959 
    6060    /** 
    61      * Check capabiliites and render the section. 
     61     * Check capabilities and render the section. 
    6262     * 
    6363     * @since 3.4.0 
Note: See TracChangeset for help on using the changeset viewer.