WordPress.org

Make WordPress Core

Changeset 15590


Ignore:
Timestamp:
09/07/10 11:21:11 (4 years ago)
Author:
nacin
Message:

Phpdoc argument/@param cleanups. props duck_, see #14783.

Location:
trunk
Files:
32 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-admin/includes/class-wp-filesystem-direct.php

    r13025 r15590  
    2020     * constructor 
    2121     * 
    22      * @param $arg mixed ingored argument 
     22     * @param mixed $arg ingored argument 
    2323     */ 
    2424    function WP_Filesystem_Direct($arg) { 
     
    3737     * Reads entire file into a string 
    3838     * 
    39      * @param $file string Name of the file to read. 
     39     * @param string $file Name of the file to read. 
    4040     * @return string|bool The function returns the read data or false on failure. 
    4141     */ 
     
    4646     * Reads entire file into an array 
    4747     * 
    48      * @param $file string Path to the file. 
     48     * @param string $file Path to the file. 
    4949     * @return array|bool the file contents in an array or false on failure. 
    5050     */ 
     
    5555     * Write a string to a file 
    5656     * 
    57      * @param $file string Remote path to the file where to write the data. 
    58      * @param $contents string The data to write. 
    59      * @param $mode int (optional) The file permissions as octal number, usually 0644. 
     57     * @param string $file Remote path to the file where to write the data. 
     58     * @param string $contents The data to write. 
     59     * @param int $mode (optional) The file permissions as octal number, usually 0644. 
    6060     * @return bool False upon failure. 
    6161     */ 
     
    7979     * Change directory 
    8080     * 
    81      * @param $dir string The new current directory. 
     81     * @param string $dir The new current directory. 
    8282     * @return bool Returns true on success or false on failure. 
    8383     */ 
     
    8888     * Changes file group 
    8989     * 
    90      * @param $file string Path to the file. 
    91      * @param $group mixed A group name or number. 
    92      * @param $recursive bool (optional) If set True changes file group recursivly. Defaults to False. 
     90     * @param string $file Path to the file. 
     91     * @param mixed $group A group name or number. 
     92     * @param bool $recursive (optional) If set True changes file group recursivly. Defaults to False. 
    9393     * @return bool Returns true on success or false on failure. 
    9494     */ 
     
    111111     * Changes filesystem permissions 
    112112     * 
    113      * @param $file string Path to the file. 
    114      * @param $mode int (optional) The permissions as octal number, usually 0644 for files, 0755 for dirs. 
    115      * @param $recursive bool (optional) If set True changes file group recursivly. Defaults to False. 
     113     * @param string $file Path to the file. 
     114     * @param int $mode (optional) The permissions as octal number, usually 0644 for files, 0755 for dirs. 
     115     * @param bool $recursive (optional) If set True changes file group recursivly. Defaults to False. 
    116116     * @return bool Returns true on success or false on failure. 
    117117     */ 
     
    139139     * Changes file owner 
    140140     * 
    141      * @param $file string Path to the file. 
    142      * @param $owner mixed A user name or number. 
    143      * @param $recursive bool (optional) If set True changes file owner recursivly. Defaults to False. 
     141     * @param string $file Path to the file. 
     142     * @param mixed $owner A user name or number. 
     143     * @param bool $recursive (optional) If set True changes file owner recursivly. Defaults to False. 
    144144     * @return bool Returns true on success or false on failure. 
    145145     */ 
     
    161161     * Gets file owner 
    162162     * 
    163      * @param $file string Path to the file. 
     163     * @param string $file Path to the file. 
    164164     * @return string Username of the user. 
    165165     */ 
     
    178178     * FIXME does not handle errors in fileperms() 
    179179     * 
    180      * @param $file string Path to the file. 
     180     * @param string $file Path to the file. 
    181181     * @return string Mode of the file (last 4 digits). 
    182182     */ 
  • trunk/wp-admin/includes/media.php

    r15292 r15590  
    836836 * 
    837837 * @param unknown_type $post 
    838  * @param unknown_type $checked 
     838 * @param unknown_type $check 
    839839 * @return unknown 
    840840 */ 
  • trunk/wp-admin/includes/meta-boxes.php

    r15546 r15590  
    434434 * @since 3.0.0 
    435435 * 
    436  * @param $result table header rows 
    437  * @return 
     436 * @param array $result table header rows 
     437 * @return array 
    438438 */ 
    439439function post_comment_meta_box_thead($result) { 
  • trunk/wp-admin/includes/ms.php

    r15488 r15590  
    713713 * 
    714714 * @since 3.0.0 
    715  * @param $user_id 
     715 * @param int $user_id 
    716716 */ 
    717717function grant_super_admin( $user_id ) { 
     
    741741 * 
    742742 * @since 3.0.0 
    743  * @param $user_id 
     743 * @param int $user_id 
    744744 */ 
    745745function revoke_super_admin( $user_id ) { 
  • trunk/wp-admin/includes/plugin.php

    r15376 r15590  
    429429 * @since 3.0.0 
    430430 * 
    431  * @param $file Plugin to check 
    432  * $return bool True if plugin is network only, false otherwise. 
     431 * @param string $plugin Plugin to check 
     432 * @return bool True if plugin is network only, false otherwise. 
    433433 */ 
    434434function is_network_only_plugin( $plugin ) { 
  • trunk/wp-admin/includes/post.php

    r15491 r15590  
    1616 * 
    1717 * @param bool $update Are we updating a pre-existing post? 
    18  * @param post_data array Array of post data. Defaults to the contents of $_POST. 
     18 * @param array $post_data Array of post data. Defaults to the contents of $_POST. 
    1919 * @return object|bool WP_Error on failure, true on success. 
    2020 */ 
     
    354354 * @since unknown 
    355355 * 
    356  *@param string A post type string, defaults to 'post'. 
     356 * @param string $post_type A post type string, defaults to 'post'. 
    357357 * @return object stdClass object containing all the default post data as attributes 
    358358 */ 
  • trunk/wp-admin/includes/template.php

    r15555 r15590  
    713713 
    714714/** 
    715  * Print out <option> html elements for role selectors based on $wp_roles 
    716  * 
    717  * @package WordPress 
    718  * @subpackage Administration 
     715 * Print out <option> html elements for role selectors 
     716 * 
    719717 * @since 2.1 
    720718 * 
    721  * @uses $wp_roles 
    722  * @param string $default slug for the role that should be already selected 
     719 * @param string $selected slug for the role that should be already selected 
    723720 */ 
    724721function wp_dropdown_roles( $selected = false ) { 
     
    730727    foreach ( $editable_roles as $role => $details ) { 
    731728        $name = translate_user_role($details['name'] ); 
    732         if ( $selected == $role ) // Make default first in list 
     729        if ( $selected == $role ) // preselect specified role 
    733730            $p = "\n\t<option selected='selected' value='" . esc_attr($role) . "'>$name</option>"; 
    734731        else 
     
    12691266 * @param boolean $sanitize Whether to re-sanitize the setting value before returning errors. 
    12701267 * @param boolean $hide_on_update If set to true errors will not be shown if the settings page has already been submitted. 
    1271  * @return <type> 
    1272  */ 
    1273 function settings_errors ( $setting = '', $sanitize = FALSE, $hide_on_update = FALSE ) { 
     1268 */ 
     1269function settings_errors( $setting = '', $sanitize = FALSE, $hide_on_update = FALSE ) { 
    12741270 
    12751271    if ($hide_on_update AND $_GET['updated']) return; 
     
    14941490 * 
    14951491 * @since 2.7.0 
    1496  * @param int $id The post id. If not supplied the global $post is used. 
    1497  * 
    1498  */ 
    1499 function _draft_or_post_title($post_id = 0) { 
     1492 * @param int $post_id The post id. If not supplied the global $post is used. 
     1493 * @return string The post title if set 
     1494 */ 
     1495function _draft_or_post_title( $post_id = 0 ) { 
    15001496    $title = get_the_title($post_id); 
    15011497    if ( empty($title) ) 
  • trunk/wp-includes/bookmark.php

    r14239 r15590  
    88 
    99/** 
    10  * Retrieve Bookmark data based on ID 
     10 * Retrieve Bookmark data 
    1111 * 
    1212 * @since 2.1.0 
    1313 * @uses $wpdb Database Object 
    1414 * 
    15  * @param int $bookmark_id 
     15 * @param mixed $bookmark 
    1616 * @param string $output Optional. Either OBJECT, ARRAY_N, or ARRAY_A constant 
    1717 * @param string $filter Optional, default is 'raw'. 
  • trunk/wp-includes/cache.php

    r15148 r15590  
    111111 * @see WP_Object_Cache::replace() 
    112112 * 
    113  * @param int|string $id What to call the contents in the cache 
     113 * @param int|string $key What to call the contents in the cache 
    114114 * @param mixed $data The contents to store in the cache 
    115115 * @param string $flag Where to group the cache contents 
     
    130130 * @see WP_Object_Cache::set() 
    131131 * 
    132  * @param int|string $id What to call the contents in the cache 
     132 * @param int|string $key What to call the contents in the cache 
    133133 * @param mixed $data The contents to store in the cache 
    134134 * @param string $flag Where to group the cache contents 
  • trunk/wp-includes/category-template.php

    r15355 r15590  
    251251 * @uses is_object_in_term() 
    252252 * 
    253  * @param int|string|array $category. Category ID, name or slug, or array of said. 
    254  * @param int|post object Optional.  Post to check instead of the current post. @since 2.7.0 
     253 * @param int|string|array $category Category ID, name or slug, or array of said. 
     254 * @param int|object $_post Optional. Post to check instead of the current post. (since 2.7.0) 
    255255 * @return bool True if the current post is in any of the given categories. 
    256256 */ 
     
    988988 * 
    989989 * @param string|int|array $tag Optional. The tag name/term_id/slug or array of them to check for. 
    990  * @param int|post object Optional.  Post to check instead of the current post. @since 2.7.0 
     990 * @param int|object $_post Optional. Post to check instead of the current post. (since 2.7.0) 
    991991 * @return bool True if the current post has any of the the given tags (or any tag, if no tag specified). 
    992992 */ 
  • trunk/wp-includes/classes.php

    r15587 r15590  
    981981     * @package WordPress 
    982982     * @since 2.7 
    983      * @param $max_depth = 0  means display all levels; $max_depth > 0 specifies the number of display levels. 
    984      * @param $page_num the specific page number, beginning with 1. 
     983     * @param int $max_depth = 0 means display all levels; $max_depth > 0 specifies the number of display levels. 
     984     * @param int $page_num the specific page number, beginning with 1. 
    985985     * @return XHTML of the specified page of elements 
    986986     */ 
  • trunk/wp-includes/comment-template.php

    r15563 r15590  
    163163 * @see get_comment_author_link() Echoes result 
    164164 * 
    165  * @param int The ID of the comment for which to print the author's link. Optional. 
     165 * @param int $comment_ID The ID of the comment for which to print the author's link. Optional. 
    166166 */ 
    167167function comment_author_link( $comment_ID = 0 ) { 
  • trunk/wp-includes/comment.php

    r15560 r15590  
    440440 * 
    441441 * @param int $comment_id Comment ID. 
    442  * @param string $key Metadata name. 
    443  * @param mixed $value Metadata value. 
     442 * @param string $meta_key Metadata name. 
     443 * @param mixed $meta_value Metadata value. 
    444444 * @param bool $unique Optional, default is false. Whether the same key should not be added. 
    445445 * @return bool False for failure. True for success. 
     
    499499 * 
    500500 * @param int $comment_id Comment ID. 
    501  * @param string $key Metadata key. 
    502  * @param mixed $value Metadata value. 
     501 * @param string $meta_key Metadata key. 
     502 * @param mixed $meta_value Metadata value. 
    503503 * @param mixed $prev_value Optional. Previous value to check before removing. 
    504504 * @return bool False on failure, true if success. 
     
    18591859 * @subpackage Cache 
    18601860 * 
    1861  * @param int|array $id Comment ID or array of comment IDs to remove from cache 
     1861 * @param int|array $ids Comment ID or array of comment IDs to remove from cache 
    18621862 */ 
    18631863function clean_comment_cache($ids) { 
  • trunk/wp-includes/deprecated.php

    r15531 r15590  
    165165 * 
    166166 * @param string $format 
    167  * @param string $previous 
     167 * @param string $next 
    168168 * @param string $title 
    169169 * @param string $in_same_cat 
    170  * @param int $limitprev 
     170 * @param int $limitnext 
    171171 * @param string $excluded_categories 
    172172 */ 
     
    873873 * @see the_permalink_rss() 
    874874 * 
    875  * @param string $file 
     875 * @param string $deprecated 
    876876 */ 
    877877function permalink_single_rss($deprecated = '') { 
  • trunk/wp-includes/formatting.php

    r15554 r15590  
    14751475 * 
    14761476 * @param string $email Email address to verify. 
    1477  * @param boolean $deprecated. Deprecated. 
     1477 * @param boolean $deprecated Deprecated. 
    14781478 * @return string|bool Either false or the valid email address. 
    14791479 */ 
  • trunk/wp-includes/functions.php

    r15581 r15590  
    41784178 * 
    41794179 * @param string $file Path to the file 
    4180  * @param bool $markup If the returned data should have HTML markup applied 
     4180 * @param array $default_headers Default metadata headers 
    41814181 * @param string $context If specified adds filter hook "extra_<$context>_headers" 
    41824182 */ 
  • trunk/wp-includes/functions.wp-scripts.php

    r12558 r15590  
    4343 * @param array $deps (optional) Array of script names on which this script depends 
    4444 * @param string|bool $ver (optional) Script version (used for cache busting), set to NULL to disable 
    45  * @param bool (optional) Wether to enqueue the script before </head> or before </body> 
     45 * @param bool $in_footer (optional) Whether to enqueue the script before </head> or before </body> 
    4646 * @return null 
    4747 */ 
  • trunk/wp-includes/general-template.php

    r15585 r15590  
    20382038 * @param string $name The name of the theme. 
    20392039 * @param string $url The url of the css file containing the colour scheme. 
    2040  * @param array @colors Optional An array of CSS color definitions which are used to give the user a feel for the theme. 
     2040 * @param array $colors Optional An array of CSS color definitions which are used to give the user a feel for the theme. 
    20412041 */ 
    20422042function wp_admin_css_color($key, $name, $url, $colors = array()) { 
     
    22472247 * @since 1.0 
    22482248 * 
    2249  * @param mixed selected One of the values to compare 
     2249 * @param mixed $selected One of the values to compare 
    22502250 * @param mixed $current (true) The other value to compare if not just true 
    22512251 * @param bool $echo Whether to echo or just return the string 
  • trunk/wp-includes/l10n.php

    r15138 r15590  
    271271 * 
    272272 * @since 2.5 
    273  * @param $single Single form to be i18ned 
    274  * @param $plural Plural form to be i18ned 
     273 * @param string $single Single form to be i18ned 
     274 * @param string $plural Plural form to be i18ned 
    275275 * @return array array($single, $plural) 
    276276 */ 
  • trunk/wp-includes/link-template.php

    r15582 r15590  
    2828 * @uses $wp_rewrite 
    2929 * 
    30  * @param $string String a URL with or without a trailing slash. 
    31  * @param $type_of_url String the type of URL being considered (e.g. single, category, etc) for use in the filter. 
     30 * @param string $string URL with or without a trailing slash. 
     31 * @param string $type_of_url The type of URL being considered (e.g. single, category, etc) for use in the filter. 
    3232 * @return string 
    3333 */ 
     
    11551155 * @param bool $in_same_cat Optional. Whether returned post should be in same category. 
    11561156 * @param string $excluded_categories Optional. Excluded categories IDs. 
    1157  * @param bool $previous Optional. Whether to retrieve first post. 
     1157 * @param bool $start Optional. Whether to retrieve first or last post. 
    11581158 * @return object 
    11591159 */ 
     
    12011201 * @param bool $in_same_cat Optional. Whether link should be in same category. 
    12021202 * @param string $excluded_categories Optional. Excluded categories IDs. 
    1203  * @param bool $start Optional, default is true. Whether display link to first post. 
     1203 * @param bool $start Optional, default is true. Whether display link to first or last post. 
    12041204 * @return string 
    12051205 */ 
     
    21872187 * 
    21882188 * @param int $id A post or blog id.  Default is 0, which means the current post or blog. 
    2189  * @param string $contex Whether the id is a 'blog' id, 'post' id, or 'media' id.  If 'post', the post_type of the post is consulted. If 'query', the current query is consulted to determine the id and context. Default is 'post'. 
     2189 * @param string $context Whether the id is a 'blog' id, 'post' id, or 'media' id. If 'post', the post_type of the post is consulted. If 'query', the current query is consulted to determine the id and context. Default is 'post'. 
    21902190 * @param bool $allow_slugs Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this. 
    21912191 * @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled. 
  • trunk/wp-includes/media.php

    r15473 r15590  
    961961 * @since 2.9.0 
    962962 * 
    963  * @param $mime_type string 
     963 * @param string $mime_type 
    964964 * @return bool 
    965965 */ 
     
    992992 * @since 2.9.0 
    993993 * 
    994  * @param $width 
    995  * @param $height 
     994 * @param int $width Image width 
     995 * @param int $height Image height 
    996996 * @return image resource 
    997997 */ 
  • trunk/wp-includes/meta.php

    r15389 r15590  
    329329 * @uses $wpdb WordPress database object for queries. 
    330330 * 
    331  * @param string $meta_type Type of object to get metadata table for (e.g., comment, post, or user) 
     331 * @param string $type Type of object to get metadata table for (e.g., comment, post, or user) 
    332332 * @return mixed Metadata table name, or false if no metadata table exists 
    333333 */ 
  • trunk/wp-includes/nav-menu.php

    r15467 r15590  
    404404 * @since 3.0.0 
    405405 * 
    406  * @param $args array Array of arguments passed on to get_terms(). 
     406 * @param array $args Array of arguments passed on to get_terms(). 
    407407 * @return array menu objects 
    408408 */ 
  • trunk/wp-includes/plugin.php

    r14924 r15590  
    728728 * @param callback $function Used for creating unique id 
    729729 * @param int|bool $priority Used in counting how many hooks were applied.  If === false and $function is an object reference, we return the unique id only if it already has one, false otherwise. 
    730  * @param string $type filter or action 
    731730 * @return string|bool Unique ID for usage as array key or false if $priority === false and $function is an object reference, and it does not already have a uniqe id. 
    732731 */ 
  • trunk/wp-includes/pomo/streams.php

    r13316 r15590  
    2323     * Sets the endianness of the file. 
    2424     * 
    25      * @param $endian string 'big' or 'little' 
     25     * @param string $endian 'big' or 'little' 
    2626     */ 
    2727    function setEndian($endian) { 
  • trunk/wp-includes/post.php

    r15589 r15590  
    626626 * @see get_post_statuses 
    627627 * 
    628  * @param string $post_type The name of a registered post status 
     628 * @param string $post_status The name of a registered post status 
    629629 * @return object A post status object 
    630630 */ 
     
    670670 * @see get_post_type_object 
    671671 * 
    672  * @param string $post Post type name 
     672 * @param string $post_type Post type name 
    673673 * @return bool Whether post type is hierarchical. 
    674674 */ 
     
    687687 * @uses get_post_type_object() 
    688688 * 
    689  * @param string Post type name 
     689 * @param string $post_type Post type name 
    690690 * @return bool Whether post type is registered. 
    691691 */ 
     
    11451145 * 
    11461146 * @param int $post_id Post ID. 
    1147  * @param string $key Metadata name. 
    1148  * @param mixed $value Metadata value. 
     1147 * @param string $meta_key Metadata name. 
     1148 * @param mixed $meta_value Metadata value. 
    11491149 * @param bool $unique Optional, default is false. Whether the same key should not be added. 
    11501150 * @return bool False for failure. True for success. 
     
    12121212 * 
    12131213 * @param int $post_id Post ID. 
    1214  * @param string $key Metadata key. 
    1215  * @param mixed $value Metadata value. 
     1214 * @param string $meta_key Metadata key. 
     1215 * @param mixed $meta_value Metadata value. 
    12161216 * @param mixed $prev_value Optional. Previous value to check before removing. 
    12171217 * @return bool False on failure, true if success. 
     
    16511651 * @since 2.5.0 
    16521652 * 
    1653  * @param string|array $mime_types List of mime types or comma separated string of mime types. 
     1653 * @param string|array $post_mime_types List of mime types or comma separated string of mime types. 
    16541654 * @param string $table_alias Optional. Specify a table alias, if needed. 
    16551655 * @return string The SQL AND clause for mime searching. 
     
    18101810 * @uses wp_delete_post() if trash is disabled 
    18111811 * 
    1812  * @param int $postid Post ID. 
     1812 * @param int $post_id Post ID. 
    18131813 * @return mixed False on failure 
    18141814 */ 
     
    18451845 * @uses do_action() on 'untrashed_post' after undeletion 
    18461846 * 
    1847  * @param int $postid Post ID. 
     1847 * @param int $post_id Post ID. 
    18481848 * @return mixed False on failure 
    18491849 */ 
     
    29652965 * @since 2.0.0 
    29662966 * 
    2967  * @param array $posts Posts array. 
    2968  * @param int $parent Parent page ID. 
     2967 * @param array $pages Posts array. 
     2968 * @param int $page_id Parent page ID. 
    29692969 * @return array A list arranged by hierarchy. Children immediately follow their parents. 
    29702970 */ 
    29712971function &get_page_hierarchy( &$pages, $page_id = 0 ) { 
    2972  
    29732972    if ( empty( $pages ) ) { 
    29742973        $result = array(); 
     
    29782977    $children = array(); 
    29792978    foreach ( (array) $pages as $p ) { 
    2980  
    29812979        $parent_id = intval( $p->post_parent ); 
    29822980        $children[ $parent_id ][] = $p; 
    2983      } 
    2984  
    2985      $result = array(); 
    2986      _page_traverse_name( $page_id, $children, $result ); 
     2981    } 
     2982 
     2983    $result = array(); 
     2984    _page_traverse_name( $page_id, $children, $result ); 
    29872985 
    29882986    return $result; 
     
    29952993 */ 
    29962994function _page_traverse_name( $page_id, &$children, &$result ){ 
    2997  
    29982995    if ( isset( $children[ $page_id ] ) ){ 
    2999  
    30002996        foreach( (array)$children[ $page_id ] as $child ) { 
    3001  
    30022997            $result[ $child->ID ] = $child->post_name; 
    30032998            _page_traverse_name( $child->ID, $children, $result ); 
     
    32783273 * @param string|array $object Arguments to override defaults. 
    32793274 * @param string $file Optional filename. 
    3280  * @param int $post_parent Parent post ID. 
     3275 * @param int $parent Parent post ID. 
    32813276 * @return int Attachment ID. 
    32823277 */ 
     
    34283423 * @uses do_action() Calls 'delete_attachment' hook on Attachment ID. 
    34293424 * 
    3430  * @param int $postid Attachment ID. 
     3425 * @param int $post_id Attachment ID. 
    34313426 * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false. 
    34323427 * @return mixed False on failure. Post data on success. 
     
    46464641 * 
    46474642 * @param int|object $revision_id Revision ID or revision object. 
    4648  * @param array $fields Optional. What fields to restore from.  Defaults to all. 
    4649  * @return mixed Null if error, false if no fields to restore, (int) post ID if success. 
     4643 * @return mixed Null or WP_Error if error, deleted post if success. 
    46504644 */ 
    46514645function wp_delete_post_revision( $revision_id ) { 
  • trunk/wp-includes/query.php

    r15589 r15590  
    202202 * 
    203203 * @param mixed $taxonomy Optional. Taxonomy slug or slugs. 
    204  * @param mixed $term. Optional. Term ID, name, slug or array of Term IDs, names, and slugs. 
     204 * @param mixed $term Optional. Term ID, name, slug or array of Term IDs, names, and slugs. 
    205205 * @return bool 
    206206 */ 
  • trunk/wp-includes/rewrite.php

    r15582 r15590  
    19511951     * @since 2.0.1 
    19521952     * @access public 
    1953      * @param $hard bool Whether to update .htaccess (hard flush) or just update rewrite_rules option (soft flush). Default is true (hard). 
     1953     * @param bool $hard Whether to update .htaccess (hard flush) or just update rewrite_rules option (soft flush). Default is true (hard). 
    19541954     */ 
    19551955    function flush_rules($hard = true) { 
  • trunk/wp-includes/taxonomy.php

    r15586 r15590  
    641641 * @uses get_term_children() Used to get the children of both $taxonomy and the parent $term 
    642642 * 
    643  * @param string $term ID of Term to get children 
     643 * @param string $term_id ID of Term to get children 
    644644 * @param string $taxonomy Taxonomy Name 
    645645 * @return array|WP_Error List of Term Objects. WP_Error returned if $taxonomy does not exist 
     
    816816 * @uses wp_parse_args() Merges the defaults with those defined by $args and allows for strings. 
    817817 * 
    818  * @param string|array Taxonomy name or list of Taxonomy names 
     818 * @param string|array $taxonomies Taxonomy name or list of Taxonomy names 
    819819 * @param string|array $args The values of what to search for when returning terms 
    820820 * @return array|WP_Error List of Term Objects and their children. Will return WP_Error, if any of $taxonomies do not exist. 
     
    13071307 * 
    13081308 * @param int $object_id The term Object Id that refers to the term 
    1309  * @param string|array $taxonomy List of Taxonomy Names or single Taxonomy name. 
     1309 * @param string|array $taxonomies List of Taxonomy Names or single Taxonomy name. 
    13101310 */ 
    13111311function wp_delete_object_term_relationships( $object_id, $taxonomies ) { 
     
    14451445 * @uses $wpdb 
    14461446 * 
    1447  * @param int|array $object_id The id of the object(s) to retrieve. 
     1447 * @param int|array $object_ids The ID(s) of the object(s) to retrieve. 
    14481448 * @param string|array $taxonomies The taxonomies to retrieve terms from. 
    14491449 * @param array|string $args Change what is returned 
     
    17151715 * 
    17161716 * @param int $object_id The object to relate to. 
    1717  * @param array|int|string $term The slug or id of the term, will replace all existing 
     1717 * @param array|int|string $terms The slug or id of the term, will replace all existing 
    17181718 * related terms in this taxonomy. 
    17191719 * @param array|string $taxonomy The context in which to relate the term to the object. 
     
    26342634 * @uses wp_get_object_terms() 
    26352635 * 
    2636  * @param int $object_id. ID of the object (post ID, link ID, ...) 
    2637  * @param string $taxonomy. Single taxonomy name 
     2636 * @param int $object_id ID of the object (post ID, link ID, ...) 
     2637 * @param string $taxonomy Single taxonomy name 
    26382638 * @param int|string|array $terms Optional.  Term term_id, name, slug or array of said 
    26392639 * @return bool|WP_Error. WP_Error on input error. 
     
    26802680 * 
    26812681 * @param string $object_type Object type string 
    2682  * @param string $taxonomy. Single taxonomy name 
     2682 * @param string $taxonomy Single taxonomy name 
    26832683 * @return bool True if object is associated with the taxonomy, otherwise false. 
    26842684 */ 
  • trunk/wp-includes/theme.php

    r15435 r15590  
    646646 * 
    647647 * @since 1.5.0 
    648  * @param $stylesheet_or_template The stylesheet or template name of the theme 
    649648 * @uses apply_filters() Calls 'theme_root' filter on path. 
    650649 * 
     650 * @param string $stylesheet_or_template The stylesheet or template name of the theme 
    651651 * @return string Theme path. 
    652652 */ 
     
    672672 * 
    673673 * @since 1.5.0 
    674  * @param $stylesheet_or_template The stylesheet or template name of the theme 
    675  * 
     674 * 
     675 * @param string $stylesheet_or_template The stylesheet or template name of the theme 
    676676 * @return string Themes URI. 
    677677 */ 
     
    14331433 * @since 3.0.0 
    14341434 * 
    1435  * @param string|array The header string id (key of array) to remove, or an array thereof. 
     1435 * @param string|array $header The header string id (key of array) to remove, or an array thereof. 
    14361436 * @return True on success, false on failure. 
    14371437 */ 
  • trunk/wp-includes/user.php

    r15580 r15590  
    163163 * 
    164164 * @since 3.0.0 
    165  * @param array $userid User ID number list. 
     165 * @param array $users User ID number list. 
    166166 * @return array Amount of posts each user has written. 
    167167 */ 
     
    585585 * 
    586586 * @param int $user_id Post ID. 
    587  * @param string $key Metadata name. 
    588  * @param mixed $value Metadata value. 
     587 * @param string $meta_key Metadata name. 
     588 * @param mixed $meta_value Metadata value. 
    589589 * @param bool $unique Optional, default is false. Whether the same key should not be added. 
    590590 * @return bool False for failure. True for success. 
     
    644644 * 
    645645 * @param int $user_id Post ID. 
    646  * @param string $key Metadata key. 
    647  * @param mixed $value Metadata value. 
     646 * @param string $meta_key Metadata key. 
     647 * @param mixed $meta_value Metadata value. 
    648648 * @param mixed $prev_value Optional. Previous value to check before removing. 
    649649 * @return bool False on failure, true if success. 
  • trunk/wp-includes/widgets.php

    r14404 r15590  
    597597 * @param string $name Widget display title. 
    598598 * @param callback $output_callback Run when widget is called. 
    599  * @param array|string Optional. $options Widget Options. 
     599 * @param array|string $options Optional. Widget Options. 
    600600 * @param mixed $params,... Widget parameters to add to widget. 
    601601 * @return null Will return if $output_callback is empty after removing widget. 
     
    912912 * @since 2.2.0 
    913913 * 
    914  * @param callback Optional, Widget callback to check. 
     914 * @param string $callback Optional, Widget callback to check. 
    915915 * @param int $widget_id Optional, but needed for checking. Widget ID. 
    916916 * @param string $id_base Optional, the base ID of a widget created by extending WP_Widget. 
     
    966966 * @since 2.8 
    967967 * 
    968  * @param mixed $index, sidebar name, id or number to check. 
     968 * @param mixed $index Sidebar name, id or number to check. 
    969969 * @return bool true if the sidebar is in use, false otherwise. 
    970970 */ 
     
    989989 * @access private 
    990990 * 
    991  * @param bool $deprecated. Not used. 
     991 * @param bool $deprecated Not used (deprecated). 
    992992 * @return array Upgraded list of widgets to version 3 array format when called from the admin. 
    993993 */ 
Note: See TracChangeset for help on using the changeset viewer.