WordPress.org

Make WordPress Core

Changeset 8742


Ignore:
Timestamp:
08/27/2008 06:45:13 AM (10 years ago)
Author:
westi
Message:

phpDoc corrections for wp-includes. See #7550 props santosj.

Location:
trunk/wp-includes
Files:
8 edited

Legend:

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

    r8149 r8742  
    382382 *
    383383 * @link http://codex.wordpress.org/Template_Tags/the_author_posts_link
    384  * @since 1.2
     384 * @since 1.2.0
    385385 * @uses $authordata The current author's DB object.
    386386 * @uses get_author_posts_url()
     
    401401 * Retrieve the URL to the author page of the author of the current post.
    402402 *
    403  * @since 2.1
     403 * @since 2.1.0
    404404 * @uses $wp_rewrite WP_Rewrite
    405405 * @return string The URL to the author's page.
     
    454454 *
    455455 * @link http://codex.wordpress.org/Template_Tags/wp_list_authors
    456  * @since 1.2
     456 * @since 1.2.0
    457457 * @param array $args The argument array.
    458458 * @return null|string The output, if echo is set to false.
  • trunk/wp-includes/bookmark-template.php

    r8463 r8742  
    88
    99/**
    10  * The formatted output of a list of bookmarks
     10 * The formatted output of a list of bookmarks.
    1111 *
    1212 * The $bookmarks array must contain bookmark objects and will be iterated over
     
    3535 * 'show_rating' - Default is 0 (integer). Whether to show the link rating.
    3636 *
    37  * @since 2.1
     37 * @since 2.1.0
    3838 * @access private
    3939 * @usedby wp_list_bookmarks()
     
    121121
    122122/**
    123  * Retrieve or echo all of the bookmarks
     123 * Retrieve or echo all of the bookmarks.
    124124 *
    125125 * List of default arguments are as follows:
     
    175175 * @link http://codex.wordpress.org/Template_Tags/wp_list_bookmarks
    176176 *
    177  * @since 2.1
     177 * @since 2.1.0
    178178 * @uses _list_bookmarks() Used to iterate over all of the bookmarks and return
    179179 *      the html
  • trunk/wp-includes/bookmark.php

    r7990 r8742  
    1010 * Retrieve Bookmark data based on ID
    1111 *
    12  * @since 2.1
     12 * @since 2.1.0
    1313 * @uses $wpdb Database Object
    1414 *
     
    4040 * Retrieve single bookmark data item or field.
    4141 *
    42  * @since 2.3
     42 * @since 2.3.0
    4343 * @uses get_bookmark() Gets bookmark object using $bookmark as ID
    4444 * @uses sanitize_bookmark_field() Sanitizes Bookmark field based on $context.
     
    6868 * Retrieve bookmark data based on ID.
    6969 *
    70  * @since 2.0
     70 * @since 2.0.0
    7171 * @deprecated Use get_bookmark()
    7272 * @see get_bookmark()
     
    107107 *      separated by commas.
    108108 *
    109  * @since 2.1
     109 * @since 2.1.0
    110110 * @uses $wpdb Database Object
    111111 * @link http://codex.wordpress.org/Template_Tags/get_bookmarks
     
    239239 * Sanitizes all bookmark fields
    240240 *
    241  * @since 2.3
     241 * @since 2.3.0
    242242 *
    243243 * @param object|array $bookmark Bookmark row
     
    280280 * $context respectively.
    281281 *
    282  * @since 2.3
     282 * @since 2.3.0
    283283 *
    284284 * @param string $field The bookmark field
     
    334334 * Deletes entire bookmark cache
    335335 *
    336  * @since 2.1
     336 * @since 2.1.0
    337337 * @uses wp_cache_delete() Deletes the contents of 'get_bookmarks'
    338338 */
  • trunk/wp-includes/cache.php

    r8600 r8742  
    1212 * Adds data to the cache, if the cache key doesn't aleady exist.
    1313 *
    14  * @since 2.0
     14 * @since 2.0.0
    1515 * @uses $wp_object_cache Object Cache Class
    1616 * @see WP_Object_Cache::add()
     
    3636 * make sure that the cache is cleaned up after WordPress no longer needs it.
    3737 *
    38  * @since 2.0
     38 * @since 2.0.0
    3939 *
    4040 * @return bool Always returns True
     
    4747 * Removes the cache contents matching ID and flag.
    4848 *
    49  * @since 2.0
     49 * @since 2.0.0
    5050 * @uses $wp_object_cache Object Cache Class
    5151 * @see WP_Object_Cache::delete()
     
    6464 * Removes all cache items.
    6565 *
    66  * @since 2.0
     66 * @since 2.0.0
    6767 * @uses $wp_object_cache Object Cache Class
    6868 * @see WP_Object_Cache::flush()
     
    7979 * Retrieves the cache contents from the cache by ID and flag.
    8080 *
    81  * @since 2.0
     81 * @since 2.0.0
    8282 * @uses $wp_object_cache Object Cache Class
    8383 * @see WP_Object_Cache::get()
     
    9797 * Sets up Object Cache Global and assigns it.
    9898 *
    99  * @since 2.0
     99 * @since 2.0.0
    100100 * @global WP_Object_Cache $wp_object_cache WordPress Object Cache
    101101 */
     
    107107 * Replaces the contents of the cache with new data.
    108108 *
    109  * @since 2.0
     109 * @since 2.0.0
    110110 * @uses $wp_object_cache Object Cache Class
    111111 * @see WP_Object_Cache::replace()
     
    145145 * Adds a group or set of groups to the list of global groups.
    146146 *
    147  * @since 2.6
     147 * @since 2.6.0
    148148 *
    149149 * @param string|array $groups A group or an array of groups to add
     
    157157 * Adds a group or set of groups to the list of non-persistent groups.
    158158 *
    159  * @since 2.6
     159 * @since 2.6.0
    160160 *
    161161 * @param string|array $groups A group or an array of groups to add
     
    189189     * @var array
    190190     * @access private
    191      * @since 2.0
     191     * @since 2.0.0
    192192     */
    193193    var $cache = array ();
     
    198198     * @var array
    199199     * @access private
    200      * @since 2.0
     200     * @since 2.0.0
    201201     */
    202202    var $non_existant_objects = array ();
     
    205205     * The amount of times the cache data was already stored in the cache.
    206206     *
    207      * @since 2.5
     207     * @since 2.5.0
    208208     * @access private
    209209     * @var int
     
    216216     * @var int
    217217     * @access public
    218      * @since 2.0
     218     * @since 2.0.0
    219219     */
    220220    var $cache_misses = 0;
     
    227227     *      contents existance.
    228228     *
    229      * @since 2.0
     229     * @since 2.0.0
    230230     *
    231231     * @param int|string $id What to call the contents in the cache
     
    255255     * $non_existant_objects property in the class.
    256256     *
    257      * @since 2.0
     257     * @since 2.0.0
    258258     *
    259259     * @param int|string $id What the contents in the cache are called
     
    278278     * Clears the object cache of all data
    279279     *
    280      * @since 2.0
     280     * @since 2.0.0
    281281     *
    282282     * @return bool Always returns true
     
    301301     * the nonexistant objects.
    302302     *
    303      * @since 2.0
     303     * @since 2.0.0
    304304     *
    305305     * @param int|string $id What the contents in the cache are called
     
    328328     * Replace the contents in the cache, if contents already exist
    329329     *
    330      * @since 2.0
     330     * @since 2.0.0
    331331     * @see WP_Object_Cache::set()
    332332     *
     
    359359     * more for cache plugins which use files.
    360360     *
    361      * @since 2.0
     361     * @since 2.0.0
    362362     *
    363363     * @param int|string $id What to call the contents in the cache
     
    388388     * key and the data.
    389389     *
    390      * @since 2.0
     390     * @since 2.0.0
    391391     */
    392392    function stats() {
     
    409409     * PHP4 constructor; Calls PHP 5 style constructor
    410410     *
    411      * @since 2.0
     411     * @since 2.0.0
    412412     *
    413413     * @return WP_Object_Cache
  • trunk/wp-includes/canonical.php

    r8732 r8742  
    99 * @author Mark Jaquith
    1010 * @package WordPress
    11  * @since 2.3
     11 * @since 2.3.0
    1212 */
    1313
    1414/**
    15  * Redirects incoming links to the proper URL based on the site url
     15 * Redirects incoming links to the proper URL based on the site url.
    1616 *
    1717 * Search engines consider www.somedomain.com and somedomain.com to be two
     
    2727 * or query in an attempt to figure the correct page to go to.
    2828 *
    29  * @since 2.3
     29 * @since 2.3.0
    3030 * @uses $wp_rewrite
    3131 * @uses $is_IIS
     
    244244
    245245/**
    246  * Attempts to guess correct post based on query vars
    247  *
    248  * @since 2.3
     246 * Attempts to guess correct post based on query vars.
     247 *
     248 * @since 2.3.0
    249249 * @uses $wpdb
    250250 *
  • trunk/wp-includes/category.php

    r8575 r8742  
    6666 * The category will converted to maintain backwards compatibility.
    6767 *
    68  * @since 2.1.0
     68 * @since 1.5.1
    6969 * @uses get_term() Used to get the category data from the taxonomy.
    7070 *
  • trunk/wp-includes/deprecated.php

    r8543 r8742  
    11<?php
    22/**
    3  * Deprecated functions from past WordPress versions
     3 * Deprecated functions from past WordPress versions. You shouldn't use these
     4 * globals and functions and look for the alternatives instead. The functions
     5 * and globals will be removed in a later version.
     6 *
    47 * @package WordPress
    58 * @subpackage Deprecated
     
    7780
    7881/**
    79  * get_postdata() - Entire Post data
     82 * Entire Post data.
    8083 *
    8184 * @since 0.71
     
    113116
    114117/**
    115  * start_wp() - Sets up the WordPress Loop
     118 * Sets up the WordPress Loop.
    116119 *
    117120 * @since 1.0.1
     
    130133
    131134/**
    132  * the_category_ID() - Return or Print Category ID
     135 * Return or Print Category ID.
    133136 *
    134137 * @since 0.71
     
    153156
    154157/**
    155  * the_category_head() - Print category with optional text before and after
     158 * Print category with optional text before and after.
    156159 *
    157160 * @since 0.71
     
    179182
    180183/**
    181  * previous_post() - Prints link to the previous post
     184 * Prints link to the previous post.
    182185 *
    183186 * @since 1.5
     
    215218
    216219/**
    217  * next_post() - Prints link to the next post
     220 * Prints link to the next post.
    218221 *
    219222 * @since 0.71
     
    250253
    251254/**
    252  * user_can_create_post() - Whether user can create a post
     255 * Whether user can create a post.
    253256 *
    254257 * @since 1.5
     
    269272
    270273/**
    271  * user_can_create_draft() - Whether user can create a post
     274 * Whether user can create a post.
    272275 *
    273276 * @since 1.5
     
    288291
    289292/**
    290  * user_can_edit_post() - Whether user can edit a post
     293 * Whether user can edit a post.
    291294 *
    292295 * @since 1.5
     
    316319
    317320/**
    318  * user_can_delete_post() - Whether user can delete a post
     321 * Whether user can delete a post.
    319322 *
    320323 * @since 1.5
     
    335338
    336339/**
    337  * user_can_set_post_date() - Whether user can set new posts' dates
     340 * Whether user can set new posts' dates.
    338341 *
    339342 * @since 1.5
     
    353356}
    354357
    355 /* returns true if $user_id can edit $post_id's date */
    356 /**
    357  * user_can_edit_post_date() - Whether user can delete a post
     358/**
     359 * Whether user can delete a post.
    358360 *
    359361 * @since 1.5
     
    364366 * @param int $post_id
    365367 * @param int $blog_id Not Used
    366  * @return bool
     368 * @return bool returns true if $user_id can edit $post_id's date
    367369 */
    368370function user_can_edit_post_date($user_id, $post_id, $blog_id = 1) {
     
    373375}
    374376
    375 /* returns true if $user_id can edit $post_id's comments */
    376 /**
    377  * user_can_edit_post_comments() - Whether user can delete a post
     377/**
     378 * Whether user can delete a post.
    378379 *
    379380 * @since 1.5
     
    384385 * @param int $post_id
    385386 * @param int $blog_id Not Used
    386  * @return bool
     387 * @return bool returns true if $user_id can edit $post_id's comments
    387388 */
    388389function user_can_edit_post_comments($user_id, $post_id, $blog_id = 1) {
     
    393394}
    394395
    395 /* returns true if $user_id can delete $post_id's comments */
    396 /**
    397  * user_can_delete_post_comments() - Whether user can delete a post
     396/**
     397 * Whether user can delete a post.
    398398 *
    399399 * @since 1.5
     
    404404 * @param int $post_id
    405405 * @param int $blog_id Not Used
    406  * @return bool
     406 * @return bool returns true if $user_id can delete $post_id's comments
    407407 */
    408408function user_can_delete_post_comments($user_id, $post_id, $blog_id = 1) {
     
    414414
    415415/**
    416  * user_can_edit_user() - Can user can edit other user
     416 * Can user can edit other user.
    417417 *
    418418 * @since 1.5
     
    436436
    437437/**
    438  * get_linksbyname() - Gets the links associated with category $cat_name.
     438 * Gets the links associated with category $cat_name.
    439439 *
    440440 * @since 0.71
     
    442442 * @see get_links()
    443443 *
    444  * @param string    $cat_name   Optional. The category name to use. If no match is found uses all.
    445  * @param string    $before     Optional. The html to output before the link.
    446  * @param string    $after      Optional. The html to output after the link.
    447  * @param string    $between    Optional. The html to output between the link/image and it's description. Not used if no image or $show_images is true.
    448  * @param bool      $show_images Optional. Whether to show images (if defined).
    449  * @param string    $orderby    Optional. The order to output the links. E.g. 'id', 'name', 'url', 'description' or 'rating'. Or maybe owner.
     444 * @param string $cat_name Optional. The category name to use. If no match is found uses all.
     445 * @param string $before Optional. The html to output before the link.
     446 * @param string $after Optional. The html to output after the link.
     447 * @param string $between Optional. The html to output between the link/image and it's description. Not used if no image or $show_images is true.
     448 * @param bool $show_images Optional. Whether to show images (if defined).
     449 * @param string $orderby Optional. The order to output the links. E.g. 'id', 'name', 'url', 'description' or 'rating'. Or maybe owner.
    450450 *      If you start the name with an underscore the order will be reversed. You can also specify 'rand' as the order which will return links in a
    451451 *      random order.
    452  * @param bool      $show_description Optional. Whether to show the description if show_images=false/not defined.
    453  * @param bool      $show_rating Optional. Show rating stars/chars.
    454  * @param int       $limit      Optional. Limit to X entries. If not specified, all entries are shown.
    455  * @param int       $show_updated Optional. Whether to show last updated timestamp
     452 * @param bool $show_description Optional. Whether to show the description if show_images=false/not defined.
     453 * @param bool $show_rating Optional. Show rating stars/chars.
     454 * @param int $limit        Optional. Limit to X entries. If not specified, all entries are shown.
     455 * @param int $show_updated Optional. Whether to show last updated timestamp
    456456 */
    457457function get_linksbyname($cat_name = "noname", $before = '', $after = '<br />', $between = " ", $show_images = true, $orderby = 'id',
     
    469469
    470470/**
    471  * wp_get_linksbyname() - Gets the links associated with the named category.
     471 * Gets the links associated with the named category.
    472472 *
    473473 * @since 1.0.1
     
    492492
    493493/**
    494  * get_linkobjectsbyname() - Gets an array of link objects associated with category $cat_name.
     494 * Gets an array of link objects associated with category $cat_name.
    495495 *
    496496 * <code>
     
    524524
    525525/**
    526  * get_linkobjects() - Gets an array of link objects associated with category n.
     526 * Gets an array of link objects associated with category n.
    527527 *
    528528 * Usage:
     
    578578
    579579/**
    580  * get_linksbyname_withrating() - Gets the links associated with category 'cat_name' and display rating stars/chars.
     580 * Gets the links associated with category 'cat_name' and display rating stars/chars.
    581581 *
    582582 * @since 0.71
     
    605605
    606606/**
    607  * get_links_withrating() - Gets the links associated with category n and display rating stars/chars.
     607 * Gets the links associated with category n and display rating stars/chars.
    608608 *
    609609 * @since 0.71
     
    632632
    633633/**
    634  * get_autotoggle() - Gets the auto_toggle setting
     634 * Gets the auto_toggle setting.
    635635 *
    636636 * @since 0.71
     
    794794
    795795/**
    796  * wp_set_post_cats() - Sets the categories that the post id belongs to.
     796 * Sets the categories that the post id belongs to.
    797797 *
    798798 * @since 1.0.1
     
    830830
    831831/**
    832  * get_author_link() - Returns or Prints link to the author's posts
     832 * Returns or Prints link to the author's posts.
    833833 *
    834834 * @since 1.2
     
    852852
    853853/**
    854  * link_pages() - Print list of pages based on arguments
     854 * Print list of pages based on arguments.
    855855 *
    856856 * @since 0.71
     
    876876
    877877/**
    878  * get_settings() - Get value based on option
     878 * Get value based on option.
    879879 *
    880880 * @since 0.71
     
    892892
    893893/**
    894  * permalink_link() - Print the permalink of the current post in the loop
     894 * Print the permalink of the current post in the loop.
    895895 *
    896896 * @since 0.71
     
    904904
    905905/**
    906  * permalink_single_rss() - Print the permalink to the RSS feed
     906 * Print the permalink to the RSS feed.
    907907 *
    908908 * @since 0.71
     
    918918
    919919/**
    920  * wp_get_links() - Gets the links associated with category.
     920 * Gets the links associated with category.
    921921 *
    922922 * @see get_links() for argument information that can be used in $args
     
    952952
    953953/**
    954  * get_links() - Gets the links associated with category by id.
     954 * Gets the links associated with category by id.
    955955 *
    956956 * @since 0.71
     
    10571057
    10581058/**
    1059  * get_links_list() - Output entire list of links by category
    1060  *
    1061  * Output a list of all links, listed by category, using the
    1062  * settings in $wpdb->linkcategories and output it as a nested
    1063  * HTML unordered list.
     1059 * Output entire list of links by category.
     1060 *
     1061 * Output a list of all links, listed by category, using the settings in
     1062 * $wpdb->linkcategories and output it as a nested HTML unordered list.
    10641063 *
    10651064 * @author Dougal
     
    11051104
    11061105/**
    1107  * links_popup_script() - Show the link to the links popup and the number of links
     1106 * Show the link to the links popup and the number of links.
    11081107 *
    11091108 * @author Fullo
     
    11491148
    11501149/**
    1151  * get_linkcatname() - Gets the name of category by id.
     1150 * Gets the name of category by id.
    11521151 *
    11531152 * @since 0.71
     
    11781177
    11791178/**
    1180  * comment_rss_link() - Print RSS comment feed link
     1179 * Print RSS comment feed link.
    11811180 *
    11821181 * @since 1.0.1
     
    11931192
    11941193/**
    1195  * get_category_rss_link() - Print/Return link to category RSS2 feed
     1194 * Print/Return link to category RSS2 feed.
    11961195 *
    11971196 * @since 1.2
     
    12151214
    12161215/**
    1217  * get_author_rss_link() - Print/Return link to author RSS feed
     1216 * Print/Return link to author RSS feed.
    12181217 *
    12191218 * @since 1.2
     
    12361235
    12371236/**
    1238  * comments_rss() - Return link to the post RSS feed
     1237 * Return link to the post RSS feed.
    12391238 *
    12401239 * @since 1.5
     
    12511250
    12521251/**
    1253  * create_user() - An alias of wp_create_user().
     1252 * An alias of wp_create_user().
     1253 *
    12541254 * @param string $username The user's username.
    12551255 * @param string $password The user's password.
     
    12651265
    12661266/**
    1267  * documentation_link() - Unused Admin function
     1267 * Unused Admin function.
     1268 *
    12681269 * @since 2.0
    12691270 * @param string $deprecated Unknown
     
    12761277
    12771278/**
    1278  * gzip_compression() - Unused function
     1279 * Unused function.
    12791280 *
    12801281 * @deprecated 2.5
    12811282*/
    1282 
    12831283function gzip_compression() {
    12841284    return false;
  • trunk/wp-includes/update.php

    r8739 r8742  
    1515 *
    1616 * @package WordPress
    17  * @since 2.3
     17 * @since 2.3.0
    1818 * @uses $wp_version Used to check against the newest WordPress version.
    1919 *
     
    8989 *
    9090 * @package WordPress
    91  * @since 2.3
     91 * @since 2.3.0
    9292 * @uses $wp_version Used to notidy the WordPress version.
    9393 *
Note: See TracChangeset for help on using the changeset viewer.