WordPress.org

Make WordPress Core

Changeset 19702


Ignore:
Timestamp:
01/06/12 18:31:43 (2 years ago)
Author:
duck_
Message:

Fix mistakes in parameter documentation and add some missing param docs. See #19756.

Location:
trunk
Files:
5 edited

Legend:

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

    r19680 r19702  
    566566     * @since 3.3.0 
    567567     * 
    568      * @param string 
     568     * @param string $option Option ID. 
     569     * @param mixed $key Optional. Specific array key for when the option is an array. 
    569570     */ 
    570571    public function get_option( $option, $key = false ) { 
  • trunk/wp-includes/category-template.php

    r19684 r19702  
    228228 * 
    229229 * @param int|string|array $category Category ID, name or slug, or array of said. 
    230  * @param int|object $_post Optional. Post to check instead of the current post. (since 2.7.0) 
     230 * @param int|object $post Optional. Post to check instead of the current post. (since 2.7.0) 
    231231 * @return bool True if the current post is in any of the given categories. 
    232232 */ 
     
    10511051 * 
    10521052 * @param int $term Optional. Term ID. Will use global term ID by default. 
     1053 * @param string $taxonomy Optional taxonomy name. Defaults to 'post_tag'. 
    10531054 * @return string Term description, available. 
    10541055 */ 
     
    11571158 * @since 3.1.0 
    11581159 * 
    1159  * @param string|int|array $tag Optional. The category name/term_id/slug or array of them to check for. 
     1160 * @param string|int|array $category Optional. The category name/term_id/slug or array of them to check for. 
    11601161 * @param int|object $post Optional. Post to check instead of the current post. 
    11611162 * @return bool True if the current post has any of the given categories (or any category, if no category specified). 
  • trunk/wp-includes/post.php

    r19684 r19702  
    28882888 * @param int $post_id Post ID. 
    28892889 * @param string $tags The tags to set for the post, separated by commas. 
     2890 * @param string $taxonomy Taxonomy name. Defaults to 'post_tag'. 
    28902891 * @param bool $append If true, don't delete existing tags, just add on. If false, replace the tags with the new tags. 
    28912892 * @return mixed Array of affected term IDs. WP_Error or false on failure. 
  • trunk/wp-includes/user.php

    r19695 r19702  
    165165 * 
    166166 * @since 3.0.0 
    167  * @param array $user_ids Array of user IDs. 
     167 * 
     168 * @param array $users Array of user IDs. 
    168169 * @param string|array $post_type Optional. Post type to check. Defaults to post. 
    169170 * @return array Amount of posts each user has written. 
    170171 */ 
    171 function count_many_users_posts($users, $post_type = 'post' ) { 
     172function count_many_users_posts( $users, $post_type = 'post' ) { 
    172173    global $wpdb; 
    173174 
  • trunk/wp-login.php

    r19687 r19702  
    240240 * @param string $key Hash to validate sending user's password 
    241241 * @param string $login The user login 
    242  * 
    243  * @return object|WP_Error 
     242 * @return object|WP_Error User's database row on success, error object for invalid keys 
    244243 */ 
    245244function check_password_reset_key($key, $login) { 
     
    265264 * Handles resetting the user's password. 
    266265 * 
    267  * @uses $wpdb WordPress Database object 
    268  * 
    269  * @param string $key Hash to validate sending user's password 
     266 * @param object $user The user 
     267 * @param string $new_pass New password for the user in plaintext 
    270268 */ 
    271269function reset_password($user, $new_pass) { 
Note: See TracChangeset for help on using the changeset viewer.