Make WordPress Core

Ticket #7550: 7550.corrections.patch

File 7550.corrections.patch, 66.9 KB (added by jacobsantos, 16 years ago)

Corrections to since and short descriptions, among other based off of r8687

  • author-template.php

     
    381381 * link to the author's posts.
    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()
    387387 * @uses get_the_author()
     
    400400/**
    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.
    406406 */
     
    453453 * echo (boolean) (true): Set to false to return the output, instead of echoing.
    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.
    459459 */
  • bookmark-template.php

     
    77 */
    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
    1313 * to retrieve the bookmark to be used in the output.
     
    3434 *              description, and image.
    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()
    4040 *
     
    120120}
    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:
    126126 * 'orderby' - Default is 'name' (string). How to order the links by. String is
     
    174174 *              passed to get_bookmarks().
    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
    180180 * @uses get_terms() Gets all of the categories that are for links.
  • bookmark.php

     
    99/**
    1010 * Retrieve Bookmark data based on ID
    1111 *
    12  * @since 2.1
     12 * @since 2.1.0
    1313 * @uses $wpdb Database Object
    1414 *
    1515 * @param int $bookmark_id
     
    3939/**
    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.
    4545 *
     
    6767/**
    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()
    7373 *
     
    106106 * 'exclude' - Default is empty string (string). Exclude other categories
    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
    112112 *
     
    238238/**
    239239 * Sanitizes all bookmark fields
    240240 *
    241  * @since 2.3
     241 * @since 2.3.0
    242242 *
    243243 * @param object|array $bookmark Bookmark row
    244244 * @param string $context Optional, default is 'display'. How to filter the
     
    279279 * $field has the filter name and is passed the $value, $bookmark_id, and
    280280 * $context respectively.
    281281 *
    282  * @since 2.3
     282 * @since 2.3.0
    283283 *
    284284 * @param string $field The bookmark field
    285285 * @param mixed $value The bookmark field value
     
    333333/**
    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 */
    339339function delete_get_bookmark_cache() {
  • cache.php

     
    1111/**
    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()
    1717 *
     
    3535 * does not mean that plugins can't implement this function when they need to
    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
    4141 */
     
    4646/**
    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()
    5252 *
     
    6363/**
    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()
    6969 *
     
    7878/**
    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()
    8484 *
     
    9696/**
    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 */
    102102function wp_cache_init() {
     
    106106/**
    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()
    112112 *
     
    144144/**
    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
    150150 */
     
    156156/**
    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
    162162 */
     
    188188         *
    189189         * @var array
    190190         * @access private
    191          * @since 2.0
     191         * @since 2.0.0
    192192         */
    193193        var $cache = array ();
    194194
     
    197197         *
    198198         * @var array
    199199         * @access private
    200          * @since 2.0
     200         * @since 2.0.0
    201201         */
    202202        var $non_existant_objects = array ();
    203203
    204204        /**
    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
    210210         */
     
    215215         *
    216216         * @var int
    217217         * @access public
    218          * @since 2.0
     218         * @since 2.0.0
    219219         */
    220220        var $cache_misses = 0;
    221221
     
    226226         * @uses WP_Object_Cache::set Sets the data after the checking the cache
    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
    232232         * @param mixed $data The contents to store in the cache
     
    254254         * On success the group and the id will be added to the
    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
    260260         * @param string $group Where the cache contents are grouped
     
    277277        /**
    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
    283283         */
     
    300300         * misses will be incremented and the cache group and ID will be added to
    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
    306306         * @param string $group Where the cache contents are grouped
     
    327327        /**
    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         *
    333333         * @param int|string $id What to call the contents in the cache
     
    358358         * expire for each time a page is accessed and PHP finishes. The method is
    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
    364364         * @param mixed $data The contents to store in the cache
     
    387387         * Gives the cache hits, and cache misses. Also prints every cached group,
    388388         * key and the data.
    389389         *
    390          * @since 2.0
     390         * @since 2.0.0
    391391         */
    392392        function stats() {
    393393                echo "<p>";
     
    408408        /**
    409409         * PHP4 constructor; Calls PHP 5 style constructor
    410410         *
    411          * @since 2.0
     411         * @since 2.0.0
    412412         *
    413413         * @return WP_Object_Cache
    414414         */
  • canonical.php

     
    88 * @author Scott Yang
    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
    1818 * different URLs when they both go to the same location. This SEO enhancement
     
    2626 * not exist based on exact WordPress query. Will instead try to parse the URL
    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
    3232 *
     
    241241}
    242242
    243243/**
    244  * Attempts to guess correct post based on query vars
     244 * Attempts to guess correct post based on query vars.
    245245 *
    246  * @since 2.3
     246 * @since 2.3.0
    247247 * @uses $wpdb
    248248 *
    249249 * @return bool|string Returns False, if it can't find post, returns correct
  • category.php

     
    6565 *
    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 *
    7171 * @param int|object $category Category ID or Category row object
  • deprecated.php

     
    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
    69 */
     
    7679 */
    7780
    7881/**
    79  * get_postdata() - Entire Post data
     82 * Entire Post data.
    8083 *
    8184 * @since 0.71
    8285 * @deprecated Use get_post()
     
    112115}
    113116
    114117/**
    115  * start_wp() - Sets up the WordPress Loop
     118 * Sets up the WordPress Loop.
    116119 *
    117120 * @since 1.0.1
    118121 * @deprecated Since 1.5 - {@link http://codex.wordpress.org/The_Loop Use new WordPress Loop}
     
    129132}
    130133
    131134/**
    132  * the_category_ID() - Return or Print Category ID
     135 * Return or Print Category ID.
    133136 *
    134137 * @since 0.71
    135138 * @deprecated use get_the_category()
     
    152155}
    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
    158161 * @deprecated use get_the_category_by_ID()
     
    178181}
    179182
    180183/**
    181  * previous_post() - Prints link to the previous post
     184 * Prints link to the previous post.
    182185 *
    183186 * @since 1.5
    184187 * @deprecated Use previous_post_link()
     
    214217}
    215218
    216219/**
    217  * next_post() - Prints link to the next post
     220 * Prints link to the next post.
    218221 *
    219222 * @since 0.71
    220223 * @deprecated Use next_post_link()
     
    249252}
    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
    255258 * @deprecated Use current_user_can()
     
    268271}
    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
    274277 * @deprecated Use current_user_can()
     
    287290}
    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
    293296 * @deprecated Use current_user_can()
     
    315318}
    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
    321324 * @deprecated Use current_user_can()
     
    334337}
    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
    340343 * @deprecated Use current_user_can()
     
    352355        return (($author_data->user_level > 4) && user_can_create_post($user_id, $blog_id, $category_id));
    353356}
    354357
    355 /* returns true if $user_id can edit $post_id's date */
    356358/**
    357  * user_can_edit_post_date() - Whether user can delete a post
     359 * Whether user can delete a post.
    358360 *
    359361 * @since 1.5
    360362 * @deprecated Use current_user_can()
     
    363365 * @param int $user_id
    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) {
    369371        _deprecated_function(__FUNCTION__, '0.0', 'current_user_can()');
     
    372374        return (($author_data->user_level > 4) && user_can_edit_post($user_id, $post_id, $blog_id));
    373375}
    374376
    375 /* returns true if $user_id can edit $post_id's comments */
    376377/**
    377  * user_can_edit_post_comments() - Whether user can delete a post
     378 * Whether user can delete a post.
    378379 *
    379380 * @since 1.5
    380381 * @deprecated Use current_user_can()
     
    383384 * @param int $user_id
    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) {
    389390        _deprecated_function(__FUNCTION__, '0.0', 'current_user_can()');
     
    392393        return user_can_edit_post($user_id, $post_id, $blog_id);
    393394}
    394395
    395 /* returns true if $user_id can delete $post_id's comments */
    396396/**
    397  * user_can_delete_post_comments() - Whether user can delete a post
     397 * Whether user can delete a post.
    398398 *
    399399 * @since 1.5
    400400 * @deprecated Use current_user_can()
     
    403403 * @param int $user_id
    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) {
    409409        _deprecated_function(__FUNCTION__, '0.0', 'current_user_can()');
     
    413413}
    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
    419419 * @deprecated Use current_user_can()
     
    435435}
    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
    441441 * @deprecated Use get_links()
    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',
    458458                                                 $show_description = true, $show_rating = false,
     
    468468}
    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
    474474 * @deprecated Use wp_get_links()
     
    491491}
    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>
    497497 *      $links = get_linkobjectsbyname('fred');
     
    523523}
    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:
    529529 * <code>
     
    577577}
    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
    583583 * @deprecated Use get_bookmarks()
     
    604604}
    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
    610610 * @deprecated Use get_bookmarks()
     
    631631}
    632632
    633633/**
    634  * get_autotoggle() - Gets the auto_toggle setting
     634 * Gets the auto_toggle setting.
    635635 *
    636636 * @since 0.71
    637637 * @deprecated No alternative function available
     
    793793}
    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
    799799 * @deprecated Use wp_set_post_categories()
     
    829829}
    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
    835835 * @deprecated Use get_author_posts_url()
     
    851851}
    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
    857857 * @deprecated Use wp_link_pages()
     
    875875}
    876876
    877877/**
    878  * get_settings() - Get value based on option
     878 * Get value based on option.
    879879 *
    880880 * @since 0.71
    881881 * @deprecated Use get_option()
     
    891891}
    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
    897897 * @deprecated Use the_permalink()
     
    903903}
    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
    909909 * @deprecated Use the_permalink_rss()
     
    917917}
    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
    923923 * @since 1.0.1
     
    951951}
    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
    957957 * @deprecated Use get_bookmarks()
     
    10561056}
    10571057
    10581058/**
    1059  * get_links_list() - Output entire list of links by category
     1059 * Output entire list of links by category.
    10601060 *
    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.
     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
    10661065 * @since 1.0.1
     
    11041103}
    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
    11101109 * @link http://sprite.csr.unibo.it/fullo/
     
    11481147}
    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
    11541153 * @deprecated Use get_category()
     
    11771176}
    11781177
    11791178/**
    1180  * comment_rss_link() - Print RSS comment feed link
     1179 * Print RSS comment feed link.
    11811180 *
    11821181 * @since 1.0.1
    11831182 * @deprecated Use post_comments_feed_link()
     
    11921191}
    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
    11981197 * @deprecated Use get_category_feed_link()
     
    12141213}
    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
    12201219 * @deprecated Use get_author_feed_link()
     
    12351234}
    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
    12411240 * @deprecated Use get_post_comments_feed_link()
     
    12501249}
    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.
    12561256 * @param string $email The user's email (optional).
     
    12641264}
    12651265
    12661266/**
    1267  * documentation_link() - Unused Admin function
     1267 * Unused Admin function.
     1268 *
    12681269 * @since 2.0
    12691270 * @param string $deprecated Unknown
    12701271 * @deprecated 2.5
     
    12751276}
    12761277
    12771278/**
    1278  * gzip_compression() - Unused function
     1279 * Unused function.
    12791280 *
    12801281 * @deprecated 2.5
    12811282*/
    1282 
    12831283function gzip_compression() {
    12841284        return false;
    12851285}
     
    13041304        return get_comment($comment_ID, ARRAY_A);
    13051305}
    13061306
    1307 ?>
    1308  No newline at end of file
     1307?>
  • kses.php

     
    2424 */
    2525
    2626/**
    27  * You can override this in your my-hacks.php file
    28  * You can also override this in a plugin file. The
    29  * my-hacks.php is deprecated in its usage.
     27 * You can override this in your my-hacks.php file You can also override this
     28 * in a plugin file. The my-hacks.php is deprecated in its usage.
    3029 *
    3130 * @since 1.2.0
    3231 */
     
    3534
    3635if (!CUSTOM_TAGS) {
    3736        /**
    38          * Kses global for default allowable HTML tags
     37         * Kses global for default allowable HTML tags.
    3938         *
    40          * Can be override by using CUSTOM_TAGS constant
     39         * Can be override by using CUSTOM_TAGS constant.
     40         *
    4141         * @global array $allowedposttags
    4242         * @since 2.0.0
    4343         */
     
    281281                        'style' => array (),
    282282                        'type' => array ()),
    283283                'var' => array ());
     284
    284285        /**
    285          * Kses allowed HTML elements
     286         * Kses allowed HTML elements.
    286287         *
    287288         * @global array $allowedtags
    288289         * @since 1.0.0
     
    323324}
    324325
    325326/**
    326  * wp_kses() - Filters content and keeps only allowable HTML elements.
     327 * Filters content and keeps only allowable HTML elements.
    327328 *
    328  * This function makes sure that only the allowed HTML element names,
    329  * attribute names and attribute values plus only sane HTML entities
    330  * will occur in $string. You have to remove any slashes from PHP's
    331  * magic quotes before you call this function.
     329 * This function makes sure that only the allowed HTML element names, attribute
     330 * names and attribute values plus only sane HTML entities will occur in
     331 * $string. You have to remove any slashes from PHP's magic quotes before you
     332 * call this function.
    332333 *
    333  * The default allowed protocols are 'http', 'https', 'ftp', 'mailto',
    334  * 'news', 'irc', 'gopher', 'nntp', 'feed', and finally 'telnet. This
    335  * covers all common link protocols, except for 'javascript' which
    336  * should not be allowed for untrusted users.
     334 * The default allowed protocols are 'http', 'https', 'ftp', 'mailto', 'news',
     335 * 'irc', 'gopher', 'nntp', 'feed', and finally 'telnet. This covers all common
     336 * link protocols, except for 'javascript' which should not be allowed for
     337 * untrusted users.
    337338 *
    338339 * @since 1.0.0
    339340 *
     
    352353}
    353354
    354355/**
    355  * wp_kses_hook() - You add any kses hooks here.
     356 * You add any kses hooks here.
    356357 *
    357  * There is currently only one kses WordPress hook and it is
    358  * called here. All parameters are passed to the hooks and
    359  * expected to recieve a string.
     358 * There is currently only one kses WordPress hook and it is called here. All
     359 * parameters are passed to the hooks and expected to recieve a string.
    360360 *
    361361 * @since 1.0.0
    362362 *
     
    371371}
    372372
    373373/**
    374  * wp_kses_version() - This function returns kses' version number.
     374 * This function returns kses' version number.
    375375 *
    376376 * @since 1.0.0
    377377 *
    378  * @return string Version Number
     378 * @return string KSES Version Number
    379379 */
    380380function wp_kses_version() {
    381381        return '0.2.2';
    382382}
    383383
    384384/**
    385  * wp_kses_split() - Searches for HTML tags, no matter how malformed
     385 * Searches for HTML tags, no matter how malformed.
    386386 *
    387387 * It also matches stray ">" characters.
    388388 *
     
    399399}
    400400
    401401/**
    402  * wp_kses_split2() - Callback for wp_kses_split for fixing malformed HTML tags
     402 * Callback for wp_kses_split for fixing malformed HTML tags.
    403403 *
    404  * This function does a lot of work. It rejects some very malformed things
    405  * like <:::>. It returns an empty string, if the element isn't allowed (look
    406  * ma, no strip_tags()!). Otherwise it splits the tag into an element and an
    407  * attribute list.
     404 * This function does a lot of work. It rejects some very malformed things like
     405 * <:::>. It returns an empty string, if the element isn't allowed (look ma, no
     406 * strip_tags()!). Otherwise it splits the tag into an element and an attribute
     407 * list.
    408408 *
    409409 * After the tag is split into an element and an attribute list, it is run
    410  * through another filter which will remove illegal attributes and once
    411  * that is completed, will be returned.
     410 * through another filter which will remove illegal attributes and once that is
     411 * completed, will be returned.
    412412 *
    413413 * @access private
    414414 * @since 1.0.0
     
    460460}
    461461
    462462/**
    463  * wp_kses_attr() - Removes all attributes, if none are allowed for this element
     463 * Removes all attributes, if none are allowed for this element.
    464464 *
    465465 * If some are allowed it calls wp_kses_hair() to split them further, and then
    466466 * it builds up new HTML code from the data that kses_hair() returns. It also
    467  * removes "<" and ">" characters, if there are any left. One more thing it
    468  * does is to check if the tag has a closing XHTML slash, and if it does, it
    469  * puts one in the returned code as well.
     467 * removes "<" and ">" characters, if there are any left. One more thing it does
     468 * is to check if the tag has a closing XHTML slash, and if it does, it puts one
     469 * in the returned code as well.
    470470 *
    471471 * @since 1.0.0
    472472 *
     
    531531}
    532532
    533533/**
    534  * wp_kses_hair() - Builds an attribute list from string containing attributes.
     534 * Builds an attribute list from string containing attributes.
    535535 *
    536536 * This function does a lot of work. It parses an attribute list into an array
    537537 * with attribute data, and tries to do the right thing even if it gets weird
     
    660660}
    661661
    662662/**
    663  * wp_kses_check_attr_val() - Performs different checks for attribute values.
     663 * Performs different checks for attribute values.
    664664 *
    665665 * The currently implemented checks are "maxlen", "minlen", "maxval", "minval"
    666666 * and "valueless" with even more checks to come soon.
     
    732732}
    733733
    734734/**
    735  * wp_kses_bad_protocol() - Sanitize string from bad protocols
     735 * Sanitize string from bad protocols.
    736736 *
    737  * This function removes all non-allowed protocols from the beginning
    738  * of $string. It ignores whitespace and the case of the letters, and
    739  * it does understand HTML entities. It does its work in a while loop,
    740  * so it won't be fooled by a string like "javascript:javascript:alert(57)".
     737 * This function removes all non-allowed protocols from the beginning of
     738 * $string. It ignores whitespace and the case of the letters, and it does
     739 * understand HTML entities. It does its work in a while loop, so it won't be
     740 * fooled by a string like "javascript:javascript:alert(57)".
    741741 *
    742742 * @since 1.0.0
    743743 *
     
    759759}
    760760
    761761/**
    762  * wp_kses_no_null() - Removes any NULL characters in $string.
     762 * Removes any NULL characters in $string.
    763763 *
    764764 * @since 1.0.0
    765765 *
     
    774774}
    775775
    776776/**
    777  * wp_kses_stripslashes() - Strips slashes from in front of quotes
     777 * Strips slashes from in front of quotes.
    778778 *
    779  * This function changes the character sequence  \"  to just  "
    780  * It leaves all other slashes alone. It's really weird, but the
    781  * quoting from preg_replace(//e) seems to require this.
     779 * This function changes the character sequence  \"  to just  ". It leaves all
     780 * other slashes alone. It's really weird, but the quoting from
     781 * preg_replace(//e) seems to require this.
    782782 *
    783783 * @since 1.0.0
    784784 *
     
    790790}
    791791
    792792/**
    793  * wp_kses_array_lc() - Goes through an array and changes the keys to all lower case.
     793 * Goes through an array and changes the keys to all lower case.
    794794 *
    795795 * @since 1.0.0
    796796 *
     
    814814}
    815815
    816816/**
    817  * wp_kses_js_entities() - Removes the HTML JavaScript entities found in early versions of Netscape 4.
     817 * Removes the HTML JavaScript entities found in early versions of Netscape 4.
    818818 *
    819819 * @since 1.0.0
    820820 *
     
    826826}
    827827
    828828/**
    829  * wp_kses_html_error() - Handles parsing errors in wp_kses_hair()
     829 * Handles parsing errors in wp_kses_hair().
    830830 *
    831  * The general plan is to remove everything to and including some
    832  * whitespace, but it deals with quotes and apostrophes as well.
     831 * The general plan is to remove everything to and including some whitespace,
     832 * but it deals with quotes and apostrophes as well.
    833833 *
    834834 * @since 1.0.0
    835835 *
     
    841841}
    842842
    843843/**
    844  * wp_kses_bad_protocol_once() - Sanitizes content from bad protocols and other characters
     844 * Sanitizes content from bad protocols and other characters.
    845845 *
    846  * This function searches for URL protocols at the beginning of $string,
    847  * while handling whitespace and HTML entities.
     846 * This function searches for URL protocols at the beginning of $string, while
     847 * handling whitespace and HTML entities.
    848848 *
    849849 * @since 1.0.0
    850850 *
     
    866866}
    867867
    868868/**
    869  * wp_kses_bad_protocol_once2() - Callback for wp_kses_bad_protocol_once() regular expression.
     869 * Callback for wp_kses_bad_protocol_once() regular expression.
    870870 *
    871871 * This function processes URL protocols, checks to see if they're in the
    872872 * white-list or not, and returns different data depending on the answer.
     
    910910}
    911911
    912912/**
    913  * wp_kses_normalize_entities() - Converts and fixes HTML entities
     913 * Converts and fixes HTML entities.
    914914 *
    915  * This function normalizes HTML entities. It will convert "AT&T" to the
    916  * correct "AT&amp;T", "&#00058;" to "&#58;", "&#XYZZY;" to "&amp;#XYZZY;"
    917  * and so on.
     915 * This function normalizes HTML entities. It will convert "AT&T" to the correct
     916 * "AT&amp;T", "&#00058;" to "&#58;", "&#XYZZY;" to "&amp;#XYZZY;" and so on.
    918917 *
    919918 * @since 1.0.0
    920919 *
     
    936935}
    937936
    938937/**
    939  * wp_kses_normalize_entities2() - Callback for wp_kses_normalize_entities() regular expression
     938 * Callback for wp_kses_normalize_entities() regular expression.
    940939 *
    941  * This function helps wp_kses_normalize_entities() to only accept 16 bit
    942  * values and nothing more for &#number; entities.
     940 * This function helps wp_kses_normalize_entities() to only accept 16 bit values
     941 * and nothing more for &#number; entities.
    943942 *
    944943 * @access private
    945944 * @since 1.0.0
     
    956955}
    957956
    958957/**
    959  * wp_kses_normalize_entities3() - Callback for wp_kses_normalize_entities() for regular expression
     958 * Callback for wp_kses_normalize_entities() for regular expression.
    960959 *
    961  * This function helps wp_kses_normalize_entities() to only accept valid Unicode numeric entities
    962  * in hex form.
     960 * This function helps wp_kses_normalize_entities() to only accept valid Unicode
     961 * numeric entities in hex form.
    963962 *
    964963 * @access private
    965964 *
     
    975974}
    976975
    977976/**
    978  * valid_unicode() - Helper function to determine if a Unicode value is valid.
     977 * Helper function to determine if a Unicode value is valid.
    979978 *
    980979 * @param int $i Unicode value
    981980 * @return bool true if the value was a valid Unicode number
     
    988987}
    989988
    990989/**
    991  * wp_kses_decode_entities() - Convert all entities to their character counterparts.
     990 * Convert all entities to their character counterparts.
    992991 *
    993  * This function decodes numeric HTML entities (&#65; and &#x41;). It
    994  * doesn't do anything with other entities like &auml;, but we don't need
    995  * them in the URL protocol whitelisting system anyway.
     992 * This function decodes numeric HTML entities (&#65; and &#x41;). It doesn't do
     993 * anything with other entities like &auml;, but we don't need them in the URL
     994 * protocol whitelisting system anyway.
    996995 *
    997996 * @since 1.0.0
    998997 *
     
    10071006}
    10081007
    10091008/**
    1010  * wp_filter_kses() - Sanitize content with allowed HTML Kses rules
     1009 * Sanitize content with allowed HTML Kses rules.
    10111010 *
    10121011 * @since 1.0.0
    10131012 * @uses $allowedtags
     
    10211020}
    10221021
    10231022/**
    1024  * wp_filter_post_kses() - Sanitize content for allowed HTML tags for post content
     1023 * Sanitize content for allowed HTML tags for post content.
    10251024 *
    1026  * Post content refers to the page contents of the 'post' type and not
    1027  * $_POST data from forms.
     1025 * Post content refers to the page contents of the 'post' type and not $_POST
     1026 * data from forms.
    10281027 *
    10291028 * @since 2.0.0
    10301029 * @uses $allowedposttags
     
    10381037}
    10391038
    10401039/**
    1041  * wp_filter_nohtml_kses() - Strips all of the HTML in the content
     1040 * Strips all of the HTML in the content.
    10421041 *
    10431042 * @since 2.1.0
    10441043 *
     
    10501049}
    10511050
    10521051/**
    1053  * kses_init_filters() - Adds all Kses input form content filters
     1052 * Adds all Kses input form content filters.
    10541053 *
    1055  * All hooks have default priority. The wp_filter_kses() fucntion
    1056  * is added to the 'pre_comment_content' and 'title_save_pre'
    1057  * hooks. The wp_filter_post_kses() function is added to the
    1058  * 'content_save_pre', 'excerpt_save_pre', and 'content_filtered_save_pre'
    1059  * hooks.
     1054 * All hooks have default priority. The wp_filter_kses() function is added to
     1055 * the 'pre_comment_content' and 'title_save_pre' hooks.
    10601056 *
     1057 * The wp_filter_post_kses() function is added to the 'content_save_pre',
     1058 * 'excerpt_save_pre', and 'content_filtered_save_pre' hooks.
     1059 *
    10611060 * @since 2.0.0
    10621061 * @uses add_filter() See description for what functions are added to what hooks.
    10631062 */
     
    10731072}
    10741073
    10751074/**
    1076  * kses_remove_filters() - Removes all Kses input form content filters
     1075 * Removes all Kses input form content filters.
    10771076 *
    1078  * A quick procedural method to removing all of the filters
    1079  * that kses uses for content in WordPress Loop.
     1077 * A quick procedural method to removing all of the filters that kses uses for
     1078 * content in WordPress Loop.
    10801079 *
    1081  * Does not remove the kses_init() function from 'init' hook
    1082  * (priority is default). Also does not remove kses_init()
    1083  * function from 'set_current_user' hook (priority is also
    1084  * default).
     1080 * Does not remove the kses_init() function from 'init' hook (priority is
     1081 * default). Also does not remove kses_init() function from 'set_current_user'
     1082 * hook (priority is also default).
    10851083 *
    10861084 * @since 2.0.6
    10871085 */
     
    10971095}
    10981096
    10991097/**
    1100  * kses_init() - Sets up most of the Kses filters for input form content
     1098 * Sets up most of the Kses filters for input form content.
    11011099 *
    11021100 * If you remove the kses_init() function from 'init' hook and
    1103  * 'set_current_user' (priority is default), then none of the
    1104  * Kses filter hooks will be added.
     1101 * 'set_current_user' (priority is default), then none of the Kses filter hooks
     1102 * will be added.
    11051103 *
    1106  * First removes all of the Kses filters in case the current user
    1107  * does not need to have Kses filter the content. If the user does
    1108  * not have unfiltered html capability, then Kses filters are added.
     1104 * First removes all of the Kses filters in case the current user does not need
     1105 * to have Kses filter the content. If the user does not have unfiltered html
     1106 * capability, then Kses filters are added.
    11091107 *
    11101108 * @uses kses_remove_filters() Removes the Kses filters
    11111109 * @uses kses_init_filters() Adds the Kses filters back if the user
     
    11211119
    11221120add_action('init', 'kses_init');
    11231121add_action('set_current_user', 'kses_init');
    1124 ?>
     1122
     1123?>
     1124 No newline at end of file
  • l10n.php

     
    77 */
    88
    99/**
    10  * get_locale() - Gets the current locale
     10 * Gets the current locale.
    1111 *
    12  * If the locale is set, then it will filter the locale
    13  * in the 'locale' filter hook and return the value.
     12 * If the locale is set, then it will filter the locale in the 'locale' filter
     13 * hook and return the value.
    1414 *
    15  * If the locale is not set already, then the WPLANG
    16  * constant is used if it is defined. Then it is filtered
    17  * through the 'locale' filter hook and the value for the
    18  * locale global set and the locale is returned.
     15 * If the locale is not set already, then the WPLANG constant is used if it is
     16 * defined. Then it is filtered through the 'locale' filter hook and the value
     17 * for the locale global set and the locale is returned.
    1918 *
    20  * The process to get the locale should only be done once
    21  * but the locale will always be filtered using the
    22  * 'locale' hook.
     19 * The process to get the locale should only be done once but the locale will
     20 * always be filtered using the 'locale' hook.
    2321 *
    2422 * @since 1.5.0
    25  * @uses apply_filters() Calls 'locale' hook on locale value
    26  * @uses $locale Gets the locale stored in the global
     23 * @uses apply_filters() Calls 'locale' hook on locale value.
     24 * @uses $locale Gets the locale stored in the global.
    2725 *
    28  * @return string The locale of the blog or from the 'locale' hook
     26 * @return string The locale of the blog or from the 'locale' hook.
    2927 */
    3028function get_locale() {
    3129        global $locale;
     
    4644}
    4745
    4846/**
    49  * translate() - Retrieve the translated text
     47 * Retrieve the translated text.
    5048 *
    51  * If the domain is set in the $l10n global, then the text is run
    52  * through the domain's translate method. After it is passed to
    53  * the 'gettext' filter hook, along with the untranslated text as
    54  * the second parameter.
     49 * If the domain is set in the $l10n global, then the text is run through the
     50 * domain's translate method. After it is passed to the 'gettext' filter hook,
     51 * along with the untranslated text as the second parameter.
    5552 *
    5653 * If the domain is not set, the $text is just returned.
    5754 *
    5855 * @since 2.2.0
    59  * @uses $l10n Gets list of domain translated string (gettext_reader) objects
     56 * @uses $l10n Gets list of domain translated string (gettext_reader) objects.
    6057 * @uses apply_filters() Calls 'gettext' on domain translated text
    61  *              with the untranslated text as second parameter
     58 *              with the untranslated text as second parameter.
    6259 *
    63  * @param string $text Text to translate
    64  * @param string $domain Domain to retrieve the translated text
     60 * @param string $text Text to translate.
     61 * @param string $domain Domain to retrieve the translated text.
    6562 * @return string Translated text
    6663 */
    6764function translate($text, $domain = 'default') {
     
    7471}
    7572
    7673/**
    77  * translate_with_context() - Retrieve the translated text and strip context
     74 * Retrieve the translated text and strip context.
    7875 *
    79  * If the domain is set in the $l10n global, then the text is run
    80  * through the domain's translate method. After it is passed to
    81  * the 'gettext' filter hook, along with the untranslated text as
    82  * the second parameter.
     76 * If the domain is set in the $l10n global, then the text is run through the
     77 * domain's translate method. After it is passed to the 'gettext' filter hook,
     78 * along with the untranslated text as the second parameter.
    8379 *
    8480 * If the domain is not set, the $text is just returned.
    8581 *
     
    10197}
    10298
    10399/**
    104  * __() - Retrieve a translated string
     100 * Retrieves the translated string from the translate().
    105101 *
    106  * __() is a convenience function which retrieves the translated
    107  * string from the translate().
    108  *
    109102 * @see translate() An alias of translate()
    110103 * @since 2.1.0
    111104 *
     
    117110        return translate($text, $domain);
    118111}
    119112
    120 // .
    121113/**
    122  * _e() - Display a translated string
     114 * Displays the returned translated text from translate().
    123115 *
    124  * _e() is a convenience function which displays the returned
    125  * translated text from translate().
    126  *
    127116 * @see translate() Echos returned translate() string
    128117 * @since 1.2.0
    129118 *
     
    135124}
    136125
    137126/**
    138  * _c() - Retrieve context translated string
     127 * Retrieve context translated string.
    139128 *
    140  * Quite a few times, there will be collisions with similar
    141  * translatable text found in more than two places but with
    142  * different translated context.
     129 * Quite a few times, there will be collisions with similar translatable text
     130 * found in more than two places but with different translated context.
    143131 *
    144  * In order to use the separate contexts, the _c() function
    145  * is used and the translatable string uses a pipe ('|')
    146  * which has the context the string is in.
     132 * In order to use the separate contexts, the _c() function is used and the
     133 * translatable string uses a pipe ('|') which has the context the string is in.
    147134 *
    148  * When the translated string is returned, it is everything
    149  * before the pipe, not including the pipe character. If
    150  * there is no pipe in the translated text then everything
    151  * is returned.
     135 * When the translated string is returned, it is everything before the pipe, not
     136 * including the pipe character. If there is no pipe in the translated text then
     137 * everything is returned.
    152138 *
    153139 * @since 2.2.0
    154140 *
     
    161147}
    162148
    163149/**
    164  * __ngettext() - Retrieve the plural or single form based on the amount
     150 * Retrieve the plural or single form based on the amount.
    165151 *
    166  * If the domain is not set in the $l10n list, then a comparsion
    167  * will be made and either $plural or $single parameters returned.
     152 * If the domain is not set in the $l10n list, then a comparsion will be made
     153 * and either $plural or $single parameters returned.
    168154 *
    169  * If the domain does exist, then the parameters $single, $plural,
    170  * and $number will first be passed to the domain's ngettext method.
    171  * Then it will be passed to the 'ngettext' filter hook along with
    172  * the same parameters. The expected type will be a string.
     155 * If the domain does exist, then the parameters $single, $plural, and $number
     156 * will first be passed to the domain's ngettext method. Then it will be passed
     157 * to the 'ngettext' filter hook along with the same parameters. The expected
     158 * type will be a string.
    173159 *
    174160 * @since 1.2.0
    175161 * @uses $l10n Gets list of domain translated string (gettext_reader) objects
     
    196182}
    197183
    198184/**
    199  * __ngettext_noop() - register plural strings in POT file, but don't translate them
     185 * Register plural strings in POT file, but don't translate them.
    200186 *
    201187 * Used when you want do keep structures with translatable plural strings and
    202188 * use them later.
     
    222208}
    223209
    224210/**
    225  * load_textdomain() - Loads MO file into the list of domains
     211 * Loads MO file into the list of domains.
    226212 *
    227  * If the domain already exists, the inclusion will fail. If the
    228  * MO file is not readable, the inclusion will fail.
     213 * If the domain already exists, the inclusion will fail. If the MO file is not
     214 * readable, the inclusion will fail.
    229215 *
    230  * On success, the mofile will be placed in the $l10n global by
    231  * $domain and will be an gettext_reader object.
     216 * On success, the mofile will be placed in the $l10n global by $domain and will
     217 * be an gettext_reader object.
    232218 *
    233219 * @since 1.5.0
    234220 * @uses $l10n Gets list of domain translated string (gettext_reader) objects
     
    260246}
    261247
    262248/**
    263  * load_default_textdomain() - Loads default translated strings based on locale
     249 * Loads default translated strings based on locale.
    264250 *
    265  * Loads the .mo file in WP_LANG_DIR constant path from WordPress root.
    266  * The translated (.mo) file is named based off of the locale.
     251 * Loads the .mo file in WP_LANG_DIR constant path from WordPress root. The
     252 * translated (.mo) file is named based off of the locale.
    267253 *
    268254 * @since 1.5.0
    269255 */
     
    276262}
    277263
    278264/**
    279  * load_plugin_textdomain() - Loads the plugin's translated strings
     265 * Loads the plugin's translated strings.
    280266 *
    281  * If the path is not given then it will be the root of the plugin
    282  * directory. The .mo file should be named based on the domain with a
    283  * dash followed by a dash, and then the locale exactly.
     267 * If the path is not given then it will be the root of the plugin directory.
     268 * The .mo file should be named based on the domain with a dash followed by a
     269 * dash, and then the locale exactly.
    284270 *
    285271 * @since 1.5.0
    286272 *
     
    304290}
    305291
    306292/**
    307  * load_theme_textdomain() - Includes theme's translated strings for the theme
     293 * Loads the theme's translated strings.
    308294 *
    309295 * If the current locale exists as a .mo file in the theme's root directory, it
    310296 * will be included in the translated strings by the $domain.
     
    322308        load_textdomain($domain, $mofile);
    323309}
    324310
    325 ?>
     311?>
     312 No newline at end of file
  • locale.php

     
    77 */
    88
    99/**
    10  * {@internal Missing Short Description}}
     10 * Class that loads the calendar locale.
    1111 *
    12  * {@internal Missing Long Description}}
    13  *
    1412 * @since 2.1.0
    1513 */
    1614class WP_Locale {
  • plugin.php

     
    1111 * {@link http://us2.php.net/manual/en/language.pseudo-types.php#language.types.callback 'callback'}
    1212 * type are valid.
    1313 *
    14  * Also see the {@link http://codex.wordpress.org/Plugin_API Plugin API} for more information
    15  * and examples on how to use a lot of these functions.
     14 * Also see the {@link http://codex.wordpress.org/Plugin_API Plugin API} for
     15 * more information and examples on how to use a lot of these functions.
    1616 *
    1717 * @package WordPress
    1818 * @subpackage Plugin
     
    2727 * can specify that one or more of its PHP functions is executed to
    2828 * modify specific types of text at these times, using the Filter API.
    2929 *
    30  * To use the API, the following code should be used to bind a callback to the filter
     30 * To use the API, the following code should be used to bind a callback to the
     31 * filter.
     32 *
    3133 * <code>
    3234 * function example_hook($example) { echo $example; }
    33  *
    3435 * add_filter('example_filter', 'example_hook');
    3536 * </code>
    3637 *
    37  * In WordPress 1.5.1+, hooked functions can take extra arguments that are set when
    38  * the matching do_action() or apply_filters() call is run. The <tt>$accepted_args
    39  * allow for calling functions only when the number of args match. Hooked functions
    40  * can take extra arguments that are set when the matching <tt>do_action()</tt> or
    41  * <tt>apply_filters()</tt> call is run. For example, the action <tt>comment_id_not_found</tt>
    42  * will pass any functions that hook onto it the ID of the requested comment.
     38 * In WordPress 1.5.1+, hooked functions can take extra arguments that are set
     39 * when the matching do_action() or apply_filters() call is run. The
     40 * $accepted_args allow for calling functions only when the number of args
     41 * match. Hooked functions can take extra arguments that are set when the
     42 * matching do_action() or apply_filters() call is run. For example, the action
     43 * comment_id_not_found will pass any functions that hook onto it the ID of the
     44 * requested comment.
    4345 *
    44  * <strong>Note:</strong> the function will return true no matter if the function was hooked
    45  * fails or not. There are no checks for whether the function exists beforehand and no checks
    46  * to whether the <tt>$function_to_add is even a string. It is up to you to take care and
    47  * this is done for optimization purposes, so everything is as quick as possible.
     46 * <strong>Note:</strong> the function will return true no matter if the
     47 * function was hooked fails or not. There are no checks for whether the
     48 * function exists beforehand and no checks to whether the <tt>$function_to_add
     49 * is even a string. It is up to you to take care and this is done for
     50 * optimization purposes, so everything is as quick as possible.
    4851 *
    4952 * @package WordPress
    5053 * @subpackage Plugin
     
    5356 *      wp_filter['tag']['array of priorities']['array of functions serialized']['array of ['array (functions, accepted_args)]']
    5457 * @global array $merged_filters Tracks the tags that need to be merged for later. If the hook is added, it doesn't need to run through that process.
    5558 *
    56  * @param string $tag The name of the filter to hook the <tt>$function_to_add</tt> to.
     59 * @param string $tag The name of the filter to hook the $function_to_add to.
    5760 * @param callback $function_to_add The name of the function to be called when the filter is applied.
    5861 * @param int $priority optional. Used to specify the order in which the functions associated with a particular action are executed (default: 10). Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action.
    5962 * @param int $accepted_args optional. The number of arguments the function accept (default 1).
     
    101104/**
    102105 * Call the functions added to a filter hook.
    103106 *
    104  * The callback functions attached to filter hook <tt>$tag</tt> are invoked by
    105  * calling this function. This function can be used to create a new filter hook
    106  * by simply calling this function with the name of the new hook specified using
    107  * the <tt>$tag</a> parameter.
     107 * The callback functions attached to filter hook $tag are invoked by calling
     108 * this function. This function can be used to create a new filter hook by
     109 * simply calling this function with the name of the new hook specified using
     110 * the $tag parameter.
    108111 *
    109112 * The function allows for additional arguments to be added and passed to hooks.
    110113 * <code>
     
    232235}
    233236
    234237/**
    235  * Return the name of the current filter or action.
     238 * Retrieve the name of the current filter or action.
    236239 *
    237240 * @package WordPress
    238241 * @subpackage Plugin
     
    260263 * @subpackage Plugin
    261264 * @since 1.2
    262265 *
    263  * @param string $tag The name of the action to which the <tt>$function_to-add</tt> is hooked.
     266 * @param string $tag The name of the action to which the $function_to_add is hooked.
    264267 * @param callback $function_to_add The name of the function you wish to be called.
    265268 * @param int $priority optional. Used to specify the order in which the functions associated with a particular action are executed (default: 10). Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action.
    266269 * @param int $accepted_args optional. The number of arguments the function accept (default 1).
     
    273276/**
    274277 * Execute functions hooked on a specific action hook.
    275278 *
    276  * This function invokes all functions attached to action hook <tt>$tag</tt>.
    277  * It is possible to create new action hooks by simply calling this function,
     279 * This function invokes all functions attached to action hook $tag. It is
     280 * possible to create new action hooks by simply calling this function,
    278281 * specifying the name of the new hook using the <tt>$tag</tt> parameter.
    279282 *
    280  * You can pass extra arguments to the hooks, much like you can with apply_filters().
     283 * You can pass extra arguments to the hooks, much like you can with
     284 * apply_filters().
    281285 *
    282  * @see apply_filters() This function works similar with the exception that nothing is
    283  * returned and only the functions or methods are called.
     286 * @see apply_filters() This function works similar with the exception that
     287 * nothing is returned and only the functions or methods are called.
    284288 *
    285289 * @package WordPress
    286290 * @subpackage Plugin
     
    340344}
    341345
    342346/**
    343  * Return the number times an action is fired.
     347 * Retrieve the number times an action is fired.
    344348 *
    345349 * @package WordPress
    346350 * @subpackage Plugin
     
    362366/**
    363367 * Execute functions hooked on a specific action hook, specifying arguments in an array.
    364368 *
    365  * @see do_action() This function is identical, but the arguments passed to
    366  * the functions hooked to <tt>$tag</tt> are supplied using an array.
     369 * @see do_action() This function is identical, but the arguments passed to the
     370 * functions hooked to <tt>$tag</tt> are supplied using an array.
    367371 *
    368372 * @package WordPress
    369373 * @subpackage Plugin
     
    498502 * When a plugin is activated, the action 'activate_PLUGINNAME' hook is
    499503 * activated. In the name of this hook, PLUGINNAME is replaced with the name of
    500504 * the plugin, including the optional subdirectory. For example, when the plugin
    501  * is located in <tt>wp-content/plugin/sampleplugin/sample.php</tt>, then the
    502  * name of this hook will become 'activate_sampleplugin/sample.php'
    503  * When the plugin consists of only one file and is (as by default) located at
    504  * <tt>wp-content/plugin/sample.php</tt> the name of this hook will be
     505 * is located in wp-content/plugin/sampleplugin/sample.php, then the name of
     506 * this hook will become 'activate_sampleplugin/sample.php'. When the plugin
     507 * consists of only one file and is (as by default) located at
     508 * wp-content/plugin/sample.php the name of this hook will be
    505509 * 'activate_sample.php'.
    506510 *
    507511 * @package WordPress
     
    524528 * When a plugin is deactivated, the action 'deactivate_PLUGINNAME' hook is
    525529 * deactivated. In the name of this hook, PLUGINNAME is replaced with the name
    526530 * of the plugin, including the optional subdirectory. For example, when the
    527  * plugin is located in <tt>wp-content/plugin/sampleplugin/sample.php</tt>, then
     531 * plugin is located in wp-content/plugin/sampleplugin/sample.php, then
    528532 * the name of this hook will become 'activate_sampleplugin/sample.php'.
    529533 *
    530534 * When the plugin consists of only one file and is (as by default) located at
    531  * <tt>wp-content/plugin/sample.php</tt> the name of this hook will be
     535 * wp-content/plugin/sample.php the name of this hook will be
    532536 * 'activate_sample.php'.
    533537 *
    534538 * @package WordPress
     
    631635 *
    632636 * @package WordPress
    633637 * @subpackage Plugin
     638 * @access private
    634639 * @since 2.2.3
    635  *
    636640 * @link http://trac.wordpress.org/ticket/3875
    637641 *
    638  * @access private
    639  *
    640642 * @global array $wp_filter Storage for all of the filters and actions
    641643 * @param string $tag Used in counting how many hooks were applied
    642644 * @param string|array $function Used for creating unique id
  • rss.php

     
    387387require_once( dirname(__FILE__) . '/class-snoopy.php');
    388388
    389389if ( !function_exists('fetch_rss') ) :
     390/**
     391 * Build Magpie object based on RSS from URL.
     392 *
     393 * @since unknown
     394 * @package External
     395 * @subpackage MagpieRSS
     396 *
     397 * @param string $url URL to retrieve feed
     398 * @return bool|MagpieRSS false on failure or MagpieRSS object on success.
     399 */
    390400function fetch_rss ($url) {
    391401        // initialize constants
    392402        init();
     
    515525} // end fetch_rss()
    516526endif;
    517527
     528/**
     529 * Retrieve URL headers and content using Snoopy.
     530 *
     531 * @since unknown
     532 * @package External
     533 * @subpackage MagpieRSS
     534 *
     535 * @param string $url URL to retrieve
     536 * @param array $headers Optional. Headers to send to the URL.
     537 * @return Snoopy
     538 */
    518539function _fetch_remote_file ($url, $headers = "" ) {
    519540        // Snoopy is an HTTP client in PHP
    520541        $client = new Snoopy();
     
    530551
    531552}
    532553
     554/**
     555 * Retrieve
     556 *
     557 * @since unknown
     558 * @package External
     559 * @subpackage MagpieRSS
     560 *
     561 * @param unknown_type $resp
     562 * @return unknown
     563 */
    533564function _response_to_rss ($resp) {
    534565        $rss = new MagpieRSS( $resp->results );
    535566
     
    570601        } // end if ($rss and !$rss->error)
    571602}
    572603
    573 /*=======================================================================*\
    574         Function:       init
    575         Purpose:        setup constants with default values
    576                                 check for user overrides
    577 \*=======================================================================*/
     604/**
     605 * Setup constants with default values, unless user overrides.
     606 *
     607 * @since unknown
     608 * @package External
     609 * @subpackage MagpieRSS
     610 */
    578611function init () {
    579612        if ( defined('MAGPIE_INITALIZED') ) {
    580613                return;
     
    835868endif;
    836869
    837870if ( !function_exists('wp_rss') ) :
     871/**
     872 * Display all RSS items in a HTML ordered list.
     873 *
     874 * @since unknown
     875 * @package External
     876 * @subpackage MagpieRSS
     877 *
     878 * @param string $url URL of feed to display. Will not auto sense feed URL.
     879 * @param int $num_items Optional. Number of items to display, default is all.
     880 */
    838881function wp_rss( $url, $num_items = -1 ) {
    839882        if ( $rss = fetch_rss( $url ) ) {
    840883                echo '<ul>';
     
    860903endif;
    861904
    862905if ( !function_exists('get_rss') ) :
     906/**
     907 * Display RSS items in HTML list items.
     908 *
     909 * You have to specify which HTML list you want, either ordered or unordered
     910 * before using the function. You also have to specify how many items you wish
     911 * to display. You can't display all of them like you can with wp_rss()
     912 * function.
     913 *
     914 * @since unknown
     915 * @package External
     916 * @subpackage MagpieRSS
     917 *
     918 * @param string $url URL of feed to display. Will not auto sense feed URL.
     919 * @param int $num_items Optional. Number of items to display, default is all.
     920 * @return bool False on failure.
     921 */
    863922function get_rss ($url, $num_items = 5) { // Like get posts, but for RSS
    864923        $rss = fetch_rss($url);
    865924        if ( $rss ) {
  • taxonomy.php

     
    11<?php
    22/**
     3 * Taxonomy API
     4 *
    35 * @package WordPress
    46 * @subpackage Taxonomy
    5  * @since 2.3
     7 * @since 2.3.0
    68 */
    79
    810//
     
    1113
    1214/**
    1315 * Default Taxonomy Objects
    14  * @since 2.3
     16 * @since 2.3.0
    1517 * @global array $wp_taxonomies
    1618 */
    1719$wp_taxonomies = array();
     
    3032 *
    3133 * @package WordPress
    3234 * @subpackage Taxonomy
    33  * @since 2.3
     35 * @since 2.3.0
    3436 *
    3537 * @uses $wp_taxonomies
    3638 *
     
    6567 *
    6668 * @package WordPress
    6769 * @subpackage Taxonomy
    68  * @since 2.3
     70 * @since 2.3.0
    6971 *
    7072 * @uses $wp_taxonomies
    7173 * @uses is_taxonomy() Checks whether taxonomy exists
     
    8789 *
    8890 * @package WordPress
    8991 * @subpackage Taxonomy
    90  * @since 2.3
     92 * @since 2.3.0
    9193 *
    9294 * @uses $wp_taxonomies
    9395 *
     
    110112 *
    111113 * @package WordPress
    112114 * @subpackage Taxonomy
    113  * @since 2.3
     115 * @since 2.3.0
    114116 *
    115117 * @uses is_taxonomy() Checks whether taxonomy exists
    116118 * @uses get_taxonomy() Used to get the taxonomy object
     
    153155 *
    154156 * @package WordPress
    155157 * @subpackage Taxonomy
    156  * @since 2.3
     158 * @since 2.3.0
    157159 * @uses $wp_taxonomies Inserts new taxonomy object into the list
    158160 * @uses $wp_rewrite Adds rewrite tags and permastructs
    159161 * @uses $wp Adds query vars
     
    210212 *
    211213 * @package WordPress
    212214 * @subpackage Taxonomy
    213  * @since 2.3
     215 * @since 2.3.0
    214216 *
    215217 * @uses $wpdb
    216218 * @uses wp_parse_args() Creates an array from string $args.
     
    281283 *
    282284 * @package WordPress
    283285 * @subpackage Taxonomy
    284  * @since 2.3
     286 * @since 2.3.0
    285287 *
    286288 * @uses $wpdb
    287289 * @uses sanitize_term() Cleanses the term based on $filter context before returning.
     
    347349 *
    348350 * @package WordPress
    349351 * @subpackage Taxonomy
    350  * @since 2.3
     352 * @since 2.3.0
    351353 *
    352354 * @uses $wpdb
    353355 * @uses sanitize_term() Cleanses the term based on $filter context before returning.
     
    408410 *
    409411 * @package WordPress
    410412 * @subpackage Taxonomy
    411  * @since 2.3
     413 * @since 2.3.0
    412414 *
    413415 * @uses $wpdb
    414416 * @uses _get_term_hierarchy()
     
    446448 *
    447449 * @package WordPress
    448450 * @subpackage Taxonomy
    449  * @since 2.3
     451 * @since 2.3.0
    450452 *
    451453 * @uses sanitize_term_field() Passes the return value in sanitize_term_field on success.
    452454 *
     
    479481 *
    480482 * @package WordPress
    481483 * @subpackage Taxonomy
    482  * @since 2.3
     484 * @since 2.3.0
    483485 *
    484486 * @uses sanitize_term() Passes the return value on success
    485487 *
     
    543545 *
    544546 * @package WordPress
    545547 * @subpackage Taxonomy
    546  * @since 2.3
     548 * @since 2.3.0
    547549 *
    548550 * @uses $wpdb
    549551 * @uses wp_parse_args() Merges the defaults with those defined by $args and allows for strings.
     
    755757 *
    756758 * @package WordPress
    757759 * @subpackage Taxonomy
    758  * @since 2.3
     760 * @since 2.3.0
    759761 *
    760762 * @uses $wpdb
    761763 *
     
    809811 *
    810812 * @package WordPress
    811813 * @subpackage Taxonomy
    812  * @since 2.3
     814 * @since 2.3.0
    813815 *
    814816 * @uses sanitize_term_field Used to sanitize all fields in a term
    815817 *
     
    854856 *
    855857 * @package WordPress
    856858 * @subpackage Taxonomy
    857  * @since 2.3
     859 * @since 2.3.0
    858860 *
    859861 * @uses $wpdb
    860862 *
     
    914916 *
    915917 * @package WordPress
    916918 * @subpackage Taxonomy
    917  * @since 2.3
     919 * @since 2.3.0
    918920 *
    919921 * @uses $wpdb
    920922 * @uses wp_parse_args() Turns strings into arrays and merges defaults into an array.
     
    946948 *
    947949 * @package WordPress
    948950 * @subpackage Taxonomy
    949  * @since 2.3
     951 * @since 2.3.0
    950952 * @uses $wpdb
    951953 *
    952954 * @param int $object_id The term Object Id that refers to the term
     
    979981 *
    980982 * @package WordPress
    981983 * @subpackage Taxonomy
    982  * @since 2.3
     984 * @since 2.3.0
    983985 *
    984986 * @uses $wpdb
    985987 * @uses do_action() Calls both 'delete_term' and 'delete_$taxonomy' action
     
    10731075 *
    10741076 * @package WordPress
    10751077 * @subpackage Taxonomy
    1076  * @since 2.3
     1078 * @since 2.3.0
    10771079 * @uses $wpdb
    10781080 *
    10791081 * @param int|array $object_id The id of the object(s) to retrieve.
     
    11971199 *
    11981200 * @package WordPress
    11991201 * @subpackage Taxonomy
    1200  * @since 2.3
     1202 * @since 2.3.0
    12011203 * @uses $wpdb
    12021204 *
    12031205 * @uses do_action() Calls 'create_term' hook with the term id and taxonomy id as parameters.
     
    13021304 *
    13031305 * @package WordPress
    13041306 * @subpackage Taxonomy
    1305  * @since 2.3
     1307 * @since 2.3.0
    13061308 * @uses $wpdb
    13071309 *
    13081310 * @param int $object_id The object to relate to.
     
    13881390 *
    13891391 * @package WordPress
    13901392 * @subpackage Taxonomy
    1391  * @since 2.3
     1393 * @since 2.3.0
    13921394 * @uses $wpdb
    13931395 *
    13941396 * @param string $slug The string that will be tried for a unique slug
     
    14551457 *
    14561458 * @package WordPress
    14571459 * @subpackage Taxonomy
    1458  * @since 2.3
     1460 * @since 2.3.0
    14591461 *
    14601462 * @uses $wpdb
    14611463 * @uses do_action() Will call both 'edit_term' and 'edit_$taxonomy' twice.
     
    15521554/**
    15531555 * Enable or disable term counting.
    15541556 *
    1555  * @since 2.6
     1557 * @since 2.5.0
    15561558 *
    1557  * @param bool $defer Optional.
    1558  * @return bool
     1559 * @param bool $defer Optional. Enable if true, disable if false.
     1560 * @return bool Whether term counting is enabled or disabled.
    15591561 */
    1560 function wp_defer_term_counting($defer=NULL) {
     1562function wp_defer_term_counting($defer=null) {
    15611563        static $_defer = false;
    15621564
    15631565        if ( is_bool($defer) ) {
    15641566                $_defer = $defer;
    15651567                // flush any deferred counts
    15661568                if ( !$defer )
    1567                         wp_update_term_count( NULL, NULL, true );
     1569                        wp_update_term_count( null, null, true );
    15681570        }
    15691571
    15701572        return $_defer;
     
    15811583 *
    15821584 * @package WordPress
    15831585 * @subpackage Taxonomy
    1584  * @since 2.3
     1586 * @since 2.3.0
    15851587 * @uses $wpdb
    15861588 *
    15871589 * @param int|array $terms The ID of the terms
     
    16171619/**
    16181620 * Perform term count update immediately.
    16191621 *
    1620  * @since 2.6
     1622 * @since 2.5.0
    16211623 *
    16221624 * @param array $terms IDs of Terms to update.
    16231625 * @param string $taxonomy The context of the term.
     
    16591661 *
    16601662 * @package WordPress
    16611663 * @subpackage Taxonomy
    1662  * @since 2.3
     1664 * @since 2.3.0
    16631665 *
    16641666 * @see get_object_taxonomies() for more on $object_type
    16651667 * @uses do_action() Will call action hook named, 'clean_object_term_cache' after completion.
     
    16851687 *
    16861688 * @package WordPress
    16871689 * @subpackage Taxonomy
    1688  * @since 2.3
     1690 * @since 2.3.0
    16891691 * @uses $wpdb
    16901692 *
    16911693 * @param int|array $ids Single or list of Term IDs
     
    17311733 *
    17321734 * @package WordPress
    17331735 * @subpackage Taxonomy
    1734  * @since 2.3
     1736 * @since 2.3.0
    17351737 *
    17361738 * @uses wp_cache_get() Retrieves taxonomy relationship from cache
    17371739 *
     
    17601762 *
    17611763 * @package WordPress
    17621764 * @subpackage Taxonomy
    1763  * @since 2.3
     1765 * @since 2.3.0
    17641766 * @uses wp_get_object_terms() Used to get terms from the database to update
    17651767 *
    17661768 * @param string|array $object_ids Single or list of term object ID(s)
     
    18201822 *
    18211823 * @package WordPress
    18221824 * @subpackage Taxonomy
    1823  * @since 2.3
     1825 * @since 2.3.0
    18241826 *
    18251827 * @param array $terms List of Term objects to change
    18261828 * @param string $taxonomy Optional. Update Term to this taxonomy in cache
     
    18461848 * @package WordPress
    18471849 * @subpackage Taxonomy
    18481850 * @access private
    1849  * @since 2.3
     1851 * @since 2.3.0
    18501852 *
    18511853 * @uses update_option() Stores all of the children in "$taxonomy_children"
    18521854 *       option. That is the name of the taxonomy, immediately followed by '_children'.
     
    18831885 * @package WordPress
    18841886 * @subpackage Taxonomy
    18851887 * @access private
    1886  * @since 2.3
     1888 * @since 2.3.0
    18871889 *
    18881890 * @param int $term_id Look for this Term ID in $terms
    18891891 * @param array $terms List of Term IDs
     
    19401942 * @package WordPress
    19411943 * @subpackage Taxonomy
    19421944 * @access private
    1943  * @since 2.3
     1945 * @since 2.3.0
    19441946 * @uses $wpdb
    19451947 *
    19461948 * @param array $terms List of Term IDs
     
    20032005 * @package WordPress
    20042006 * @subpackage Taxonomy
    20052007 * @access private
    2006  * @since 2.3
     2008 * @since 2.3.0
    20072009 * @uses $wpdb
    20082010 *
    20092011 * @param array $terms List of Term IDs
     
    20212023/**
    20222024 * Generates a permalink for a taxonomy term archive.
    20232025 *
    2024  * @since 2.6
     2026 * @since 2.5.0
    20252027 *
    20262028 * @param object|int|string $term
    20272029 * @param string $taxonomy
     
    20772079 * 'sep' : default is empty string. Separate every taxonomy with value in this.
    20782080 * 'after' : default is empty string. Display this after the taxonomies list.
    20792081 *
    2080  * @since 2.6
     2082 * @since 2.5.0
    20812083 * @uses get_the_taxonomies()
    20822084 *
    20832085 * @param array $args Override the defaults.
     
    21022104 * This function can be used within the loop. It will also return an array of
    21032105 * the taxonomies with links to the taxonomy and name.
    21042106 *
    2105  * @since 2.6
     2107 * @since 2.5.0
    21062108 *
    21072109 * @param int $post Optional. Post ID or will use Global Post ID (in loop).
    21082110 * @return array
     
    21472149/**
    21482150 * Retrieve all taxonomies of a post with just the names.
    21492151 *
    2150  * @since 2.6
     2152 * @since 2.5.0
    21512153 * @uses get_object_taxonomies()
    21522154 *
    21532155 * @param int $post Optional. Post ID
  • update.php

     
    1414 * isn't installing.
    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 *
    2020 * @return mixed Returns null if update is unsupported. Returns false if check is too soon.
     
    8383 * isn't installing.
    8484 *
    8585 * @package WordPress
    86  * @since 2.3
     86 * @since 2.3.0
    8787 * @uses $wp_version Used to notidy the WordPress version.
    8888 *
    8989 * @return mixed Returns null if update is unsupported. Returns false if check is too soon.