Show
Ignore:
Timestamp:
05/25/08 15:45:05 (6 months ago)
Author:
ryan
Message:

phpdoc updates from jacobsantos. see #7038

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/wp-includes/author-template.php

    r7104 r7990  
    22/** 
    33 * Author Template functions for use in themes. 
     4 * 
     5 * These functions must be used within the WordPress Loop. 
     6 * 
     7 * @link http://codex.wordpress.org/Author_Templates 
    48 * 
    59 * @package WordPress 
    …… 
    812 
    913/** 
    10  * get_the_author() - Get the author of the current post in the Loop. 
     14 * Retrieve the author of the current post. 
    1115 * 
    1216 * @since 1.5 
    …… 
    2327 
    2428/** 
    25  * the_author() - Echo the name of the author of the current post in the Loop. 
    26  * 
    27  * The behavior of this function is based off of old functionality predating get_the_author(). 
    28  * This function is not deprecated, but is designed to echo the value from get_the_author() 
    29  * and as an result of any old theme that might still use the old behavior will also 
    30  * pass the value from get_the_author(). 
    31  * 
    32  * The normal, expected behavior of this function is to echo the author and not return it. 
    33  * However, backwards compatiability has to be maintained. 
     29 * Display the name of the author of the current post. 
     30 * 
     31 * The behavior of this function is based off of old functionality predating 
     32 * get_the_author(). This function is not deprecated, but is designed to echo 
     33 * the value from get_the_author() and as an result of any old theme that might 
     34 * still use the old behavior will also pass the value from get_the_author(). 
     35 * 
     36 * The normal, expected behavior of this function is to echo the author and not 
     37 * return it. However, backwards compatiability has to be maintained. 
    3438 * 
    3539 * @since 0.71 
    3640 * @see get_the_author() 
     41 * @link http://codex.wordpress.org/Template_Tags/the_author 
    3742 * 
    3843 * @param string $deprecated Deprecated. 
    39  * @param string $deprecated_echo Echo the string or return it. Deprecated, use get_the_author(). 
     44 * @param string $deprecated_echo Echo the string or return it. 
    4045 * @return string The author's display name, from get_the_author(). 
    4146 */ 
    …… 
    4752 
    4853/** 
    49  * get_the_author_description() - Get the description of the author of the current post in the Loop. 
     54 * Retrieve the description of the author of the current post. 
    5055 * 
    5156 * @since 1.5 
    …… 
    5964 
    6065/** 
    61  * the_author_description() - Echo the description of the author of the current post in the Loop. 
    62  * 
     66 * Display the description of the author of the current post. 
     67 * 
     68 * @link http://codex.wordpress.org/Template_Tags/the_author_description 
    6369 * @since 1.0.0 
    6470 * @see get_the_author_description() 
    …… 
    6975 
    7076/** 
    71  * get_the_author_login() - Get the login name of the author of the current post in the Loop. 
     77 * Retrieve the login name of the author of the current post. 
    7278 * 
    7379 * @since 1.5 
    …… 
    8187 
    8288/** 
    83  * the_author_login() - Echo the login name of the author of the current post in the Loop. 
    84  * 
     89 * Display the login name of the author of the current post. 
     90 * 
     91 * @link http://codex.wordpress.org/Template_Tags/the_author_login 
    8592 * @since 0.71 
    8693 * @see get_the_author_login() 
    …… 
    9198 
    9299/** 
    93  * get_the_author_firstname() - Get the first name of the author of the current post in the Loop. 
     100 * Retrieve the first name of the author of the current post. 
    94101 * 
    95102 * @since 1.5 
    …… 
    103110 
    104111/** 
    105  * the_author_firstname() - Echo the first name of the author of the current post in the Loop. 
    106  * 
     112 * Display the first name of the author of the current post. 
     113 * 
     114 * @link http://codex.wordpress.org/Template_Tags/the_author_firstname 
    107115 * @since 0.71 
    108116 * @uses get_the_author_firstname() 
    …… 
    113121 
    114122/** 
    115  * get_the_author_lastname() - Get the last name of the author of the current post in the Loop. 
     123 * Retrieve the last name of the author of the current post. 
    116124 * 
    117125 * @since 1.5 
    …… 
    125133 
    126134/** 
    127  * the_author_lastname() - Echo the last name of the author of the current post in the Loop. 
    128  * 
     135 * Display the last name of the author of the current post. 
     136 * 
     137 * @link http://codex.wordpress.org/Template_Tags/the_author_lastname 
    129138 * @since 0.71 
    130139 * @uses get_the_author_lastname() 
    …… 
    135144 
    136145/** 
    137  * get_the_author_nickname() - Get the nickname of the author of the current post in the Loop. 
     146 * Retrieve the nickname of the author of the current post. 
    138147 * 
    139148 * @since 1.5 
    …… 
    147156 
    148157/** 
    149  * the_author_nickname() - Echo the nickname of the author of the current post in the Loop. 
    150  * 
     158 * Display the nickname of the author of the current post. 
     159 * 
     160 * @link http://codex.wordpress.org/Template_Tags/the_author_nickname 
    151161 * @since 0.71 
    152162 * @uses get_the_author_nickname() 
    …… 
    157167 
    158168/** 
    159  * get_the_author_ID() - Get the ID of the author of the current post in the Loop. 
     169 * Retrieve the ID of the author of the current post. 
    160170 * 
    161171 * @since 1.5 
    …… 
    169179 
    170180/** 
    171  * the_author_ID() - Echo the ID of the author of the current post in the Loop. 
    172  * 
     181 * Display the ID of the author of the current post. 
     182 * 
     183 * @http://codex.wordpress.org/Template_Tags/the_author_ID 
    173184 * @since 0.71 
    174185 * @uses get_the_author_ID() 
    …… 
    179190 
    180191/** 
    181  * get_the_author_email() - Get the email of the author of the current post in the Loop. 
     192 * Retrieve the email of the author of the current post. 
    182193 * 
    183194 * @since 1.5 
    …… 
    191202 
    192203/** 
    193  * the_author_email() - Echo the email of the author of the current post in the Loop. 
    194  * 
     204 * Display the email of the author of the current post. 
     205 * 
     206 * @link http://codex.wordpress.org/Template_Tags/the_author_email 
    195207 * @since 0.71 
    196208 * @uses get_the_author_email() 
    …… 
    201213 
    202214/** 
    203  * get_the_author_url() - Get the URL to the home page of the author of the current post in the Loop. 
     215 * Retrieve the URL to the home page of the author of the current post. 
    204216 * 
    205217 * @since 1.5 
    …… 
    217229 
    218230/** 
    219  * the_author_url() - Echo the URL to the home page of the author of the current post in the Loop. 
    220  * 
     231 * Display the URL to the home page of the author of the current post. 
     232 * 
     233 * @link http://codex.wordpress.org/Template_Tags/the_author_url 
    221234 * @since 0.71 
    222235 * @uses get_the_author_url() 
    …… 
    227240 
    228241/** 
    229  * the_author_link() - If the author has a home page set, echo an HTML link, otherwise just echo the author's name. 
    230  * 
     242 * Display either author's link or author's name. 
     243 * 
     244 * If the author has a home page set, echo an HTML link, otherwise just echo the 
     245 * author's name. 
     246 * 
     247 * @link http://codex.wordpress.org/Template_Tags/the_author_link 
    231248 * @since 2.1 
    232249 * @uses get_the_author_url() 
    …… 
    242259 
    243260/** 
    244  * get_the_author_icq() - Get the ICQ number of the author of the current post in the Loop. 
     261 * Retrieve the ICQ number of the author of the current post. 
    245262 * 
    246263 * @since 1.5 
    …… 
    254271 
    255272/** 
    256  * the_author_icq() - Echo the ICQ number of the author of the current post in the Loop. 
    257  * 
     273 * Display the ICQ number of the author of the current post. 
     274 * 
     275 * @link http://codex.wordpress.org/Template_Tags/the_author_icq 
    258276 * @since 0.71 
    259277 * @see get_the_author_icq() 
    …… 
    264282 
    265283/** 
    266  * get_the_author_aim() - Get the AIM name of the author of the current post in the Loop. 
     284 * Retrieve the AIM name of the author of the current post. 
    267285 * 
    268286 * @since 1.5 
    …… 
    276294 
    277295/** 
    278  * the_author_aim() - Echo the AIM name of the author of the current post in the Loop. 
    279  * 
     296 * Display the AIM name of the author of the current post. 
     297 * 
     298 * @link http://codex.wordpress.org/Template_Tags/the_author_aim 
    280299 * @since 0.71 
    281300 * @see get_the_author_aim() 
    …… 
    286305 
    287306/** 
    288  * get_the_author_yim() - Get the Yahoo! IM name of the author of the current post in the Loop. 
     307 * Retrieve the Yahoo! IM name of the author of the current post. 
    289308 * 
    290309 * @since 1.5 
    …… 
    298317 
    299318/** 
    300  * the_author_yim() - Echo the Yahoo! IM name of the author of the current post in the Loop. 
    301  * 
     319 * Display the Yahoo! IM name of the author of the current post. 
     320 * 
     321 * @link http://codex.wordpress.org/Template_Tags/the_author_yim 
    302322 * @since 0.71 
    303323 * @see get_the_author_yim() 
    …… 
    308328 
    309329/** 
    310  * get_the_author_msn() - Get the MSN address of the author of the current post in the Loop. 
     330 * Retrieve the MSN address of the author of the current post. 
    311331 * 
    312332 * @since 1.5 
    …… 
    320340 
    321341/** 
    322  * the_author_msn() - Echo the MSN address of the author of the current post in the Loop. 
    323  * 
     342 * Display the MSN address of the author of the current post. 
     343 * 
     344 * @link http://codex.wordpress.org/Template_Tags/the_author_msn 
    324345 * @since 0.71 
    325346 * @see get_the_author_msn() 
    …… 
    330351 
    331352/** 
    332  * get_the_author_posts() - Get the number of posts by the author of the current post in the Loop. 
     353 * Retrieve the number of posts by the author of the current post. 
    333354 * 
    334355 * @since 1.5 
    …… 
    343364 
    344365/** 
    345  * the_author_posts() - Echo the number of posts by the author of the current post in the Loop. 
    346  * 
     366 * Display the number of posts by the author of the current post. 
     367 * 
     368 * @link http://codex.wordpress.org/Template_Tags/the_author_posts 
    347369 * @since 0.71 
    348370 * @uses get_the_author_posts() Echos returned value from function. 
    …… 
    353375 
    354376/** 
    355  * the_author_posts_link() - Echo an HTML link to the author page of the author of the current post in the Loop. 
    356  * 
    357  * Does just echo get_author_posts_url() function, like the others do. The reason for this, 
    358  * is that another function is used to help in printing the link to the author's posts. 
    359  * 
     377 * Display an HTML link to the author page of the author of the current post. 
     378 * 
     379 * Does just echo get_author_posts_url() function, like the others do. The 
     380 * reason for this, is that another function is used to help in printing the 
     381 * link to the author's posts. 
     382 * 
     383 * @link http://codex.wordpress.org/Template_Tags/the_author_posts_link 
    360384 * @since 1.2 
    361385 * @uses $authordata The current author's DB object. 
    …… 
    375399 
    376400/** 
    377  * get_author_posts_url() - Get the URL to the author page of the author of the current post in the Loop. 
     401 * Retrieve the URL to the author page of the author of the current post. 
    378402 * 
    379403 * @since 2.1 
    …… 
    405429 
    406430/** 
    407  * get_author_name() - Get the specified author's preferred display name. 
     431 * Retrieve the specified author's preferred display name. 
    408432 * 
    409433 * @since 1.0.0 
    …… 
    417441 
    418442/** 
    419  * wp_list_authors() - List all the authors of the blog, with several options available. 
    420  * 
    421  * optioncount (boolean) (false): Show the count in parenthesis next to the author's name. 
    422  * exclude_admin (boolean) (true): Exclude the 'admin' user that is installed by default. 
     443 * List all the authors of the blog, with several options available. 
     444 * 
     445 * optioncount (boolean) (false): Show the count in parenthesis next to the 
     446 *      author's name. 
     447 * exclude_admin (boolean) (true): Exclude the 'admin' user that is installed by 
     448 *      default. 
    423449 * show_fullname (boolean) (false): Show their full names. 
    424450 * hide_empty (boolean) (true): Don't show authors without any posts. 
    …… 
    427453 * echo (boolean) (true): Set to false to return the output, instead of echoing. 
    428454 * 
     455 * @link http://codex.wordpress.org/Template_Tags/wp_list_authors 
    429456 * @since 1.2 
    430457 * @param array $args The argument array.