Index: author-template.php =================================================================== --- author-template.php (revision 8674) +++ author-template.php (working copy) @@ -381,7 +381,7 @@ * link to the author's posts. * * @link http://codex.wordpress.org/Template_Tags/the_author_posts_link - * @since 1.2 + * @since 1.2.0 * @uses $authordata The current author's DB object. * @uses get_author_posts_url() * @uses get_the_author() @@ -400,7 +400,7 @@ /** * Retrieve the URL to the author page of the author of the current post. * - * @since 2.1 + * @since 2.1.0 * @uses $wp_rewrite WP_Rewrite * @return string The URL to the author's page. */ @@ -453,7 +453,7 @@ * echo (boolean) (true): Set to false to return the output, instead of echoing. * * @link http://codex.wordpress.org/Template_Tags/wp_list_authors - * @since 1.2 + * @since 1.2.0 * @param array $args The argument array. * @return null|string The output, if echo is set to false. */ Index: bookmark-template.php =================================================================== --- bookmark-template.php (revision 8674) +++ bookmark-template.php (working copy) @@ -7,7 +7,7 @@ */ /** - * The formatted output of a list of bookmarks + * The formatted output of a list of bookmarks. * * The $bookmarks array must contain bookmark objects and will be iterated over * to retrieve the bookmark to be used in the output. @@ -34,7 +34,7 @@ * description, and image. * 'show_rating' - Default is 0 (integer). Whether to show the link rating. * - * @since 2.1 + * @since 2.1.0 * @access private * @usedby wp_list_bookmarks() * @@ -120,7 +120,7 @@ } /** - * Retrieve or echo all of the bookmarks + * Retrieve or echo all of the bookmarks. * * List of default arguments are as follows: * 'orderby' - Default is 'name' (string). How to order the links by. String is @@ -174,7 +174,7 @@ * passed to get_bookmarks(). * @link http://codex.wordpress.org/Template_Tags/wp_list_bookmarks * - * @since 2.1 + * @since 2.1.0 * @uses _list_bookmarks() Used to iterate over all of the bookmarks and return * the html * @uses get_terms() Gets all of the categories that are for links. @@ -239,4 +239,4 @@ echo $output; } -?> \ No newline at end of file +?> Index: bookmark.php =================================================================== --- bookmark.php (revision 8674) +++ bookmark.php (working copy) @@ -9,7 +9,7 @@ /** * Retrieve Bookmark data based on ID * - * @since 2.1 + * @since 2.1.0 * @uses $wpdb Database Object * * @param int $bookmark_id @@ -39,7 +39,7 @@ /** * Retrieve single bookmark data item or field. * - * @since 2.3 + * @since 2.3.0 * @uses get_bookmark() Gets bookmark object using $bookmark as ID * @uses sanitize_bookmark_field() Sanitizes Bookmark field based on $context. * @@ -67,7 +67,7 @@ /** * Retrieve bookmark data based on ID. * - * @since 2.0 + * @since 2.0.0 * @deprecated Use get_bookmark() * @see get_bookmark() * @@ -106,7 +106,7 @@ * 'exclude' - Default is empty string (string). Exclude other categories * separated by commas. * - * @since 2.1 + * @since 2.1.0 * @uses $wpdb Database Object * @link http://codex.wordpress.org/Template_Tags/get_bookmarks * @@ -238,7 +238,7 @@ /** * Sanitizes all bookmark fields * - * @since 2.3 + * @since 2.3.0 * * @param object|array $bookmark Bookmark row * @param string $context Optional, default is 'display'. How to filter the @@ -279,7 +279,7 @@ * $field has the filter name and is passed the $value, $bookmark_id, and * $context respectively. * - * @since 2.3 + * @since 2.3.0 * * @param string $field The bookmark field * @param mixed $value The bookmark field value @@ -333,7 +333,7 @@ /** * Deletes entire bookmark cache * - * @since 2.1 + * @since 2.1.0 * @uses wp_cache_delete() Deletes the contents of 'get_bookmarks' */ function delete_get_bookmark_cache() { Index: cache.php =================================================================== --- cache.php (revision 8674) +++ cache.php (working copy) @@ -11,7 +11,7 @@ /** * Adds data to the cache, if the cache key doesn't aleady exist. * - * @since 2.0 + * @since 2.0.0 * @uses $wp_object_cache Object Cache Class * @see WP_Object_Cache::add() * @@ -35,7 +35,7 @@ * does not mean that plugins can't implement this function when they need to * make sure that the cache is cleaned up after WordPress no longer needs it. * - * @since 2.0 + * @since 2.0.0 * * @return bool Always returns True */ @@ -46,7 +46,7 @@ /** * Removes the cache contents matching ID and flag. * - * @since 2.0 + * @since 2.0.0 * @uses $wp_object_cache Object Cache Class * @see WP_Object_Cache::delete() * @@ -63,7 +63,7 @@ /** * Removes all cache items. * - * @since 2.0 + * @since 2.0.0 * @uses $wp_object_cache Object Cache Class * @see WP_Object_Cache::flush() * @@ -78,7 +78,7 @@ /** * Retrieves the cache contents from the cache by ID and flag. * - * @since 2.0 + * @since 2.0.0 * @uses $wp_object_cache Object Cache Class * @see WP_Object_Cache::get() * @@ -96,7 +96,7 @@ /** * Sets up Object Cache Global and assigns it. * - * @since 2.0 + * @since 2.0.0 * @global WP_Object_Cache $wp_object_cache WordPress Object Cache */ function wp_cache_init() { @@ -106,7 +106,7 @@ /** * Replaces the contents of the cache with new data. * - * @since 2.0 + * @since 2.0.0 * @uses $wp_object_cache Object Cache Class * @see WP_Object_Cache::replace() * @@ -144,7 +144,7 @@ /** * Adds a group or set of groups to the list of global groups. * - * @since 2.6 + * @since 2.6.0 * * @param string|array $groups A group or an array of groups to add */ @@ -156,7 +156,7 @@ /** * Adds a group or set of groups to the list of non-persistent groups. * - * @since 2.6 + * @since 2.6.0 * * @param string|array $groups A group or an array of groups to add */ @@ -188,7 +188,7 @@ * * @var array * @access private - * @since 2.0 + * @since 2.0.0 */ var $cache = array (); @@ -197,14 +197,14 @@ * * @var array * @access private - * @since 2.0 + * @since 2.0.0 */ var $non_existant_objects = array (); /** * The amount of times the cache data was already stored in the cache. * - * @since 2.5 + * @since 2.5.0 * @access private * @var int */ @@ -215,7 +215,7 @@ * * @var int * @access public - * @since 2.0 + * @since 2.0.0 */ var $cache_misses = 0; @@ -226,7 +226,7 @@ * @uses WP_Object_Cache::set Sets the data after the checking the cache * contents existance. * - * @since 2.0 + * @since 2.0.0 * * @param int|string $id What to call the contents in the cache * @param mixed $data The contents to store in the cache @@ -254,7 +254,7 @@ * On success the group and the id will be added to the * $non_existant_objects property in the class. * - * @since 2.0 + * @since 2.0.0 * * @param int|string $id What the contents in the cache are called * @param string $group Where the cache contents are grouped @@ -277,7 +277,7 @@ /** * Clears the object cache of all data * - * @since 2.0 + * @since 2.0.0 * * @return bool Always returns true */ @@ -300,7 +300,7 @@ * misses will be incremented and the cache group and ID will be added to * the nonexistant objects. * - * @since 2.0 + * @since 2.0.0 * * @param int|string $id What the contents in the cache are called * @param string $group Where the cache contents are grouped @@ -327,7 +327,7 @@ /** * Replace the contents in the cache, if contents already exist * - * @since 2.0 + * @since 2.0.0 * @see WP_Object_Cache::set() * * @param int|string $id What to call the contents in the cache @@ -358,7 +358,7 @@ * expire for each time a page is accessed and PHP finishes. The method is * more for cache plugins which use files. * - * @since 2.0 + * @since 2.0.0 * * @param int|string $id What to call the contents in the cache * @param mixed $data The contents to store in the cache @@ -387,7 +387,7 @@ * Gives the cache hits, and cache misses. Also prints every cached group, * key and the data. * - * @since 2.0 + * @since 2.0.0 */ function stats() { echo "

"; @@ -408,7 +408,7 @@ /** * PHP4 constructor; Calls PHP 5 style constructor * - * @since 2.0 + * @since 2.0.0 * * @return WP_Object_Cache */ Index: canonical.php =================================================================== --- canonical.php (revision 8674) +++ canonical.php (working copy) @@ -8,11 +8,11 @@ * @author Scott Yang * @author Mark Jaquith * @package WordPress - * @since 2.3 + * @since 2.3.0 */ /** - * Redirects incoming links to the proper URL based on the site url + * Redirects incoming links to the proper URL based on the site url. * * Search engines consider www.somedomain.com and somedomain.com to be two * different URLs when they both go to the same location. This SEO enhancement @@ -26,7 +26,7 @@ * not exist based on exact WordPress query. Will instead try to parse the URL * or query in an attempt to figure the correct page to go to. * - * @since 2.3 + * @since 2.3.0 * @uses $wp_rewrite * @uses $is_IIS * @@ -241,9 +241,9 @@ } /** - * Attempts to guess correct post based on query vars + * Attempts to guess correct post based on query vars. * - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * * @return bool|string Returns False, if it can't find post, returns correct Index: category.php =================================================================== --- category.php (revision 8674) +++ category.php (working copy) @@ -65,7 +65,7 @@ * * The category will converted to maintain backwards compatibility. * - * @since 2.1.0 + * @since 1.5.1 * @uses get_term() Used to get the category data from the taxonomy. * * @param int|object $category Category ID or Category row object Index: deprecated.php =================================================================== --- deprecated.php (revision 8674) +++ deprecated.php (working copy) @@ -1,6 +1,9 @@ user_level > 4) && user_can_create_post($user_id, $blog_id, $category_id)); } -/* returns true if $user_id can edit $post_id's date */ /** - * user_can_edit_post_date() - Whether user can delete a post + * Whether user can delete a post. * * @since 1.5 * @deprecated Use current_user_can() @@ -363,7 +365,7 @@ * @param int $user_id * @param int $post_id * @param int $blog_id Not Used - * @return bool + * @return bool returns true if $user_id can edit $post_id's date */ function user_can_edit_post_date($user_id, $post_id, $blog_id = 1) { _deprecated_function(__FUNCTION__, '0.0', 'current_user_can()'); @@ -372,9 +374,8 @@ return (($author_data->user_level > 4) && user_can_edit_post($user_id, $post_id, $blog_id)); } -/* returns true if $user_id can edit $post_id's comments */ /** - * user_can_edit_post_comments() - Whether user can delete a post + * Whether user can delete a post. * * @since 1.5 * @deprecated Use current_user_can() @@ -383,7 +384,7 @@ * @param int $user_id * @param int $post_id * @param int $blog_id Not Used - * @return bool + * @return bool returns true if $user_id can edit $post_id's comments */ function user_can_edit_post_comments($user_id, $post_id, $blog_id = 1) { _deprecated_function(__FUNCTION__, '0.0', 'current_user_can()'); @@ -392,9 +393,8 @@ return user_can_edit_post($user_id, $post_id, $blog_id); } -/* returns true if $user_id can delete $post_id's comments */ /** - * user_can_delete_post_comments() - Whether user can delete a post + * Whether user can delete a post. * * @since 1.5 * @deprecated Use current_user_can() @@ -403,7 +403,7 @@ * @param int $user_id * @param int $post_id * @param int $blog_id Not Used - * @return bool + * @return bool returns true if $user_id can delete $post_id's comments */ function user_can_delete_post_comments($user_id, $post_id, $blog_id = 1) { _deprecated_function(__FUNCTION__, '0.0', 'current_user_can()'); @@ -413,7 +413,7 @@ } /** - * user_can_edit_user() - Can user can edit other user + * Can user can edit other user. * * @since 1.5 * @deprecated Use current_user_can() @@ -435,24 +435,24 @@ } /** - * get_linksbyname() - Gets the links associated with category $cat_name. + * Gets the links associated with category $cat_name. * * @since 0.71 * @deprecated Use get_links() * @see get_links() * - * @param string $cat_name Optional. The category name to use. If no match is found uses all. - * @param string $before Optional. The html to output before the link. - * @param string $after Optional. The html to output after the link. - * @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. - * @param bool $show_images Optional. Whether to show images (if defined). - * @param string $orderby Optional. The order to output the links. E.g. 'id', 'name', 'url', 'description' or 'rating'. Or maybe owner. + * @param string $cat_name Optional. The category name to use. If no match is found uses all. + * @param string $before Optional. The html to output before the link. + * @param string $after Optional. The html to output after the link. + * @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. + * @param bool $show_images Optional. Whether to show images (if defined). + * @param string $orderby Optional. The order to output the links. E.g. 'id', 'name', 'url', 'description' or 'rating'. Or maybe owner. * 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 * random order. - * @param bool $show_description Optional. Whether to show the description if show_images=false/not defined. - * @param bool $show_rating Optional. Show rating stars/chars. - * @param int $limit Optional. Limit to X entries. If not specified, all entries are shown. - * @param int $show_updated Optional. Whether to show last updated timestamp + * @param bool $show_description Optional. Whether to show the description if show_images=false/not defined. + * @param bool $show_rating Optional. Show rating stars/chars. + * @param int $limit Optional. Limit to X entries. If not specified, all entries are shown. + * @param int $show_updated Optional. Whether to show last updated timestamp */ function get_linksbyname($cat_name = "noname", $before = '', $after = '
', $between = " ", $show_images = true, $orderby = 'id', $show_description = true, $show_rating = false, @@ -468,7 +468,7 @@ } /** - * wp_get_linksbyname() - Gets the links associated with the named category. + * Gets the links associated with the named category. * * @since 1.0.1 * @deprecated Use wp_get_links() @@ -491,7 +491,7 @@ } /** - * get_linkobjectsbyname() - Gets an array of link objects associated with category $cat_name. + * Gets an array of link objects associated with category $cat_name. * * * $links = get_linkobjectsbyname('fred'); @@ -523,7 +523,7 @@ } /** - * get_linkobjects() - Gets an array of link objects associated with category n. + * Gets an array of link objects associated with category n. * * Usage: * @@ -577,7 +577,7 @@ } /** - * get_linksbyname_withrating() - Gets the links associated with category 'cat_name' and display rating stars/chars. + * Gets the links associated with category 'cat_name' and display rating stars/chars. * * @since 0.71 * @deprecated Use get_bookmarks() @@ -604,7 +604,7 @@ } /** - * get_links_withrating() - Gets the links associated with category n and display rating stars/chars. + * Gets the links associated with category n and display rating stars/chars. * * @since 0.71 * @deprecated Use get_bookmarks() @@ -631,7 +631,7 @@ } /** - * get_autotoggle() - Gets the auto_toggle setting + * Gets the auto_toggle setting. * * @since 0.71 * @deprecated No alternative function available @@ -793,7 +793,7 @@ } /** - * wp_set_post_cats() - Sets the categories that the post id belongs to. + * Sets the categories that the post id belongs to. * * @since 1.0.1 * @deprecated Use wp_set_post_categories() @@ -829,7 +829,7 @@ } /** - * get_author_link() - Returns or Prints link to the author's posts + * Returns or Prints link to the author's posts. * * @since 1.2 * @deprecated Use get_author_posts_url() @@ -851,7 +851,7 @@ } /** - * link_pages() - Print list of pages based on arguments + * Print list of pages based on arguments. * * @since 0.71 * @deprecated Use wp_link_pages() @@ -875,7 +875,7 @@ } /** - * get_settings() - Get value based on option + * Get value based on option. * * @since 0.71 * @deprecated Use get_option() @@ -891,7 +891,7 @@ } /** - * permalink_link() - Print the permalink of the current post in the loop + * Print the permalink of the current post in the loop. * * @since 0.71 * @deprecated Use the_permalink() @@ -903,7 +903,7 @@ } /** - * permalink_single_rss() - Print the permalink to the RSS feed + * Print the permalink to the RSS feed. * * @since 0.71 * @deprecated Use the_permalink_rss() @@ -917,7 +917,7 @@ } /** - * wp_get_links() - Gets the links associated with category. + * Gets the links associated with category. * * @see get_links() for argument information that can be used in $args * @since 1.0.1 @@ -951,7 +951,7 @@ } /** - * get_links() - Gets the links associated with category by id. + * Gets the links associated with category by id. * * @since 0.71 * @deprecated Use get_bookmarks() @@ -1056,11 +1056,10 @@ } /** - * get_links_list() - Output entire list of links by category + * Output entire list of links by category. * - * Output a list of all links, listed by category, using the - * settings in $wpdb->linkcategories and output it as a nested - * HTML unordered list. + * Output a list of all links, listed by category, using the settings in + * $wpdb->linkcategories and output it as a nested HTML unordered list. * * @author Dougal * @since 1.0.1 @@ -1104,7 +1103,7 @@ } /** - * links_popup_script() - Show the link to the links popup and the number of links + * Show the link to the links popup and the number of links. * * @author Fullo * @link http://sprite.csr.unibo.it/fullo/ @@ -1148,7 +1147,7 @@ } /** - * get_linkcatname() - Gets the name of category by id. + * Gets the name of category by id. * * @since 0.71 * @deprecated Use get_category() @@ -1177,7 +1176,7 @@ } /** - * comment_rss_link() - Print RSS comment feed link + * Print RSS comment feed link. * * @since 1.0.1 * @deprecated Use post_comments_feed_link() @@ -1192,7 +1191,7 @@ } /** - * get_category_rss_link() - Print/Return link to category RSS2 feed + * Print/Return link to category RSS2 feed. * * @since 1.2 * @deprecated Use get_category_feed_link() @@ -1214,7 +1213,7 @@ } /** - * get_author_rss_link() - Print/Return link to author RSS feed + * Print/Return link to author RSS feed. * * @since 1.2 * @deprecated Use get_author_feed_link() @@ -1235,7 +1234,7 @@ } /** - * comments_rss() - Return link to the post RSS feed + * Return link to the post RSS feed. * * @since 1.5 * @deprecated Use get_post_comments_feed_link() @@ -1250,7 +1249,8 @@ } /** - * create_user() - An alias of wp_create_user(). + * An alias of wp_create_user(). + * * @param string $username The user's username. * @param string $password The user's password. * @param string $email The user's email (optional). @@ -1264,7 +1264,8 @@ } /** - * documentation_link() - Unused Admin function + * Unused Admin function. + * * @since 2.0 * @param string $deprecated Unknown * @deprecated 2.5 @@ -1275,11 +1276,10 @@ } /** - * gzip_compression() - Unused function + * Unused function. * * @deprecated 2.5 */ - function gzip_compression() { return false; } @@ -1304,4 +1304,4 @@ return get_comment($comment_ID, ARRAY_A); } -?> \ No newline at end of file +?> Index: kses.php =================================================================== --- kses.php (revision 8674) +++ kses.php (working copy) @@ -24,9 +24,8 @@ */ /** - * You can override this in your my-hacks.php file - * You can also override this in a plugin file. The - * my-hacks.php is deprecated in its usage. + * You can override this in your my-hacks.php file You can also override this + * in a plugin file. The my-hacks.php is deprecated in its usage. * * @since 1.2.0 */ @@ -35,9 +34,10 @@ if (!CUSTOM_TAGS) { /** - * Kses global for default allowable HTML tags + * Kses global for default allowable HTML tags. * - * Can be override by using CUSTOM_TAGS constant + * Can be override by using CUSTOM_TAGS constant. + * * @global array $allowedposttags * @since 2.0.0 */ @@ -281,8 +281,9 @@ 'style' => array (), 'type' => array ()), 'var' => array ()); + /** - * Kses allowed HTML elements + * Kses allowed HTML elements. * * @global array $allowedtags * @since 1.0.0 @@ -323,17 +324,17 @@ } /** - * wp_kses() - Filters content and keeps only allowable HTML elements. + * Filters content and keeps only allowable HTML elements. * - * This function makes sure that only the allowed HTML element names, - * attribute names and attribute values plus only sane HTML entities - * will occur in $string. You have to remove any slashes from PHP's - * magic quotes before you call this function. + * This function makes sure that only the allowed HTML element names, attribute + * names and attribute values plus only sane HTML entities will occur in + * $string. You have to remove any slashes from PHP's magic quotes before you + * call this function. * - * The default allowed protocols are 'http', 'https', 'ftp', 'mailto', - * 'news', 'irc', 'gopher', 'nntp', 'feed', and finally 'telnet. This - * covers all common link protocols, except for 'javascript' which - * should not be allowed for untrusted users. + * The default allowed protocols are 'http', 'https', 'ftp', 'mailto', 'news', + * 'irc', 'gopher', 'nntp', 'feed', and finally 'telnet. This covers all common + * link protocols, except for 'javascript' which should not be allowed for + * untrusted users. * * @since 1.0.0 * @@ -352,11 +353,10 @@ } /** - * wp_kses_hook() - You add any kses hooks here. + * You add any kses hooks here. * - * There is currently only one kses WordPress hook and it is - * called here. All parameters are passed to the hooks and - * expected to recieve a string. + * There is currently only one kses WordPress hook and it is called here. All + * parameters are passed to the hooks and expected to recieve a string. * * @since 1.0.0 * @@ -371,18 +371,18 @@ } /** - * wp_kses_version() - This function returns kses' version number. + * This function returns kses' version number. * * @since 1.0.0 * - * @return string Version Number + * @return string KSES Version Number */ function wp_kses_version() { return '0.2.2'; } /** - * wp_kses_split() - Searches for HTML tags, no matter how malformed + * Searches for HTML tags, no matter how malformed. * * It also matches stray ">" characters. * @@ -399,16 +399,16 @@ } /** - * wp_kses_split2() - Callback for wp_kses_split for fixing malformed HTML tags + * Callback for wp_kses_split for fixing malformed HTML tags. * - * This function does a lot of work. It rejects some very malformed things - * like <:::>. It returns an empty string, if the element isn't allowed (look - * ma, no strip_tags()!). Otherwise it splits the tag into an element and an - * attribute list. + * This function does a lot of work. It rejects some very malformed things like + * <:::>. It returns an empty string, if the element isn't allowed (look ma, no + * strip_tags()!). Otherwise it splits the tag into an element and an attribute + * list. * * After the tag is split into an element and an attribute list, it is run - * through another filter which will remove illegal attributes and once - * that is completed, will be returned. + * through another filter which will remove illegal attributes and once that is + * completed, will be returned. * * @access private * @since 1.0.0 @@ -460,13 +460,13 @@ } /** - * wp_kses_attr() - Removes all attributes, if none are allowed for this element + * Removes all attributes, if none are allowed for this element. * * If some are allowed it calls wp_kses_hair() to split them further, and then * it builds up new HTML code from the data that kses_hair() returns. It also - * removes "<" and ">" characters, if there are any left. One more thing it - * does is to check if the tag has a closing XHTML slash, and if it does, it - * puts one in the returned code as well. + * removes "<" and ">" characters, if there are any left. One more thing it does + * is to check if the tag has a closing XHTML slash, and if it does, it puts one + * in the returned code as well. * * @since 1.0.0 * @@ -531,7 +531,7 @@ } /** - * wp_kses_hair() - Builds an attribute list from string containing attributes. + * Builds an attribute list from string containing attributes. * * This function does a lot of work. It parses an attribute list into an array * with attribute data, and tries to do the right thing even if it gets weird @@ -660,7 +660,7 @@ } /** - * wp_kses_check_attr_val() - Performs different checks for attribute values. + * Performs different checks for attribute values. * * The currently implemented checks are "maxlen", "minlen", "maxval", "minval" * and "valueless" with even more checks to come soon. @@ -732,12 +732,12 @@ } /** - * wp_kses_bad_protocol() - Sanitize string from bad protocols + * Sanitize string from bad protocols. * - * This function removes all non-allowed protocols from the beginning - * of $string. It ignores whitespace and the case of the letters, and - * it does understand HTML entities. It does its work in a while loop, - * so it won't be fooled by a string like "javascript:javascript:alert(57)". + * This function removes all non-allowed protocols from the beginning of + * $string. It ignores whitespace and the case of the letters, and it does + * understand HTML entities. It does its work in a while loop, so it won't be + * fooled by a string like "javascript:javascript:alert(57)". * * @since 1.0.0 * @@ -759,7 +759,7 @@ } /** - * wp_kses_no_null() - Removes any NULL characters in $string. + * Removes any NULL characters in $string. * * @since 1.0.0 * @@ -774,11 +774,11 @@ } /** - * wp_kses_stripslashes() - Strips slashes from in front of quotes + * Strips slashes from in front of quotes. * - * This function changes the character sequence \" to just " - * It leaves all other slashes alone. It's really weird, but the - * quoting from preg_replace(//e) seems to require this. + * This function changes the character sequence \" to just ". It leaves all + * other slashes alone. It's really weird, but the quoting from + * preg_replace(//e) seems to require this. * * @since 1.0.0 * @@ -790,7 +790,7 @@ } /** - * wp_kses_array_lc() - Goes through an array and changes the keys to all lower case. + * Goes through an array and changes the keys to all lower case. * * @since 1.0.0 * @@ -814,7 +814,7 @@ } /** - * wp_kses_js_entities() - Removes the HTML JavaScript entities found in early versions of Netscape 4. + * Removes the HTML JavaScript entities found in early versions of Netscape 4. * * @since 1.0.0 * @@ -826,10 +826,10 @@ } /** - * wp_kses_html_error() - Handles parsing errors in wp_kses_hair() + * Handles parsing errors in wp_kses_hair(). * - * The general plan is to remove everything to and including some - * whitespace, but it deals with quotes and apostrophes as well. + * The general plan is to remove everything to and including some whitespace, + * but it deals with quotes and apostrophes as well. * * @since 1.0.0 * @@ -841,10 +841,10 @@ } /** - * wp_kses_bad_protocol_once() - Sanitizes content from bad protocols and other characters + * Sanitizes content from bad protocols and other characters. * - * This function searches for URL protocols at the beginning of $string, - * while handling whitespace and HTML entities. + * This function searches for URL protocols at the beginning of $string, while + * handling whitespace and HTML entities. * * @since 1.0.0 * @@ -866,7 +866,7 @@ } /** - * wp_kses_bad_protocol_once2() - Callback for wp_kses_bad_protocol_once() regular expression. + * Callback for wp_kses_bad_protocol_once() regular expression. * * This function processes URL protocols, checks to see if they're in the * white-list or not, and returns different data depending on the answer. @@ -910,11 +910,10 @@ } /** - * wp_kses_normalize_entities() - Converts and fixes HTML entities + * Converts and fixes HTML entities. * - * This function normalizes HTML entities. It will convert "AT&T" to the - * correct "AT&T", ":" to ":", "&#XYZZY;" to "&#XYZZY;" - * and so on. + * This function normalizes HTML entities. It will convert "AT&T" to the correct + * "AT&T", ":" to ":", "&#XYZZY;" to "&#XYZZY;" and so on. * * @since 1.0.0 * @@ -936,10 +935,10 @@ } /** - * wp_kses_normalize_entities2() - Callback for wp_kses_normalize_entities() regular expression + * Callback for wp_kses_normalize_entities() regular expression. * - * This function helps wp_kses_normalize_entities() to only accept 16 bit - * values and nothing more for &#number; entities. + * This function helps wp_kses_normalize_entities() to only accept 16 bit values + * and nothing more for &#number; entities. * * @access private * @since 1.0.0 @@ -956,10 +955,10 @@ } /** - * wp_kses_normalize_entities3() - Callback for wp_kses_normalize_entities() for regular expression + * Callback for wp_kses_normalize_entities() for regular expression. * - * This function helps wp_kses_normalize_entities() to only accept valid Unicode numeric entities - * in hex form. + * This function helps wp_kses_normalize_entities() to only accept valid Unicode + * numeric entities in hex form. * * @access private * @@ -975,7 +974,7 @@ } /** - * valid_unicode() - Helper function to determine if a Unicode value is valid. + * Helper function to determine if a Unicode value is valid. * * @param int $i Unicode value * @return bool true if the value was a valid Unicode number @@ -988,11 +987,11 @@ } /** - * wp_kses_decode_entities() - Convert all entities to their character counterparts. + * Convert all entities to their character counterparts. * - * This function decodes numeric HTML entities (A and A). It - * doesn't do anything with other entities like ä, but we don't need - * them in the URL protocol whitelisting system anyway. + * This function decodes numeric HTML entities (A and A). It doesn't do + * anything with other entities like ä, but we don't need them in the URL + * protocol whitelisting system anyway. * * @since 1.0.0 * @@ -1007,7 +1006,7 @@ } /** - * wp_filter_kses() - Sanitize content with allowed HTML Kses rules + * Sanitize content with allowed HTML Kses rules. * * @since 1.0.0 * @uses $allowedtags @@ -1021,10 +1020,10 @@ } /** - * wp_filter_post_kses() - Sanitize content for allowed HTML tags for post content + * Sanitize content for allowed HTML tags for post content. * - * Post content refers to the page contents of the 'post' type and not - * $_POST data from forms. + * Post content refers to the page contents of the 'post' type and not $_POST + * data from forms. * * @since 2.0.0 * @uses $allowedposttags @@ -1038,7 +1037,7 @@ } /** - * wp_filter_nohtml_kses() - Strips all of the HTML in the content + * Strips all of the HTML in the content. * * @since 2.1.0 * @@ -1050,14 +1049,14 @@ } /** - * kses_init_filters() - Adds all Kses input form content filters + * Adds all Kses input form content filters. * - * All hooks have default priority. The wp_filter_kses() fucntion - * is added to the 'pre_comment_content' and 'title_save_pre' - * hooks. The wp_filter_post_kses() function is added to the - * 'content_save_pre', 'excerpt_save_pre', and 'content_filtered_save_pre' - * hooks. + * All hooks have default priority. The wp_filter_kses() function is added to + * the 'pre_comment_content' and 'title_save_pre' hooks. * + * The wp_filter_post_kses() function is added to the 'content_save_pre', + * 'excerpt_save_pre', and 'content_filtered_save_pre' hooks. + * * @since 2.0.0 * @uses add_filter() See description for what functions are added to what hooks. */ @@ -1073,15 +1072,14 @@ } /** - * kses_remove_filters() - Removes all Kses input form content filters + * Removes all Kses input form content filters. * - * A quick procedural method to removing all of the filters - * that kses uses for content in WordPress Loop. + * A quick procedural method to removing all of the filters that kses uses for + * content in WordPress Loop. * - * Does not remove the kses_init() function from 'init' hook - * (priority is default). Also does not remove kses_init() - * function from 'set_current_user' hook (priority is also - * default). + * Does not remove the kses_init() function from 'init' hook (priority is + * default). Also does not remove kses_init() function from 'set_current_user' + * hook (priority is also default). * * @since 2.0.6 */ @@ -1097,15 +1095,15 @@ } /** - * kses_init() - Sets up most of the Kses filters for input form content + * Sets up most of the Kses filters for input form content. * * If you remove the kses_init() function from 'init' hook and - * 'set_current_user' (priority is default), then none of the - * Kses filter hooks will be added. + * 'set_current_user' (priority is default), then none of the Kses filter hooks + * will be added. * - * First removes all of the Kses filters in case the current user - * does not need to have Kses filter the content. If the user does - * not have unfiltered html capability, then Kses filters are added. + * First removes all of the Kses filters in case the current user does not need + * to have Kses filter the content. If the user does not have unfiltered html + * capability, then Kses filters are added. * * @uses kses_remove_filters() Removes the Kses filters * @uses kses_init_filters() Adds the Kses filters back if the user @@ -1121,4 +1119,5 @@ add_action('init', 'kses_init'); add_action('set_current_user', 'kses_init'); + ?> Index: l10n.php =================================================================== --- l10n.php (revision 8674) +++ l10n.php (working copy) @@ -7,25 +7,23 @@ */ /** - * get_locale() - Gets the current locale + * Gets the current locale. * - * If the locale is set, then it will filter the locale - * in the 'locale' filter hook and return the value. + * If the locale is set, then it will filter the locale in the 'locale' filter + * hook and return the value. * - * If the locale is not set already, then the WPLANG - * constant is used if it is defined. Then it is filtered - * through the 'locale' filter hook and the value for the - * locale global set and the locale is returned. + * If the locale is not set already, then the WPLANG constant is used if it is + * defined. Then it is filtered through the 'locale' filter hook and the value + * for the locale global set and the locale is returned. * - * The process to get the locale should only be done once - * but the locale will always be filtered using the - * 'locale' hook. + * The process to get the locale should only be done once but the locale will + * always be filtered using the 'locale' hook. * * @since 1.5.0 - * @uses apply_filters() Calls 'locale' hook on locale value - * @uses $locale Gets the locale stored in the global + * @uses apply_filters() Calls 'locale' hook on locale value. + * @uses $locale Gets the locale stored in the global. * - * @return string The locale of the blog or from the 'locale' hook + * @return string The locale of the blog or from the 'locale' hook. */ function get_locale() { global $locale; @@ -46,22 +44,21 @@ } /** - * translate() - Retrieve the translated text + * Retrieve the translated text. * - * If the domain is set in the $l10n global, then the text is run - * through the domain's translate method. After it is passed to - * the 'gettext' filter hook, along with the untranslated text as - * the second parameter. + * If the domain is set in the $l10n global, then the text is run through the + * domain's translate method. After it is passed to the 'gettext' filter hook, + * along with the untranslated text as the second parameter. * * If the domain is not set, the $text is just returned. * * @since 2.2.0 - * @uses $l10n Gets list of domain translated string (gettext_reader) objects + * @uses $l10n Gets list of domain translated string (gettext_reader) objects. * @uses apply_filters() Calls 'gettext' on domain translated text - * with the untranslated text as second parameter + * with the untranslated text as second parameter. * - * @param string $text Text to translate - * @param string $domain Domain to retrieve the translated text + * @param string $text Text to translate. + * @param string $domain Domain to retrieve the translated text. * @return string Translated text */ function translate($text, $domain = 'default') { @@ -74,12 +71,11 @@ } /** - * translate_with_context() - Retrieve the translated text and strip context + * Retrieve the translated text and strip context. * - * If the domain is set in the $l10n global, then the text is run - * through the domain's translate method. After it is passed to - * the 'gettext' filter hook, along with the untranslated text as - * the second parameter. + * If the domain is set in the $l10n global, then the text is run through the + * domain's translate method. After it is passed to the 'gettext' filter hook, + * along with the untranslated text as the second parameter. * * If the domain is not set, the $text is just returned. * @@ -101,11 +97,8 @@ } /** - * __() - Retrieve a translated string + * Retrieves the translated string from the translate(). * - * __() is a convenience function which retrieves the translated - * string from the translate(). - * * @see translate() An alias of translate() * @since 2.1.0 * @@ -117,13 +110,9 @@ return translate($text, $domain); } -// . /** - * _e() - Display a translated string + * Displays the returned translated text from translate(). * - * _e() is a convenience function which displays the returned - * translated text from translate(). - * * @see translate() Echos returned translate() string * @since 1.2.0 * @@ -135,20 +124,17 @@ } /** - * _c() - Retrieve context translated string + * Retrieve context translated string. * - * Quite a few times, there will be collisions with similar - * translatable text found in more than two places but with - * different translated context. + * Quite a few times, there will be collisions with similar translatable text + * found in more than two places but with different translated context. * - * In order to use the separate contexts, the _c() function - * is used and the translatable string uses a pipe ('|') - * which has the context the string is in. + * In order to use the separate contexts, the _c() function is used and the + * translatable string uses a pipe ('|') which has the context the string is in. * - * When the translated string is returned, it is everything - * before the pipe, not including the pipe character. If - * there is no pipe in the translated text then everything - * is returned. + * When the translated string is returned, it is everything before the pipe, not + * including the pipe character. If there is no pipe in the translated text then + * everything is returned. * * @since 2.2.0 * @@ -161,15 +147,15 @@ } /** - * __ngettext() - Retrieve the plural or single form based on the amount + * Retrieve the plural or single form based on the amount. * - * If the domain is not set in the $l10n list, then a comparsion - * will be made and either $plural or $single parameters returned. + * If the domain is not set in the $l10n list, then a comparsion will be made + * and either $plural or $single parameters returned. * - * If the domain does exist, then the parameters $single, $plural, - * and $number will first be passed to the domain's ngettext method. - * Then it will be passed to the 'ngettext' filter hook along with - * the same parameters. The expected type will be a string. + * If the domain does exist, then the parameters $single, $plural, and $number + * will first be passed to the domain's ngettext method. Then it will be passed + * to the 'ngettext' filter hook along with the same parameters. The expected + * type will be a string. * * @since 1.2.0 * @uses $l10n Gets list of domain translated string (gettext_reader) objects @@ -196,7 +182,7 @@ } /** - * __ngettext_noop() - register plural strings in POT file, but don't translate them + * Register plural strings in POT file, but don't translate them. * * Used when you want do keep structures with translatable plural strings and * use them later. @@ -222,13 +208,13 @@ } /** - * load_textdomain() - Loads MO file into the list of domains + * Loads MO file into the list of domains. * - * If the domain already exists, the inclusion will fail. If the - * MO file is not readable, the inclusion will fail. + * If the domain already exists, the inclusion will fail. If the MO file is not + * readable, the inclusion will fail. * - * On success, the mofile will be placed in the $l10n global by - * $domain and will be an gettext_reader object. + * On success, the mofile will be placed in the $l10n global by $domain and will + * be an gettext_reader object. * * @since 1.5.0 * @uses $l10n Gets list of domain translated string (gettext_reader) objects @@ -260,10 +246,10 @@ } /** - * load_default_textdomain() - Loads default translated strings based on locale + * Loads default translated strings based on locale. * - * Loads the .mo file in WP_LANG_DIR constant path from WordPress root. - * The translated (.mo) file is named based off of the locale. + * Loads the .mo file in WP_LANG_DIR constant path from WordPress root. The + * translated (.mo) file is named based off of the locale. * * @since 1.5.0 */ @@ -276,11 +262,11 @@ } /** - * load_plugin_textdomain() - Loads the plugin's translated strings + * Loads the plugin's translated strings. * - * If the path is not given then it will be the root of the plugin - * directory. The .mo file should be named based on the domain with a - * dash followed by a dash, and then the locale exactly. + * If the path is not given then it will be the root of the plugin directory. + * The .mo file should be named based on the domain with a dash followed by a + * dash, and then the locale exactly. * * @since 1.5.0 * @@ -304,7 +290,7 @@ } /** - * load_theme_textdomain() - Includes theme's translated strings for the theme + * Loads the theme's translated strings. * * If the current locale exists as a .mo file in the theme's root directory, it * will be included in the translated strings by the $domain. Index: locale.php =================================================================== --- locale.php (revision 8674) +++ locale.php (working copy) @@ -7,10 +7,8 @@ */ /** - * {@internal Missing Short Description}} + * Class that loads the calendar locale. * - * {@internal Missing Long Description}} - * * @since 2.1.0 */ class WP_Locale { Index: plugin.php =================================================================== --- plugin.php (revision 8674) +++ plugin.php (working copy) @@ -11,8 +11,8 @@ * {@link http://us2.php.net/manual/en/language.pseudo-types.php#language.types.callback 'callback'} * type are valid. * - * Also see the {@link http://codex.wordpress.org/Plugin_API Plugin API} for more information - * and examples on how to use a lot of these functions. + * Also see the {@link http://codex.wordpress.org/Plugin_API Plugin API} for + * more information and examples on how to use a lot of these functions. * * @package WordPress * @subpackage Plugin @@ -27,24 +27,27 @@ * can specify that one or more of its PHP functions is executed to * modify specific types of text at these times, using the Filter API. * - * To use the API, the following code should be used to bind a callback to the filter + * To use the API, the following code should be used to bind a callback to the + * filter. + * * * function example_hook($example) { echo $example; } - * * add_filter('example_filter', 'example_hook'); * * - * In WordPress 1.5.1+, hooked functions can take extra arguments that are set when - * the matching do_action() or apply_filters() call is run. The $accepted_args - * allow for calling functions only when the number of args match. Hooked functions - * can take extra arguments that are set when the matching do_action() or - * apply_filters() call is run. For example, the action comment_id_not_found - * will pass any functions that hook onto it the ID of the requested comment. + * In WordPress 1.5.1+, hooked functions can take extra arguments that are set + * when the matching do_action() or apply_filters() call is run. The + * $accepted_args allow for calling functions only when the number of args + * match. Hooked functions can take extra arguments that are set when the + * matching do_action() or apply_filters() call is run. For example, the action + * comment_id_not_found will pass any functions that hook onto it the ID of the + * requested comment. * - * Note: the function will return true no matter if the function was hooked - * fails or not. There are no checks for whether the function exists beforehand and no checks - * to whether the $function_to_add is even a string. It is up to you to take care and - * this is done for optimization purposes, so everything is as quick as possible. + * Note: the function will return true no matter if the + * function was hooked fails or not. There are no checks for whether the + * function exists beforehand and no checks to whether the $function_to_add + * is even a string. It is up to you to take care and this is done for + * optimization purposes, so everything is as quick as possible. * * @package WordPress * @subpackage Plugin @@ -53,7 +56,7 @@ * wp_filter['tag']['array of priorities']['array of functions serialized']['array of ['array (functions, accepted_args)]'] * @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. * - * @param string $tag The name of the filter to hook the $function_to_add to. + * @param string $tag The name of the filter to hook the $function_to_add to. * @param callback $function_to_add The name of the function to be called when the filter is applied. * @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. * @param int $accepted_args optional. The number of arguments the function accept (default 1). @@ -101,10 +104,10 @@ /** * Call the functions added to a filter hook. * - * The callback functions attached to filter hook $tag are invoked by - * calling this function. This function can be used to create a new filter hook - * by simply calling this function with the name of the new hook specified using - * the $tag parameter. + * The callback functions attached to filter hook $tag are invoked by calling + * this function. This function can be used to create a new filter hook by + * simply calling this function with the name of the new hook specified using + * the $tag parameter. * * The function allows for additional arguments to be added and passed to hooks. * @@ -232,7 +235,7 @@ } /** - * Return the name of the current filter or action. + * Retrieve the name of the current filter or action. * * @package WordPress * @subpackage Plugin @@ -260,7 +263,7 @@ * @subpackage Plugin * @since 1.2 * - * @param string $tag The name of the action to which the $function_to-add is hooked. + * @param string $tag The name of the action to which the $function_to_add is hooked. * @param callback $function_to_add The name of the function you wish to be called. * @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. * @param int $accepted_args optional. The number of arguments the function accept (default 1). @@ -273,14 +276,15 @@ /** * Execute functions hooked on a specific action hook. * - * This function invokes all functions attached to action hook $tag. - * It is possible to create new action hooks by simply calling this function, + * This function invokes all functions attached to action hook $tag. It is + * possible to create new action hooks by simply calling this function, * specifying the name of the new hook using the $tag parameter. * - * You can pass extra arguments to the hooks, much like you can with apply_filters(). + * You can pass extra arguments to the hooks, much like you can with + * apply_filters(). * - * @see apply_filters() This function works similar with the exception that nothing is - * returned and only the functions or methods are called. + * @see apply_filters() This function works similar with the exception that + * nothing is returned and only the functions or methods are called. * * @package WordPress * @subpackage Plugin @@ -340,7 +344,7 @@ } /** - * Return the number times an action is fired. + * Retrieve the number times an action is fired. * * @package WordPress * @subpackage Plugin @@ -362,8 +366,8 @@ /** * Execute functions hooked on a specific action hook, specifying arguments in an array. * - * @see do_action() This function is identical, but the arguments passed to - * the functions hooked to $tag are supplied using an array. + * @see do_action() This function is identical, but the arguments passed to the + * functions hooked to $tag are supplied using an array. * * @package WordPress * @subpackage Plugin @@ -498,10 +502,10 @@ * When a plugin is activated, the action 'activate_PLUGINNAME' hook is * activated. In the name of this hook, PLUGINNAME is replaced with the name of * the plugin, including the optional subdirectory. For example, when the plugin - * is located in wp-content/plugin/sampleplugin/sample.php, then the - * name of this hook will become 'activate_sampleplugin/sample.php' - * When the plugin consists of only one file and is (as by default) located at - * wp-content/plugin/sample.php the name of this hook will be + * is located in wp-content/plugin/sampleplugin/sample.php, then the name of + * this hook will become 'activate_sampleplugin/sample.php'. When the plugin + * consists of only one file and is (as by default) located at + * wp-content/plugin/sample.php the name of this hook will be * 'activate_sample.php'. * * @package WordPress @@ -524,11 +528,11 @@ * When a plugin is deactivated, the action 'deactivate_PLUGINNAME' hook is * deactivated. In the name of this hook, PLUGINNAME is replaced with the name * of the plugin, including the optional subdirectory. For example, when the - * plugin is located in wp-content/plugin/sampleplugin/sample.php, then + * plugin is located in wp-content/plugin/sampleplugin/sample.php, then * the name of this hook will become 'activate_sampleplugin/sample.php'. * * When the plugin consists of only one file and is (as by default) located at - * wp-content/plugin/sample.php the name of this hook will be + * wp-content/plugin/sample.php the name of this hook will be * 'activate_sample.php'. * * @package WordPress @@ -631,12 +635,10 @@ * * @package WordPress * @subpackage Plugin + * @access private * @since 2.2.3 - * * @link http://trac.wordpress.org/ticket/3875 * - * @access private - * * @global array $wp_filter Storage for all of the filters and actions * @param string $tag Used in counting how many hooks were applied * @param string|array $function Used for creating unique id Index: taxonomy.php =================================================================== --- taxonomy.php (revision 8674) +++ taxonomy.php (working copy) @@ -1,8 +1,10 @@