Changeset 7990 for trunk/wp-includes/author-template.php
- Timestamp:
- 05/25/2008 03:45:05 PM (17 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/wp-includes/author-template.php
r7104 r7990 2 2 /** 3 3 * 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 4 8 * 5 9 * @package WordPress … … 8 12 9 13 /** 10 * get_the_author() - Get the author of the current post in the Loop.14 * Retrieve the author of the current post. 11 15 * 12 16 * @since 1.5 … … 23 27 24 28 /** 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 also30 * 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. 34 38 * 35 39 * @since 0.71 36 40 * @see get_the_author() 41 * @link http://codex.wordpress.org/Template_Tags/the_author 37 42 * 38 43 * @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. 40 45 * @return string The author's display name, from get_the_author(). 41 46 */ … … 47 52 48 53 /** 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. 50 55 * 51 56 * @since 1.5 … … 59 64 60 65 /** 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 63 69 * @since 1.0.0 64 70 * @see get_the_author_description() … … 69 75 70 76 /** 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. 72 78 * 73 79 * @since 1.5 … … 81 87 82 88 /** 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 85 92 * @since 0.71 86 93 * @see get_the_author_login() … … 91 98 92 99 /** 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. 94 101 * 95 102 * @since 1.5 … … 103 110 104 111 /** 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 107 115 * @since 0.71 108 116 * @uses get_the_author_firstname() … … 113 121 114 122 /** 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. 116 124 * 117 125 * @since 1.5 … … 125 133 126 134 /** 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 129 138 * @since 0.71 130 139 * @uses get_the_author_lastname() … … 135 144 136 145 /** 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. 138 147 * 139 148 * @since 1.5 … … 147 156 148 157 /** 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 151 161 * @since 0.71 152 162 * @uses get_the_author_nickname() … … 157 167 158 168 /** 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. 160 170 * 161 171 * @since 1.5 … … 169 179 170 180 /** 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 173 184 * @since 0.71 174 185 * @uses get_the_author_ID() … … 179 190 180 191 /** 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. 182 193 * 183 194 * @since 1.5 … … 191 202 192 203 /** 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 195 207 * @since 0.71 196 208 * @uses get_the_author_email() … … 201 213 202 214 /** 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. 204 216 * 205 217 * @since 1.5 … … 217 229 218 230 /** 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 221 234 * @since 0.71 222 235 * @uses get_the_author_url() … … 227 240 228 241 /** 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 231 248 * @since 2.1 232 249 * @uses get_the_author_url() … … 242 259 243 260 /** 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. 245 262 * 246 263 * @since 1.5 … … 254 271 255 272 /** 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 258 276 * @since 0.71 259 277 * @see get_the_author_icq() … … 264 282 265 283 /** 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. 267 285 * 268 286 * @since 1.5 … … 276 294 277 295 /** 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 280 299 * @since 0.71 281 300 * @see get_the_author_aim() … … 286 305 287 306 /** 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. 289 308 * 290 309 * @since 1.5 … … 298 317 299 318 /** 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 302 322 * @since 0.71 303 323 * @see get_the_author_yim() … … 308 328 309 329 /** 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. 311 331 * 312 332 * @since 1.5 … … 320 340 321 341 /** 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 324 345 * @since 0.71 325 346 * @see get_the_author_msn() … … 330 351 331 352 /** 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. 333 354 * 334 355 * @since 1.5 … … 343 364 344 365 /** 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 347 369 * @since 0.71 348 370 * @uses get_the_author_posts() Echos returned value from function. … … 353 375 354 376 /** 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 360 384 * @since 1.2 361 385 * @uses $authordata The current author's DB object. … … 375 399 376 400 /** 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. 378 402 * 379 403 * @since 2.1 … … 405 429 406 430 /** 407 * get_author_name() - Getthe specified author's preferred display name.431 * Retrieve the specified author's preferred display name. 408 432 * 409 433 * @since 1.0.0 … … 417 441 418 442 /** 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. 423 449 * show_fullname (boolean) (false): Show their full names. 424 450 * hide_empty (boolean) (true): Don't show authors without any posts. … … 427 453 * echo (boolean) (true): Set to false to return the output, instead of echoing. 428 454 * 455 * @link http://codex.wordpress.org/Template_Tags/wp_list_authors 429 456 * @since 1.2 430 457 * @param array $args The argument array.
Note: See TracChangeset
for help on using the changeset viewer.