Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-12-22 17:18:32 +01:00
Code Issues Projects Releases Wiki Activity

Remove redundant and erroneous @uses tag from most core inline documentation.

Browse Source 
Per our inline documentation standards, no further use of the `@uses` tag is recommended as used and used-by relationships can be derived through other means. This removes most uses of the tag in core documentation, with remaining tags to be converted to `@global` or `@see` as they apply.

Fixes #30191.

Built from https://develop.svn.wordpress.org/trunk@30105


git-svn-id: http://core.svn.wordpress.org/trunk@30105 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-10-30 01:05:24 +00:00
parent 00845a6c3d
commit f8657d5890
48 changed files with 1 additions and 366 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
wp-admin/includes/class-wp-list-table.php
View File

@ -184,7 +184,6 @@ class WP_List_Table {
/**
* Checks the current user's permissions
* @uses wp_die()
*
* @since 3.1.0
* @access public

4
wp-admin/includes/class-wp-themes-list-table.php
View File

@ -255,10 +255,6 @@ class WP_Themes_List_Table extends WP_List_Table {
*
* @since 3.4.0
* @access public
*
* @uses $this->features Array of all feature search terms.
* @uses get_pagenum()
* @uses _pagination_args['total_pages']
*/
public function _js_vars( $extra_args = array() ) {
$search_string = isset( $_REQUEST['s'] ) ? esc_attr( wp_unslash( $_REQUEST['s'] ) ) : '';

4
wp-admin/includes/file.php
View File

@ -50,7 +50,6 @@ $wp_file_descriptions = array(
*
* @since 1.5.0
*
* @uses _cleanup_header_comment
* @uses $wp_file_descriptions
* @param string $file Filesystem path or filename
* @return string Description of file from $wp_file_descriptions or basename of $file if description doesn't exist
@ -75,7 +74,6 @@ function get_file_description( $file ) {
*
* @since 1.5.0
*
* @uses get_option
* @return string Full filesystem path to the root of the WordPress installation
*/
function get_home_path() {
@ -163,8 +161,6 @@ function wp_tempnam($filename = '', $dir = '') {
*
* @since 1.5.0
*
* @uses wp_die
* @uses validate_file
* @param string $file file the users is attempting to edit
* @param array $allowed_files Array of allowed files to edit, $file must match an entry exactly
* @return null

3
wp-admin/includes/ms.php
View File

@ -395,9 +395,6 @@ function display_space_usage() {
* Get the remaining upload space for this blog.
*
* @since MU
* @uses upload_is_user_over_quota()
* @uses get_space_allowed()
* @uses get_upload_space_available()
*
* @param int $size Current max size in bytes
* @return int Max size in bytes

4
wp-admin/includes/nav-menu.php
View File

@ -550,7 +550,6 @@ function wp_nav_menu_taxonomy_meta_boxes() {
* @since 3.6.0
*
* @uses global $one_theme_location_no_menus to determine if no menus exist
* @uses disabled() to output the disabled attribute in $other_attributes param in submit_button()
*
* @param int|string $nav_menu_selected_id (id, name or slug) of the currently-selected menu
* @return string Disabled attribute if at least one menu exists, false if not
@ -1247,9 +1246,6 @@ add_action('admin_head-nav-menus.php', '_wp_delete_orphaned_draft_menu_items');
*
* @since 3.6.0
*
* @uses wp_get_nav_menu_items() to retrieve the nav menu's menu items
* @uses wp_defer_term_counter() to enable then disable term counting
*
* @param int|string $nav_menu_selected_id (id, slug, or name ) of the currently-selected menu
* @param string $nav_menu_selected_title Title of the currently-selected menu
* @return array $messages The menu updated message

13
wp-admin/includes/post.php
View File

@ -1069,7 +1069,6 @@ function wp_edit_attachments_query( $q = false ) {
/**
* Returns the list of classes to be used by a metabox
*
* @uses get_user_option()
* @since 2.5.0
*
* @param unknown_type $id
@ -1500,9 +1499,6 @@ function _admin_notice_post_locked() {
* @subpackage Post_Revisions
* @since 2.6.0
*
* @uses _wp_translate_postdata()
* @uses _wp_post_revision_fields()
*
* @param mixed $post_data Associative array containing the post data or int post ID.
* @return mixed The autosave revision ID. WP_Error or 0 on error.
*/
@ -1566,15 +1562,6 @@ function wp_create_post_autosave( $post_data ) {
* @package WordPress
* @since 2.7.0
*
* @uses get_post_status()
* @uses edit_post()
* @uses get_post()
* @uses current_user_can()
* @uses wp_die()
* @uses wp_create_post_autosave()
* @uses add_query_arg()
* @uses wp_create_nonce()
*
* @return str URL to redirect to show the preview
*/
function post_preview() {

1
wp-admin/includes/screen.php
View File

@ -177,7 +177,6 @@ function get_current_screen() {
* Set the current screen object
*
* @since 3.0.0
* @uses $current_screen
*
* @param mixed $hook_name Optional. The hook name (also known as the hook suffix) used to determine the screen,
* or an existing screen object.

2
wp-admin/includes/template.php
View File

@ -1466,7 +1466,6 @@ function find_posts_div($found_action = '') {
* The password is passed through {@link esc_attr()} to ensure that it
* is safe for placing in an html attribute.
*
* @uses attr
* @since 2.7.0
*/
function the_post_password() {
@ -1499,7 +1498,6 @@ function _draft_or_post_title( $post = 0 ) {
* A simple wrapper to display the "s" parameter in a GET URI. This function
* should only be used when {@link the_search_query()} cannot.
*
* @uses attr
* @since 2.7.0
*
*/

17
wp-includes/author-template.php
View File

@ -16,7 +16,6 @@
* @since 1.5.0
*
* @uses $authordata The current author's DB object.
* @uses apply_filters() Calls 'the_author' hook on the author display name.
*
* @param string $deprecated Deprecated.
* @return string The author's display name.
@ -71,10 +70,6 @@ function the_author( $deprecated = '', $deprecated_echo = true ) {
*
* @since 2.8.0
*
* @uses $post The current post's DB object.
* @uses get_post_meta() Retrieves the ID of the author who last edited the current post.
* @uses get_userdata() Retrieves the author's DB object.
* @uses apply_filters() Calls 'the_modified_author' hook on the author display name.
* @return string The author's display name.
*/
function get_the_modified_author() {
@ -108,7 +103,6 @@ function the_modified_author() {
* Retrieve the requested data of the author of the current post.
* @link http://codex.wordpress.org/Template_Tags/the_author_meta
* @since 2.8.0
* @uses $authordata The current author's DB object (if $user_id not specified).
* @param string $field selects the field of the users record.
* @param int $user_id Optional. User ID.
* @return string The author's field from the current author's DB object.
@ -168,9 +162,6 @@ function the_author_meta( $field = '', $user_id = false ) {
*
* If the author has a home page set, return an HTML link, otherwise just return the
* author's name.
*
* @uses get_the_author_meta()
* @uses get_the_author()
*/
function get_the_author_link() {
if ( get_the_author_meta('url') ) {
@ -189,8 +180,6 @@ function get_the_author_link() {
* @link http://codex.wordpress.org/Template_Tags/the_author_link
*
* @since 2.1.0
*
* @uses get_the_author_link()
*/
function the_author_link() {
echo get_the_author_link();
@ -201,8 +190,6 @@ function the_author_link() {
*
* @since 1.5.0
*
* @uses $post The current post in the Loop's DB object.
* @uses count_user_posts()
* @return int The number of posts by the author.
*/
function get_the_author_posts() {
@ -218,7 +205,6 @@ function get_the_author_posts() {
*
* @link http://codex.wordpress.org/Template_Tags/the_author_posts
* @since 0.71
* @uses get_the_author_posts() Echoes returned value from function.
*/
function the_author_posts() {
echo get_the_author_posts();
@ -233,9 +219,6 @@ function the_author_posts() {
*
* @link http://codex.wordpress.org/Template_Tags/the_author_posts_link
* @since 1.2.0
* @uses $authordata The current author's DB object.
* @uses get_author_posts_url()
* @uses get_the_author()
* @param string $deprecated Deprecated.
*/
function the_author_posts_link($deprecated = '') {

3
wp-includes/bookmark.php
View File

@ -60,8 +60,6 @@ function get_bookmark($bookmark, $output = OBJECT, $filter = 'raw') {
* Retrieve single bookmark data item or field.
*
* @since 2.3.0
* @uses get_bookmark() Gets bookmark object using $bookmark as ID
* @uses sanitize_bookmark_field() Sanitizes Bookmark field based on $context.
*
* @param string $field The name of the data field to return
* @param int $bookmark The bookmark ID to get field
@ -407,7 +405,6 @@ function sanitize_bookmark_field($field, $value, $bookmark_id, $context) {
* Deletes bookmark cache
*
* @since 2.7.0
* @uses wp_cache_delete() Deletes the contents of 'get_bookmarks'
*/
function clean_bookmark_cache( $bookmark_id ) {
wp_cache_delete( $bookmark_id, 'bookmark' );

2
wp-includes/category-template.php
View File

@ -66,7 +66,6 @@ function get_category_parents( $id, $link = false, $separator = '/', $nicename =
* Retrieve post categories.
*
* @since 0.71
* @uses $post
*
* @param int $id Optional, default to current post ID. The post ID.
* @return array
@ -248,7 +247,6 @@ function get_the_category_list( $separator = '', $parents='', $post_id = false )
* As of 2.7, the function can be used anywhere if it is provided a post ID or post object.
*
* @since 1.2.0
* @uses has_category()
*
* @param int|string|array $category Category ID, name or slug, or array of said.
* @param int|object $post Optional. Post to check instead of the current post. (since 2.7.0)

5
wp-includes/category.php
View File

@ -63,7 +63,6 @@ function get_categories( $args = '' ) {
* The category will converted to maintain backwards compatibility.
*
* @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
* @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
@ -210,7 +209,6 @@ function cat_is_ancestor_of( $cat1, $cat2 ) {
* Sanitizes category data based on context.
*
* @since 2.3.0
* @uses sanitize_term() See this function for what context are supported.
*
* @param object|array $category Category data
* @param string $context Optional. Default is 'display'.
@ -224,7 +222,6 @@ function sanitize_category( $category, $context = 'display' ) {
* Sanitizes data in single category key field.
*
* @since 2.3.0
* @uses sanitize_term_field() See function for more details.
*
* @param string $field Category key to sanitize
* @param mixed $value Category value to sanitize
@ -243,7 +240,6 @@ function sanitize_category_field( $field, $value, $cat_id, $context ) {
*
* @since 2.3.0
* @see get_terms() For list of arguments to pass.
* @uses apply_filters() Calls 'get_tags' hook on array of tags and with $args.
*
* @param string|array $args Tag arguments to use when retrieving tags.
* @return array List of tags.
@ -297,7 +293,6 @@ function get_tag( $tag, $output = OBJECT, $filter = 'raw' ) {
* Remove the category cache data based on ID.
*
* @since 2.1.0
* @uses clean_term_cache() Clears the cache for the category based on ID
*
* @param int $id Category ID
*/

1
wp-includes/class-http.php
View File

@ -1785,7 +1785,6 @@ class WP_HTTP_Proxy {
* some proxies can not handle this. We also have the constant available for defining other
* hosts that won't be sent through the proxy.
*
* @uses WP_PROXY_BYPASS_HOSTS
* @since 2.8.0
*
* @param string $uri URI to check.

1
wp-includes/class-oembed.php
View File

@ -565,7 +565,6 @@ class WP_oEmbed {
* @access private
*
* @see WP_oEmbed
* @uses WP_oEmbed
*
* @return WP_oEmbed object.
*/

1
wp-includes/class-wp-customize-manager.php
View File

@ -1283,7 +1283,6 @@ function sanitize_hex_color( $color ) {
* Returns either '', a 3 or 6 digit hex color (without a #), or null.
*
* @since 3.4.0
* @uses sanitize_hex_color()
*
* @param string $color
* @return string|null

1
wp-includes/class-wp-customize-setting.php
View File

@ -556,7 +556,6 @@ final class WP_Customize_Background_Image_Setting extends WP_Customize_Setting {
/**
* @since 3.4.0
* @uses remove_theme_mod()
*
* @param $value
*/

16
wp-includes/class-wp-embed.php
View File

@ -43,9 +43,6 @@ class WP_Embed {
* calls {@link do_shortcode()}, and then re-registers the old shortcodes.
*
* @uses $shortcode_tags
* @uses remove_all_shortcodes()
* @uses add_shortcode()
* @uses do_shortcode()
*
* @param string $content Content to parse
* @return string Content with shortcode parsed
@ -122,17 +119,6 @@ class WP_Embed {
* Attempts to convert a URL into embed HTML. Starts by checking the URL against the regex of the registered embed handlers.
* If none of the regex matches and it's enabled, then the URL will be given to the {@link WP_oEmbed} class.
*
* @uses wp_oembed_get()
* @uses wp_parse_args()
* @uses wp_embed_defaults()
* @uses WP_Embed::maybe_make_link()
* @uses get_option()
* @uses author_can()
* @uses wp_cache_get()
* @uses wp_cache_set()
* @uses get_post_meta()
* @uses update_post_meta()
*
* @param array $attr {
* Shortcode attributes. Optional.
*
@ -332,8 +318,6 @@ class WP_Embed {
/**
* Callback function for {@link WP_Embed::autoembed()}.
*
* @uses WP_Embed::shortcode()
*
* @param array $match A regex match array.
* @return string The embed HTML on success, otherwise the original URL.
*/

2
wp-includes/class-wp-theme.php
View File

@ -855,8 +855,6 @@ final class WP_Theme implements ArrayAccess {
* for all other URLs returned by WP_Theme, so we pass it to the public function
* get_theme_root_uri() and allow it to run the theme_root_uri filter.
*
* @uses get_theme_root_uri()
*
* @since 3.4.0
* @access public
*

1
wp-includes/class-wp.php
View File

@ -532,7 +532,6 @@ class WP {
/**
* Set up the Loop based on the query variables.
*
* @uses WP::$query_vars
* @since 2.0.0
*/
public function query_posts() {

14
wp-includes/comment.php
View File

@ -853,7 +853,6 @@ function get_comment_count( $post_id = 0 ) {
* Add meta data field to a comment.
*
* @since 2.9.0
* @uses add_metadata
* @link http://codex.wordpress.org/Function_Reference/add_comment_meta
*
* @param int $comment_id Comment ID.
@ -874,7 +873,6 @@ function add_comment_meta($comment_id, $meta_key, $meta_value, $unique = false)
* allows removing all metadata matching key, if needed.
*
* @since 2.9.0
* @uses delete_metadata
* @link http://codex.wordpress.org/Function_Reference/delete_comment_meta
*
* @param int $comment_id comment ID
@ -890,7 +888,6 @@ function delete_comment_meta($comment_id, $meta_key, $meta_value = '') {
* Retrieve comment meta field for a comment.
*
* @since 2.9.0
* @uses get_metadata
* @link http://codex.wordpress.org/Function_Reference/get_comment_meta
*
* @param int $comment_id Comment ID.
@ -912,7 +909,6 @@ function get_comment_meta($comment_id, $key = '', $single = false) {
* If the meta field for the comment does not exist, it will be added.
*
* @since 2.9.0
* @uses update_metadata
* @link http://codex.wordpress.org/Function_Reference/update_comment_meta
*
* @param int $comment_id Comment ID.
@ -1250,9 +1246,6 @@ function get_comment_pages_count( $comments = null, $per_page = null, $threaded
* Calculate what page number a comment will appear on for comment paging.
*
* @since 2.7.0
* @uses get_comment() Gets the full comment of the $comment_ID parameter.
* @uses get_option() Get various settings to control function and defaults.
* @uses get_page_of_comment() Used to loop up to top level comment.
*
* @param int $comment_ID Comment ID.
* @param array $args Optional args.
@ -1440,7 +1433,6 @@ function wp_count_comments( $post_id = 0 ) {
*
* @since 2.0.0
* @uses $wpdb
* @uses wp_transition_comment_status() Passes new and old comment status along with $comment object
*
* @param int $comment_id Comment ID
* @param bool $force_delete Whether to bypass trash and force deletion. Default is false.
@ -1507,8 +1499,6 @@ function wp_delete_comment($comment_id, $force_delete = false) {
*
* @since 2.9.0
*
* @uses wp_delete_comment() if trash is disabled
*
* @param int $comment_id Comment ID.
* @return bool True on success, false on failure.
*/
@ -2043,7 +2033,6 @@ function wp_new_comment( $commentdata ) {
* If the comment status is not in the list, then false is returned.
*
* @since 1.0.0
* @uses wp_transition_comment_status() Passes new and old comment status along with $comment object
*
* @param int $comment_id Comment ID.
* @param string $comment_status New comment status, either 'hold', 'approve', 'spam', or 'trash'.
@ -2114,7 +2103,6 @@ function wp_set_comment_status($comment_id, $comment_status, $wp_error = false)
*
* @since 2.0.0
* @uses $wpdb
* @uses wp_transition_comment_status() Passes new and old comment status along with $comment object
*
* @param array $commentarr Contains information on the comment.
* @return int Comment was updated if value is 1, or was not updated if value is 0.
@ -2466,7 +2454,6 @@ function generic_ping( $post_id = 0 ) {
*
* @since 0.71
* @uses $wp_version
* @uses IXR_Client
*
* @param string $content Post content to check for links.
* @param int $post_ID Post ID.
@ -2609,7 +2596,6 @@ function trackback($trackback_url, $title, $excerpt, $ID) {
*
* @since 1.2.0
* @uses $wp_version
* @uses IXR_Client
*
* @param string $server Host of blog to connect to.
* @param string $path Path to send the ping.

4
wp-includes/deprecated.php
View File

@ -1699,7 +1699,6 @@ function the_author_ID() {
* and the rest of the content will be removed.
*
* @since 0.71
* @uses apply_filters() Calls 'the_content_rss' on the content before processing.
*
* @deprecated 2.9.0
* @deprecated Use the_content_feed()
@ -1807,7 +1806,6 @@ function _c( $text, $domain = 'default' ) {
* contains a context after its last vertical bar.
*
* @since 2.5.0
* @uses translate()
* @deprecated 3.0.0
* @deprecated Use _x()
* @see _x()
@ -3152,8 +3150,6 @@ function update_page_cache( &$pages ) {
* @since 2.0.0
* @deprecated 3.4.0
*
* @uses do_action() Will call the 'clean_page_cache' hook action.
*
* @param int $id Page ID to clean
*/
function clean_page_cache( $id ) {

8
wp-includes/feed.php
View File

@ -71,7 +71,6 @@ function bloginfo_rss($show = '') {
* 'default_feed' filter.
*
* @since 2.5.0
* @uses apply_filters() Calls 'default_feed' hook on the default feed string.
*
* @return string Default feed, or for example 'rss2', 'atom', etc.
*/
@ -165,7 +164,6 @@ function get_the_title_rss() {
* Display the post title in the feed.
*
* @since 0.71
* @uses get_the_title_rss() Used to retrieve current post title.
*/
function the_title_rss() {
echo get_the_title_rss();
@ -203,8 +201,6 @@ function get_the_content_feed($feed_type = null) {
* Display the post content for feeds.
*
* @since 2.9.0
* @uses apply_filters() Calls 'the_content_feed' on the content before processing.
* @see get_the_content()
*
* @param string $feed_type The type of feed. rss2 | atom | rss | rdf
*/
@ -313,7 +309,6 @@ function comment_link() {
* Retrieve the current comment author for use in the feeds.
*
* @since 2.0.0
* @uses get_comment_author()
*
* @return string Comment Author
*/
@ -343,7 +338,6 @@ function comment_author_rss() {
* Display the current comment content for use in the feeds.
*
* @since 1.0.0
* @uses get_comment_text()
*/
function comment_text_rss() {
$comment_text = get_comment_text();
@ -454,7 +448,6 @@ function html_type_rss() {
* attributes.
*
* @since 1.5.0
* @uses get_post_custom() To get the current post enclosure metadata.
*/
function rss_enclosure() {
if ( post_password_required() )
@ -494,7 +487,6 @@ function rss_enclosure() {
* enclosure(s) consist of link HTML tag(s) with a URI and other attributes.
*
* @since 2.2.0
* @uses get_post_custom() To get the current post enclosure metadata.
*/
function atom_enclosure() {
if ( post_password_required() )

7
wp-includes/formatting.php
View File

@ -1226,7 +1226,6 @@ function sanitize_title( $title, $fallback_title = '', $context = 'save' ) {
* Used for querying the database for a value from URL.
*
* @since 3.1.0
* @uses sanitize_title()
*
* @param string $title The string to be sanitized.
* @return string The sanitized string.
@ -2230,7 +2229,6 @@ function _wp_iso_convert( $match ) {
*
* @since 1.2.0
*
* @uses get_option() to retrieve the value of 'gmt_offset'.
* @param string $string The date to be converted.
* @param string $format The format string for the returned date (default is Y-m-d H:i:s)
* @return string GMT version of the date provided.
@ -3023,8 +3021,6 @@ function esc_sql( $data ) {
* is applied to the returned cleaned URL.
*
* @since 2.8.0
* @uses wp_kses_bad_protocol() To only permit protocols in the URL set
* via $protocols or the common ones set in the function.
*
* @param string $url The URL to be cleaned.
* @param array $protocols Optional. An array of acceptable protocols.
@ -3082,7 +3078,6 @@ function esc_url( $url, $protocols = null, $_context = 'display' ) {
* Performs esc_url() for database usage.
*
* @since 2.8.0
* @uses esc_url()
*
* @param string $url The URL to be cleaned.
* @param array $protocols An array of acceptable protocols.
@ -3478,7 +3473,6 @@ function wp_parse_str( $string, &$array ) {
*
* KSES already converts lone greater than signs.
*
* @uses wp_pre_kses_less_than_callback in the callback function.
* @since 2.3.0
*
* @param string $text Text to be converted.
@ -3491,7 +3485,6 @@ function wp_pre_kses_less_than( $text ) {
/**
* Callback function used by preg_replace.
*
* @uses esc_html to format the $matches text.
* @since 2.3.0
*
* @param array $matches Populated by matches to preg_replace.

4
wp-includes/functions.php
View File

@ -2274,8 +2274,6 @@ function wp_get_mime_types() {
*
* @since 2.8.6
*
* @uses wp_get_upload_mime_types() to fetch the list of mime types
*
* @param int|WP_User $user Optional. User to check. Defaults to current user.
* @return array Array of mime types keyed by the file extension regex corresponding
* to those types.
@ -3200,8 +3198,6 @@ function wp_maybe_load_widgets() {
* Append the Widgets menu to the themes main menu.
*
* @since 2.2.0
*
* @uses $submenu The administration submenu list.
*/
function wp_widgets_add_menu() {
global $submenu;

22
wp-includes/general-template.php
View File

@ -17,8 +17,6 @@
*
* @since 1.5.0
*
* @uses locate_template()
*
* @param string $name The name of the specialised header.
*/
function get_header( $name = null ) {
@ -59,8 +57,6 @@ function get_header( $name = null ) {
*
* @since 1.5.0
*
* @uses locate_template()
*
* @param string $name The name of the specialised footer.
*/
function get_footer( $name = null ) {
@ -101,8 +97,6 @@ function get_footer( $name = null ) {
*
* @since 1.5.0
*
* @uses locate_template()
*
* @param string $name The name of the specialised sidebar.
*/
function get_sidebar( $name = null ) {
@ -150,8 +144,6 @@ function get_sidebar( $name = null ) {
*
* @since 3.0.0
*
* @uses locate_template()
*
* @param string $slug The slug name for the generic template.
* @param string $name The name of the specialised template.
*/
@ -307,9 +299,6 @@ function wp_loginout($redirect = '', $echo = true) {
*
* @since 2.7.0
*
* @uses wp_nonce_url() To protect against CSRF.
* @uses site_url() To generate the log out URL.
*
* @param string $redirect Path to redirect to on logout.
* @return string A log out URL.
*/
@ -340,8 +329,6 @@ function wp_logout_url($redirect = '') {
*
* @since 2.7.0
*
* @uses site_url() To generate the log in URL.
*
* @param string $redirect Path to redirect to on login.
* @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false.
* @return string A log in URL.
@ -373,8 +360,6 @@ function wp_login_url($redirect = '', $force_reauth = false) {
*
* @since 3.6.0
*
* @uses site_url() To generate the registration URL.
*
* @return string User registration URL.
*/
function wp_registration_url() {
@ -496,8 +481,6 @@ function wp_login_form( $args = array() ) {
*
* @since 2.8.0
*
* @uses site_url() To generate the lost password URL
*
* @param string $redirect Path to redirect to on login.
* @return string Lost password URL.
*/
@ -1429,7 +1412,6 @@ function calendar_week_mod($num) {
* no posts for the month, then it will not be displayed.
*
* @since 1.0.0
* @uses calendar_week_mod()
*
* @param bool $initial Optional, default is true. Use initial calendar names.
* @param bool $echo Optional, default is true. Set to false for return.
@ -1711,7 +1693,6 @@ function the_date_xml() {
*
* @since 0.71
*
* @uses get_the_date()
* @param string $d Optional. PHP date format defaults to the date_format option if not specified.
* @param string $before Optional. Output before the date.
* @param string $after Optional. Output after the date.
@ -2032,7 +2013,6 @@ function get_post_modified_time( $d = 'U', $gmt = false, $post = null, $translat
*
* @since 0.71
* @uses $wp_locale
* @uses $post
*/
function the_weekday() {
global $wp_locale;
@ -2358,7 +2338,6 @@ function wp_editor( $content, $editor_id, $settings = array() ) {
* to ensure that it is safe for placing in an html attribute.
*
* @since 2.3.0
* @uses esc_attr()
*
* @param bool $escaped Whether the result is escaped. Default true.
* Only use when you are later escaping it. Do not use unescaped.
@ -2385,7 +2364,6 @@ function get_search_query( $escaped = true ) {
* The search query string is passed through {@link esc_attr()}
* to ensure that it is safe for placing in an html attribute.
*
* @uses esc_attr()
* @since 2.1.0
*/
function the_search_query() {

7
wp-includes/kses.php
View File

@ -661,7 +661,6 @@ function _wp_kses_split_callback( $match ) {
*
* @access private
* @since 1.0.0
* @uses wp_kses_attr()
*
* @param string $string Content to filter
* @param array $allowed_html Allowed HTML elements
@ -1318,7 +1317,6 @@ function _wp_kses_decode_entities_chr_hexdec( $match ) {
* Sanitize content with allowed HTML Kses rules.
*
* @since 1.0.0
* @uses $allowedtags
*
* @param string $data Content to filter, expected to be escaped with slashes
* @return string Filtered content
@ -1331,7 +1329,6 @@ function wp_filter_kses( $data ) {
* Sanitize content with allowed HTML Kses rules.
*
* @since 2.9.0
* @uses $allowedtags
*
* @param string $data Content to filter, expected to not be escaped
* @return string Filtered content
@ -1392,7 +1389,6 @@ function wp_filter_nohtml_kses( $data ) {
* '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.
*/
function kses_init_filters() {
// Normal filtering
@ -1447,9 +1443,6 @@ function kses_remove_filters() {
* 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
* does not have unfiltered HTML capability.
* @since 2.0.0
*/
function kses_init() {

11
wp-includes/link-template.php
View File

@ -1880,7 +1880,6 @@ function get_adjacent_post_link( $format, $link, $in_same_term = false, $exclude
* Can be either next post link or previous.
*
* @since 2.5.0
* @uses get_adjacent_post_link()
*
* @param string $format Link anchor format.
* @param string $link Link permalink format.
@ -2048,7 +2047,6 @@ function get_next_posts_link( $label = null, $max_page = 0 ) {
* Display the next posts page link.
*
* @since 0.71
* @uses get_next_posts_link()
*
* @param string $label Content for link text.
* @param int $max_page Optional. Max pages.
@ -2126,7 +2124,6 @@ function get_previous_posts_link( $label = null ) {
* Display the previous posts page link.
*
* @since 0.71
* @uses get_previous_posts_link()
*
* @param string $label Optional. Previous page link text.
*/
@ -2606,8 +2603,6 @@ function get_shortcut_link() {
*
* @since 3.0.0
*
* @uses get_home_url()
*
* @param string $path (optional) Path relative to the home url.
* @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.
* @return string Home url link with optional path appended.
@ -2675,8 +2670,6 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
*
* @since 3.0.0
*
* @uses get_site_url()
*
* @param string $path Optional. Path relative to the site url.
* @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
* @return string Site url link with optional path appended.
@ -3258,8 +3251,6 @@ function wp_get_shortlink($id = 0, $context = 'post', $allow_slugs = true) {
* Attached to the wp_head action.
*
* @since 3.0.0
*
* @uses wp_get_shortlink()
*/
function wp_shortlink_wp_head() {
$shortlink = wp_get_shortlink( 0, 'query' );
@ -3276,8 +3267,6 @@ function wp_shortlink_wp_head() {
* Attached to the wp action.
*
* @since 3.0.0
*
* @uses wp_get_shortlink()
*/
function wp_shortlink_header() {
if ( headers_sent() )

11
wp-includes/media.php
View File

@ -25,7 +25,6 @@
* height as the second element.
*
* @since 2.5.0
* @uses wp_constrain_dimensions() This function passes the widths and the heights.
*
* @param int $width Width of the image
* @param int $height Height of the image
@ -684,7 +683,6 @@ function wp_get_attachment_image_src($attachment_id, $size='thumbnail', $icon =
* @since 2.5.0
*
* @see add_image_size()
* @uses wp_get_attachment_image_src() Gets attachment file URL and dimensions
*
* @param int $attachment_id Image attachment ID.
* @param string|array $size Optional. Default 'thumbnail'.
@ -1995,7 +1993,6 @@ function get_attachment_taxonomies($attachment) {
*
* @since 3.5.0
* @see get_attachment_taxonomies()
* @uses get_taxonomies()
*
* @param string $output The type of output to return, either taxonomy 'names' or 'objects'. 'names' is the default.
* @return array The names of all taxonomy of $object_type.
@ -2099,7 +2096,6 @@ function wp_embed_defaults( $url = '' ) {
* Based on a supplied width/height example, return the biggest possible dimensions based on the max width/height.
*
* @since 2.9.0
* @uses wp_constrain_dimensions() This function passes the widths and the heights.
*
* @param int $example_width The width of an example embed.
* @param int $example_height The height of an example embed.
@ -2122,9 +2118,6 @@ function wp_expand_dimensions( $example_width, $example_height, $max_width, $max
* @since 2.9.0
* @see WP_oEmbed
*
* @uses _wp_oembed_get_object()
* @uses WP_oEmbed::get_html()
*
* @param string $url The URL that should be embedded.
* @param array $args Additional arguments and parameters.
* @return bool|string False on failure or the embed HTML on success.
@ -2141,8 +2134,6 @@ function wp_oembed_get( $url, $args = '' ) {
* @since 2.9.0
* @see WP_oEmbed
*
* @uses _wp_oembed_get_object()
*
* @param string $format The format of URL that this provider can handle. You can use asterisks as wildcards.
* @param string $provider The URL to the oEmbed provider.
* @param boolean $regex Whether the $format parameter is in a regex format.
@ -2164,8 +2155,6 @@ function wp_oembed_add_provider( $format, $provider, $regex = false ) {
* @since 3.5.0
* @see WP_oEmbed
*
* @uses _wp_oembed_get_object()
*
* @param string $format The URL format for the oEmbed provider to remove.
*/
function wp_oembed_remove_provider( $format ) {

6
wp-includes/meta.php
View File

@ -576,9 +576,6 @@ function get_metadata_by_mid( $meta_type, $meta_id ) {
*
* @since 3.3.0
*
* @uses get_metadata_by_mid() Calls get_metadata_by_mid() to fetch the meta key, value
* and object_id of the given meta_id.
*
* @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
* @param int $meta_id ID for a specific meta row
* @param string $meta_value Metadata value
@ -670,9 +667,6 @@ function update_metadata_by_mid( $meta_type, $meta_id, $meta_value, $meta_key =
*
* @since 3.3.0
*
* @uses get_metadata_by_mid() Calls get_metadata_by_mid() to fetch the meta key, value
* and object_id of the given meta_id.
*
* @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
* @param int $meta_id ID for a specific meta row
* @return bool True on successful delete, false on failure.

2
wp-includes/ms-deprecated.php
View File

@ -232,7 +232,6 @@ function get_most_active_blogs( $num = 10, $display = true ) {
* @since MU
* @deprecated 3.3.0
* @deprecated Use wp_redirect()
* @uses wpmu_admin_redirect_add_updated_param()
*
* @param string $url
*/
@ -297,7 +296,6 @@ function wpmu_admin_redirect_add_updated_param( $url = '' ) {
* @since MU
* @deprecated 3.6.0
* @deprecated Use get_user_by()
* @uses get_user_by()
*
* @param string $string Either an email address or a login.
* @return int

41
wp-includes/ms-functions.php
View File

@ -11,8 +11,6 @@
* Gets the network's site and user counts.
*
* @since MU 1.0
* @uses get_blog_count()
* @uses get_user_count()
*
* @return array Site and user count for the network.
*/
@ -58,9 +56,6 @@ function get_admin_users_for_domain( $sitedomain = '', $path = '' ) {
* is returned.
*
* @since MU 1.0
* @uses get_blogs_of_user()
* @uses add_user_to_blog()
* @uses get_blog_details()
*
* @param int $user_id The unique ID of the user
* @return object The blog object
@ -298,7 +293,6 @@ function remove_user_from_blog($user_id, $blog_id = '', $reassign = '') {
* Create an empty blog.
*
* @since MU 1.0
* @uses install_blog()
*
* @param string $domain The new blog's domain.
* @param string $path The new blog's path.
@ -455,9 +449,6 @@ function is_email_address_unsafe( $user_email ) {
* relevant errors if necessary.
*
* @since MU
* @uses is_email_address_unsafe()
* @uses username_exists()
* @uses email_exists()
*
* @param string $user_name The login name provided by the user.
* @param string $user_email The email provided by the user.
@ -580,8 +571,6 @@ function wpmu_validate_user_signup($user_name, $user_email) {
* the way that WordPress validates new site signups.
*
* @since MU
* @uses domain_exists()
* @uses username_exists()
*
* @param string $blogname The blog name provided by the user. Must be unique.
* @param string $blog_title The blog title provided by the user.
@ -713,7 +702,6 @@ function wpmu_validate_blog_signup( $blogname, $blog_title, $user = '' ) {
* Record site signup information for future activation.
*
* @since MU
* @uses wpmu_signup_blog_notification()
*
* @param string $domain The requested domain.
* @param string $path The requested path.
@ -749,7 +737,6 @@ function wpmu_signup_blog( $domain, $path, $title, $user, $user_email, $meta = a
* new site registration is not.
*
* @since MU
* @uses wpmu_signup_user_notification()
*
* @param string $user The user's requested login name.
* @param string $user_email The user's email address.
@ -978,12 +965,6 @@ function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array(
* by a Super Admin).
*
* @since MU
* @uses wp_generate_password()
* @uses wpmu_welcome_user_notification()
* @uses add_user_to_blog()
* @uses wpmu_create_user()
* @uses wpmu_create_blog()
* @uses wpmu_welcome_notification()
*
* @param string $key The activation key provided to the user.
* @return array An array containing information about the activated user and/or blog
@ -1078,7 +1059,6 @@ function wpmu_activate_signup($key) {
* use 'user_register').
*
* @since MU
* @uses wp_create_user()
*
* @param string $user_name The new user's login name.
* @param string $password The new user's password.
@ -1121,10 +1101,6 @@ function wpmu_create_user( $user_name, $password, $email ) {
* root domain (eg 'blog1.example.com'), and $path is '/'.
*
* @since MU
* @uses domain_exists()
* @uses insert_blog()
* @uses wp_install_defaults()
* @uses add_user_to_blog()
*
* @param string $domain The new site's domain.
* @param string $path The new site's path.
@ -1248,7 +1224,6 @@ Disable these notifications: %4$s' ), $blogname, $siteurl, wp_unslash( $_SERVER[
* the notification email.
*
* @since MU
* @uses apply_filters() Filter newuser_notify_siteadmin to change the content of the email message
*
* @param int $user_id The new user's ID.
* @return bool
@ -1354,8 +1329,6 @@ function insert_blog($domain, $path, $site_id) {
* points to the new blog.
*
* @since MU
* @uses make_db_current_silent()
* @uses populate_roles()
*
* @param int $blog_id The value returned by insert_blog().
* @param string $blog_title The title of the new site.
@ -1408,7 +1381,6 @@ function install_blog( $blog_id, $blog_title = '' ) {
* @since MU
* @deprecated MU
* @deprecated Use wp_install_defaults()
* @uses wp_install_defaults()
*
* @param int $blog_id Ignored in this function.
* @param int $user_id
@ -1628,7 +1600,6 @@ function get_current_site() {
* the most recent post_date_gmt.
*
* @since MU
* @uses get_blogs_of_user()
*
* @param int $user_id
* @return array Contains the blog_id, post_id, post_date_gmt, and post_gmt_ts
@ -1675,7 +1646,6 @@ function get_most_recent_post_of_user( $user_id ) {
* a blog has exceeded its allowed upload space.
*
* @since MU
* @uses recurse_dirsize()
*
* @param string $directory
* @return int
@ -1889,7 +1859,6 @@ function upload_is_file_too_big( $upload ) {
* Add a nonce field to the signup page.
*
* @since MU
* @uses wp_nonce_field()
*/
function signup_nonce_fields() {
$id = mt_rand();
@ -1901,7 +1870,6 @@ function signup_nonce_fields() {
* Process the signup nonce created in signup_nonce_fields().
*
* @since MU
* @uses wp_create_nonce()
*
* @param array $result
* @return array
@ -1947,7 +1915,6 @@ function maybe_redirect_404() {
* added, as when a user is invited through the regular WP Add User interface.
*
* @since MU
* @uses add_existing_user_to_blog()
*/
function maybe_add_existing_user_to_blog() {
if ( false === strpos( $_SERVER[ 'REQUEST_URI' ], '/newbloguser/' ) )
@ -1973,7 +1940,6 @@ function maybe_add_existing_user_to_blog() {
* Add a user to a blog based on details from maybe_add_existing_user_to_blog().
*
* @since MU
* @uses add_user_to_blog()
*
* @param array $details
*/
@ -2031,7 +1997,6 @@ function fix_phpmailer_messageid( $phpmailer ) {
* Check to see whether a user is marked as a spammer, based on user login.
*
* @since MU
* @uses get_user_by()
*
* @param string|WP_User $user Optional. Defaults to current user. WP_User object,
* or user login name as a string.
@ -2054,7 +2019,6 @@ function is_user_spammy( $user = null ) {
* Public blogs have a setting of 1, private blogs are 0.
*
* @since MU
* @uses update_blog_status()
*
* @param int $old_value
* @param int $value The new public value
@ -2069,7 +2033,6 @@ add_action('update_option_blog_public', 'update_blog_public', 10, 2);
* Check whether a usermeta key has to do with the current blog.
*
* @since MU
* @uses wp_get_current_user()
*
* @param string $key
* @param int $user_id Optional. Defaults to current user.
@ -2206,8 +2169,6 @@ function wp_update_network_counts() {
* on a network when a site is created or its status is updated.
*
* @since 3.7.0
*
* @uses wp_update_network_site_counts()
*/
function wp_maybe_update_network_site_counts() {
$is_small_network = ! wp_is_large_network( 'sites' );
@ -2235,8 +2196,6 @@ function wp_maybe_update_network_site_counts() {
* on a network when a user is created or its status is updated.
*
* @since 3.7.0
*
* @uses wp_update_network_user_counts()
*/
function wp_maybe_update_network_user_counts() {
$is_small_network = ! wp_is_large_network( 'users' );

3
wp-includes/nav-menu.php
View File

@ -12,9 +12,6 @@
*
* @since 3.0.0
*
* @uses get_term
* @uses get_term_by
*
* @param string $menu Menu ID, slug, or name.
* @return mixed false if $menu param isn't supplied or term does not exist, menu object if successful.
*/

1
wp-includes/option.php
View File

@ -141,7 +141,6 @@ function wp_protect_special_option( $option ) {
/**
* Print option value after sanitizing for forms.
*
* @uses attr Sanitizes value.
* @since 1.5.0
*
* @param string $option Option name.

5
wp-includes/pluggable.php
View File

@ -72,7 +72,6 @@ if ( !function_exists('get_currentuserinfo') ) :
* @since 0.71
*
* @uses $current_user Checks if the current user is set
* @uses wp_validate_auth_cookie() Retrieves current logged in user.
*
* @return bool|null False on XML-RPC Request and invalid auth cookie. Null when current user set.
*/
@ -1215,8 +1214,6 @@ if ( !function_exists('wp_safe_redirect') ) :
*
* @since 2.3.0
*
* @uses wp_validate_redirect() To validate the redirect is to an allowed host.
*
* @return void Does not return anything
**/
function wp_safe_redirect($location, $status = 302) {
@ -1872,7 +1869,6 @@ if ( !function_exists('wp_hash') ) :
* Get hash of given string.
*
* @since 2.0.3
* @uses wp_salt() Get WordPress salt
*
* @param string $data Plain text to hash
* @return string Hash of $data
@ -2069,7 +2065,6 @@ if ( !function_exists('wp_set_password') ) :
* @since 2.5.0
*
* @uses $wpdb WordPress database object for queries
* @uses wp_hash_password() Used to encrypt the user's password before passing to the database
*
* @param string $password The plaintext new user password
* @param int $user_id User ID

10
wp-includes/plugin.php
View File

@ -357,8 +357,6 @@ function current_filter() {
*
* @since 3.9.0
*
* @uses current_filter()
*
* @return string Hook name of the current action.
*/
function current_action() {
@ -401,8 +399,6 @@ function doing_filter( $filter = null ) {
*
* @since 3.9.0
*
* @uses doing_filter()
*
* @param string|null $action Optional. Action to check. Defaults to null, which checks
* if any action is currently being run.
* @return bool Whether the action is currently in the stack.
@ -421,8 +417,6 @@ function doing_action( $action = null ) {
*
* @since 1.2.0
*
* @uses add_filter() Adds an action. Parameter list and functionality are the same.
*
* @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
@ -646,8 +640,6 @@ function remove_all_actions($tag, $priority = false) {
*
* @since 1.5.0
*
* @uses WP_PLUGIN_DIR, WPMU_PLUGIN_DIR
*
* @param string $file The filename of plugin.
* @return string The name of a plugin.
*/
@ -832,8 +824,6 @@ function register_uninstall_hook( $file, $callback ) {
* @since 2.5.0
* @access private
*
* @uses $wp_filter Used to process all of the functions in the 'all' hook.
*
* @param array $args The collected parameters from the hook that was called.
*/
function _wp_call_all_hook($args) {

6
wp-includes/post-formats.php
View File

@ -36,8 +36,6 @@ function get_post_format( $post = null ) {
*
* @since 3.1.0
*
* @uses has_term()
*
* @param string|array $format Optional. The format or formats to check.
* @param object|int $post Optional. The post to check. If not supplied, defaults to the current post if used in the loop.
* @return bool True if the post has any of the given formats (or any format, if no format specified), false otherwise.
@ -108,8 +106,6 @@ function get_post_format_strings() {
*
* @since 3.1.0
*
* @uses get_post_format_strings()
*
* @return array The array of post format slugs.
*/
function get_post_format_slugs() {
@ -122,8 +118,6 @@ function get_post_format_slugs() {
*
* @since 3.1.0
*
* @uses get_post_format_strings()
*
* @param string $slug A post format slug.
* @return string The translated post format name.
*/

13
wp-includes/post-template.php
View File

@ -21,7 +21,6 @@ function the_ID() {
* Retrieve the ID of the current item in the WordPress Loop.
*
* @since 2.1.0
* @uses $post
*
* @return int|bool The ID of the current item in the WordPress Loop. False if $post is not set.
*/
@ -907,7 +906,6 @@ function post_custom( $key = '' ) {
*
* @internal This will probably change at some point...
* @since 1.2.0
* @uses apply_filters() Calls 'the_meta_key' on list item HTML content, with key and value as separate parameters.
*/
function the_meta() {
if ( $keys = get_post_custom_keys() ) {
@ -1466,7 +1464,6 @@ function the_attachment_link( $id = 0, $fullsize = false, $deprecated = false, $
* Retrieve an attachment page link using an image or icon, if possible.
*
* @since 2.5.0
* @uses apply_filters() Calls 'wp_get_attachment_link' filter on HTML content with same parameters as function.
*
* @param int|WP_Post $id Optional. Post ID or post object.
* @param string $size Optional, default is 'thumbnail'. Size of image, either array or string.
@ -1602,7 +1599,6 @@ function get_the_password_form( $post = 0 ) {
* specific to that template.
*
* @since 2.5.0
* @uses $wp_query
*
* @param string $template The specific template name if specific matching is required.
* @return bool True on success, false on failure.
@ -1649,8 +1645,6 @@ function get_page_template_slug( $post_id = null ) {
*
* @since 2.6.0
*
* @uses date_i18n()
*
* @param int|object $revision Revision ID or revision object.
* @param bool $link Optional, default is true. Link to revisions's page?
* @return string i18n formatted datetimestamp or localized 'Current Revision'.
@ -1686,8 +1680,6 @@ function wp_post_revision_title( $revision, $link = true ) {
*
* @since 3.6.0
*
* @uses date_i18n()
*
* @param int|object $revision Revision ID or revision object.
* @param bool $link Optional, default is true. Link to revisions's page?
* @return string gravatar, user, i18n formatted datetimestamp or localized 'Current Revision'.
@ -1737,11 +1729,6 @@ function wp_post_revision_title_expanded( $revision, $link = true ) {
*
* @since 2.6.0
*
* @uses wp_get_post_revisions()
* @uses wp_post_revision_title_expanded()
* @uses get_edit_post_link()
* @uses get_the_author_meta()
*
* @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
* @param string $type 'all' (default), 'revision' or 'autosave'
* @return null

4
wp-includes/post.php
View File

@ -2942,8 +2942,6 @@ function wp_get_post_categories( $post_id = 0, $args = array() ) {
*
* @since 2.3.0
*
* @uses wp_get_object_terms()
*
* @param int $post_id Optional. The Post ID. Does not default to the ID of the
* global $post. Defualt 0.
* @param array $args Optional. Overwrite the defaults
@ -2962,8 +2960,6 @@ function wp_get_post_tags( $post_id = 0, $args = array() ) {
*
* @since 2.8.0
*
* @uses wp_get_object_terms()
*
* @param int $post_id Optional. The Post ID. Does not default to the ID of the
* global $post. Default 0.
* @param string $taxonomy Optional. The taxonomy for which to retrieve terms. Default 'post_tag'.

10
wp-includes/query.php
View File

@ -406,8 +406,6 @@ function is_comment_feed() {
*
* @see WP_Query::is_front_page()
* @since 2.5.0
* @uses is_home()
* @uses get_option()
*
* @return bool True, if front of site.
*/
@ -2357,7 +2355,6 @@ class WP_Query {
*
* @since 1.5.0
* @access public
* @uses do_action_ref_array() Calls 'pre_get_posts' hook before retrieving posts.
*
* @return array List of posts.
*/
@ -3692,8 +3689,6 @@ class WP_Query {
*
* @since 1.5.0
* @access public
* @uses $post
* @uses do_action_ref_array() Calls 'loop_start' if loop has just started
*/
public function the_post() {
global $post;
@ -3720,7 +3715,6 @@ class WP_Query {
*
* @since 1.5.0
* @access public
* @uses do_action_ref_array() Calls 'loop_end' if loop is ended
*
* @return bool True if posts are available, false if end of loop.
*/
@ -3778,7 +3772,6 @@ class WP_Query {
* @since 2.2.0
* @access public
* @global object $comment Current comment.
* @uses do_action() Calls 'comment_loop_start' hook when first comment is processed.
*/
public function the_comment() {
global $comment;
@ -4280,8 +4273,6 @@ class WP_Query {
* Otherwise the same as @see WP_Query::is_home()
*
* @since 3.1.0
* @uses is_home()
* @uses get_option()
*
* @return bool True, if front of site.
*/
@ -4688,7 +4679,6 @@ function wp_old_slug_redirect() {
* @since 1.5.0
*
* @param object $post Post data.
* @uses do_action_ref_array() Calls 'the_post'
* @return bool True when finished.
*/
function setup_postdata( $post ) {

22
wp-includes/revision.php
View File

@ -77,8 +77,6 @@ function _wp_post_revision_fields( $post = null, $autosave = false ) {
*
* @since 2.6.0
*
* @uses _wp_put_post_revision()
*
* @param int $post_id The ID of the post to save as a revision.
* @return mixed Null or 0 if error, new revision ID, if success.
*/
@ -192,8 +190,6 @@ function wp_save_post_revision( $post_id ) {
*
* @since 2.6.0
*
* @uses wp_get_post_revisions()
*
* @param int $post_id The post ID.
* @param int $user_id optional The post author ID.
* @return object|bool The autosaved data or false on failure or when no autosave exists.
@ -252,8 +248,6 @@ function wp_is_post_autosave( $post ) {
* @since 2.6.0
* @access private
*
* @uses wp_insert_post()
*
* @param int|object|array $post Post ID, post object OR post array.
* @param bool $autosave Optional. Is the revision an autosave?
* @return mixed WP_Error or 0 if error, new revision ID if success.
@ -296,8 +290,6 @@ function _wp_put_post_revision( $post = null, $autosave = false ) {
*
* @since 2.6.0
*
* @uses get_post()
*
* @param int|object $post The post ID or object.
* @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N.
* @param string $filter Optional sanitation filter. @see sanitize_post().
@ -329,9 +321,6 @@ function wp_get_post_revision(&$post, $output = OBJECT, $filter = 'raw') {
*
* @since 2.6.0
*
* @uses wp_get_post_revision()
* @uses wp_update_post()
*
* @param int|object $revision_id Revision ID or revision object.
* @param array $fields Optional. What fields to restore from. Defaults to all.
* @return mixed Null if error, false if no fields to restore, (int) post ID if success.
@ -390,9 +379,6 @@ function wp_restore_post_revision( $revision_id, $fields = null ) {
*
* @since 2.6.0
*
* @uses wp_get_post_revision()
* @uses wp_delete_post()
*
* @param int|object $revision_id Revision ID or revision object.
* @return mixed Null or WP_Error if error, deleted post if success.
*/
@ -424,8 +410,6 @@ function wp_delete_post_revision( $revision_id ) {
*
* @since 2.6.0
*
* @uses get_children()
*
* @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
* @return array An array of revisions, or an empty array if none.
*/
@ -453,8 +437,6 @@ function wp_get_post_revisions( $post_id = 0, $args = null ) {
*
* @since 3.6.0
*
* @uses wp_revisions_to_keep()
*
* @param object $post The post object.
* @return bool True if number of revisions to keep isn't zero, false otherwise.
*/
@ -468,8 +450,6 @@ function wp_revisions_enabled( $post ) {
*
* @since 3.6.0
*
* @uses post_type_supports()
*
* @param object $post The post object.
* @return int The number of revisions to keep.
*/
@ -587,8 +567,6 @@ function _wp_get_post_revision_version( $revision ) {
* @since 3.6.0
* @access private
*
* @uses wp_get_post_revisions()
*
* @param object $post Post object
* @param array $revisions Current revisions of the post
* @return bool true if the revisions were upgraded, false if problems

1
wp-includes/shortcodes.php
View File

@ -185,7 +185,6 @@ function has_shortcode( $content, $tag ) {
* @since 2.5.0
*
* @uses $shortcode_tags
* @uses get_shortcode_regex() Gets the search pattern for searching shortcodes.
*
* @param string $content Content to search for shortcodes
* @return string Content with shortcodes filtered out.

36
wp-includes/taxonomy.php
View File

@ -134,7 +134,6 @@ add_action( 'init', 'create_initial_taxonomies', 0 ); // highest priority
*
* @since 3.0.0
* @uses $wp_taxonomies
* @see register_taxonomy
*
* @param array $args An array of key => value arguments to match against the taxonomy objects.
* @param string $output The type of output to return, either taxonomy 'names' or 'objects'. 'names' is the default.
@ -200,7 +199,6 @@ function get_object_taxonomies($object, $output = 'names') {
* @since 2.3.0
*
* @uses $wp_taxonomies
* @uses taxonomy_exists() Checks whether taxonomy exists
*
* @param string $taxonomy Name of taxonomy object to return
* @return object|bool The Taxonomy Object or false if $taxonomy doesn't exist
@ -242,9 +240,6 @@ function taxonomy_exists( $taxonomy ) {
*
* @since 2.3.0
*
* @uses taxonomy_exists() Checks whether taxonomy exists
* @uses get_taxonomy() Used to get the taxonomy object
*
* @param string $taxonomy Name of taxonomy object
* @return bool Whether the taxonomy is hierarchical
*/
@ -568,7 +563,6 @@ function unregister_taxonomy_for_object_type( $taxonomy, $object_type ) {
* @since 2.3.0
*
* @uses $wpdb
* @uses wp_parse_args() Creates an array from string $args.
*
* @param int|array $term_ids Term id or array of term ids of terms that will be used
* @param string|array $taxonomies String of taxonomy name or Array of string values of taxonomy names
@ -1268,7 +1262,6 @@ class WP_Tax_Query {
* @since 2.3.0
*
* @uses $wpdb
* @uses sanitize_term() Cleanses the term based on $filter context before returning.
* @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param.
*
* @param int|object $term If integer, will get from database. If object will apply filters and return $term.
@ -1364,7 +1357,6 @@ function get_term($term, $taxonomy, $output = OBJECT, $filter = 'raw') {
* @since 2.3.0
*
* @uses $wpdb
* @uses sanitize_term() Cleanses the term based on $filter context before returning.
* @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param.
*
* @param string $field Either 'slug', 'name', 'id' (term_id), or 'term_taxonomy_id'
@ -1455,8 +1447,6 @@ function get_term_by($field, $value, $taxonomy, $output = OBJECT, $filter = 'raw
* @since 2.3.0
*
* @uses $wpdb
* @uses _get_term_hierarchy()
* @uses get_term_children() Used to get the children of both $taxonomy and the parent $term
*
* @param string $term_id ID of Term to get children
* @param string $taxonomy Taxonomy Name
@ -1496,8 +1486,6 @@ function get_term_children( $term_id, $taxonomy ) {
*
* @since 2.3.0
*
* @uses sanitize_term_field() Passes the return value in sanitize_term_field on success.
*
* @param string $field Term field to fetch
* @param int $term Term ID
* @param string $taxonomy Taxonomy Name
@ -1527,8 +1515,6 @@ function get_term_field( $field, $term, $taxonomy, $context = 'display' ) {
*
* @since 2.3.0
*
* @uses sanitize_term() Passes the return value on success
*
* @param int|object $id Term ID or Object
* @param string $taxonomy Taxonomy Name
* @return mixed|null|WP_Error Will return empty string if $term is not an object.
@ -2105,8 +2091,6 @@ function term_is_ancestor_of( $term1, $term2, $taxonomy ) {
*
* @since 2.3.0
*
* @uses sanitize_term_field Used to sanitize all fields in a term
*
* @param array|object $term The term to check
* @param string $taxonomy The taxonomy name to use
* @param string $context Default is 'display'.
@ -2315,9 +2299,6 @@ function sanitize_term_field($field, $value, $term_id, $taxonomy, $context) {
*
* @since 2.3.0
*
* @uses get_terms()
* @uses wp_parse_args() Turns strings into arrays and merges defaults into an array.
*
* @param string $taxonomy Taxonomy name
* @param array|string $args Overwrite defaults. See get_terms()
* @return int|WP_Error How many terms are in $taxonomy. WP_Error if $taxonomy does not exist.
@ -2345,7 +2326,6 @@ function wp_count_terms( $taxonomy, $args = array() ) {
* taxonomy itself.
*
* @since 2.3.0
* @uses wp_remove_object_terms()
*
* @param int $object_id The term Object Id that refers to the term
* @param string|array $taxonomies List of Taxonomy Names or single Taxonomy name.
@ -2544,7 +2524,6 @@ function wp_delete_term( $term, $taxonomy, $args = array() ) {
* Deletes one existing category.
*
* @since 2.0.0
* @uses wp_delete_term()
*
* @param int $cat_ID
* @return mixed Returns true if completes delete action; false if term doesn't exist;
@ -2967,7 +2946,6 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) {
* exists under.
*
* @since 2.3.0
* @uses wp_remove_object_terms()
*
* @param int $object_id The object to relate to.
* @param array|int|string $terms A single term slug, single term id, or array of either term slugs or ids.
@ -3091,7 +3069,6 @@ function wp_set_object_terms( $object_id, $terms, $taxonomy, $append = false ) {
* Add term(s) associated with a given object.
*
* @since 3.6.0
* @uses wp_set_object_terms()
*
* @param int $object_id The ID of the object to which the terms will be added.
* @param array|int|string $terms The slug(s) or ID(s) of the term(s) to add.
@ -3690,8 +3667,6 @@ function clean_term_cache($ids, $taxonomy = '', $clean_taxonomy = true) {
*
* @since 2.3.0
*
* @uses wp_cache_get() Retrieves taxonomy relationship from cache
*
* @param int|array $id Term object ID
* @param string $taxonomy Taxonomy Name
* @return bool|array Empty array if $terms found, but not $taxonomy. False if nothing is in cache for $taxonomy and $id.
@ -3715,7 +3690,6 @@ function get_object_term_cache($id, $taxonomy) {
* for each term and it also increases for each taxonomy the term belongs to.
*
* @since 2.3.0
* @uses wp_get_object_terms() Used to get terms from the database to update
*
* @param string|array $object_ids Single or list of term object ID(s)
* @param array|string $object_type The taxonomy object type
@ -3806,9 +3780,6 @@ function update_term_cache($terms, $taxonomy = '') {
* @access private
* @since 2.3.0
*
* @uses update_option() Stores all of the children in "$taxonomy_children"
* option. That is the name of the taxonomy, immediately followed by '_children'.
*
* @param string $taxonomy Taxonomy Name
* @return array Empty if $taxonomy isn't hierarchical or returns children as Term IDs.
*/
@ -4136,7 +4107,6 @@ function get_term_link( $term, $taxonomy = '') {
* 'template' : The template to use for displaying the taxonomy terms.
*
* @since 2.5.0
* @uses get_the_taxonomies()
*
* @param array $args Override the defaults.
*/
@ -4214,8 +4184,6 @@ function get_the_taxonomies( $post = 0, $args = array() ) {
*
* @since 2.5.0
*
* @uses get_object_taxonomies()
*
* @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
* @return array
*/
@ -4233,8 +4201,6 @@ function get_post_taxonomies( $post = 0 ) {
* If no terms are given, determines if object is associated with any terms in the given taxonomy.
*
* @since 2.7.0
* @uses get_object_term_cache()
* @uses wp_get_object_terms()
*
* @param int $object_id ID of the object (post ID, link ID, ...)
* @param string $taxonomy Single taxonomy name
@ -4279,7 +4245,6 @@ function is_object_in_term( $object_id, $taxonomy, $terms = null ) {
* Determine if the given object type is associated with the given taxonomy.
*
* @since 3.0.0
* @uses get_object_taxonomies()
*
* @param string $object_type Object type string
* @param string $taxonomy Single taxonomy name
@ -4361,7 +4326,6 @@ function wp_get_term_taxonomy_parent_id( $term_id, $taxonomy ) {
* Attached to the wp_update_term_parent filter.
*
* @since 3.1.0
* @uses wp_find_hierarchy_loop()
*
* @param int $parent term_id of the parent for the term we're checking.
* @param int $term_id The term we're checking.

1
wp-includes/theme.php
View File

@ -271,7 +271,6 @@ function get_locale_stylesheet_uri() {
* Retrieve name of the current theme.
*
* @since 1.5.0
* @uses apply_filters() Calls 'template' filter on template option.
*
* @return string Template name.
*/

8
wp-includes/user.php
View File

@ -316,8 +316,6 @@ function count_many_users_posts( $users, $post_type = 'post', $public_only = fal
*
* @since MU
*
* @uses wp_get_current_user
*
* @return int The current user's ID
*/
function get_current_user_id() {
@ -1111,7 +1109,6 @@ function get_blogs_of_user( $user_id, $all = false ) {
* Find out whether a user is a member of a given blog.
*
* @since MU 1.1
* @uses get_blogs_of_user()
*
* @param int $user_id Optional. The unique ID of the user. Defaults to the current user.
* @param int $blog_id Optional. ID of the blog to check. Defaults to the current site.
@ -1137,7 +1134,6 @@ function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) {
* Post meta data is called "Custom Fields" on the Administration Screens.
*
* @since 3.0.0
* @uses add_metadata()
* @link http://codex.wordpress.org/Function_Reference/add_user_meta
*
* @param int $user_id User ID.
@ -1158,7 +1154,6 @@ function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) {
* allows removing all metadata matching key, if needed.
*
* @since 3.0.0
* @uses delete_metadata()
* @link http://codex.wordpress.org/Function_Reference/delete_user_meta
*
* @param int $user_id user ID
@ -1174,7 +1169,6 @@ function delete_user_meta($user_id, $meta_key, $meta_value = '') {
* Retrieve user meta field for a user.
*
* @since 3.0.0
* @uses get_metadata()
* @link http://codex.wordpress.org/Function_Reference/get_user_meta
*
* @param int $user_id User ID.
@ -1196,7 +1190,6 @@ function get_user_meta($user_id, $key = '', $single = false) {
* If the meta field for the user does not exist, it will be added.
*
* @since 3.0.0
* @uses update_metadata
* @link http://codex.wordpress.org/Function_Reference/update_user_meta
*
* @param int $user_id User ID.
@ -1639,7 +1632,6 @@ function email_exists( $email ) {
* Checks whether an username is valid.
*
* @since 2.0.1
* @uses apply_filters() Calls 'validate_username' hook on $valid check and $username as parameters
*
* @param string $username Username.
* @return bool Whether username given is valid

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.1-alpha-30104';
$wp_version = '4.1-alpha-30105';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

5
wp-includes/widgets.php
View File

@ -554,9 +554,6 @@ function unregister_widget($widget_class) {
* @since 2.2.0
*
* @see register_sidebar() The second parameter is documented by register_sidebar() and is the same here.
* @uses parse_str() Converts a string to an array to be used in the rest of the function.
* @uses register_sidebar() Sends single sidebar information [name, id] to this
* function to handle building the sidebar.
*
* @param int $number Number of sidebars to create.
* @param string|array $args Builds Sidebar based off of 'name' and 'id' values.
@ -631,7 +628,6 @@ function register_sidebars($number = 1, $args = array()) {
*
* @since 2.2.0
* @uses $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
* @uses add_theme_support() to ensure widget support has been added.
*
* @param string|array $args Arguments for the sidebar being registered.
* @return string Sidebar ID added to $wp_registered_sidebars global.
@ -932,7 +928,6 @@ function _register_widget_form_callback($id, $name, $form_callback, $options = a
* Remove control callback for widget.
*
* @since 2.2.0
* @uses wp_register_widget_control() Unregisters by using empty callback.
*
* @param int|string $id Widget ID.
*/

2
wp-includes/wp-db.php
View File

@ -867,7 +867,6 @@ class wpdb {
/**
* Gets blog prefix.
*
* @uses is_multisite()
* @since 3.0.0
* @param int $blog_id Optional.
* @return string Blog prefix.
@ -906,7 +905,6 @@ class wpdb {
* @uses wpdb::$old_tables
* @uses wpdb::$global_tables
* @uses wpdb::$ms_global_tables
* @uses is_multisite()
*
* @param string $scope Optional. Can be all, global, ms_global, blog, or old tables. Defaults to all.
* @param bool $prefix Optional. Whether to include table prefixes. Default true. If blog

19
wp-signup.php
View File

@ -153,8 +153,6 @@ function show_blog_form( $blogname = '', $blog_title = '', $errors = '' ) {
*
* @since MU
*
* @uses wp_get_current_user() to retrieve the current user
* @uses wpmu_validate_blog_signup() to validate new site signup for the current user
* @return array Contains the new site data and error messages.
*/
function validate_blog_form() {
@ -208,7 +206,6 @@ function show_user_form($user_name = '', $user_email = '', $errors = '') {
*
* @since MU
*
* @uses wpmu_validate_user_signup() to retrieve an array of user data
* @return array Contains username, email, and error messages.
*/
function validate_user_form() {
@ -220,7 +217,6 @@ function validate_user_form() {
*
* @since MU
*
* @uses wp_get_current_user() to get the current user
* @param string $blogname The new site name
* @param string $blog_title The new blog title
* @param array $errors
@ -303,9 +299,6 @@ function signup_another_blog( $blogname = '', $blog_title = '', $errors = '' ) {
*
* @since MU
*
* @uses wp_get_current_user() to retrieve the current user
* @uses wpmu_create_blog() to add a new site
* @uses confirm_another_blog_signup() to confirm the user's new site signup
* @return bool True if blog signup was validated, false if error
*/
function validate_another_blog_signup() {
@ -394,8 +387,6 @@ function confirm_another_blog_signup( $domain, $path, $blog_title, $user_name, $
*
* @since MU
*
* @uses apply_filters() filter $filtered_results
* @uses show_user_form() to display the user registration form
* @param string $user_name The username
* @param string $user_email The user's email
* @param array $errors
@ -467,9 +458,6 @@ function signup_user( $user_name = '', $user_email = '', $errors = '' ) {
*
* @since MU
*
* @uses validate_user_form() to retrieve an array of the user data
* @uses wpmu_signup_user() to signup the new user
* @uses confirm_user_signup() to confirm the new user signup
* @return bool True if new user signup was validated, false if error
*/
function validate_user_signup() {
@ -519,8 +507,6 @@ function confirm_user_signup($user_name, $user_email) {
*
* @since MU
*
* @uses apply_filters() to filter $filtered_results
* @uses show_blog_form() to display the blog signup form
* @param string $user_name The username
* @param string $user_email The user's email address
* @param string $blogname The site name
@ -584,11 +570,6 @@ function signup_blog($user_name = '', $user_email = '', $blogname = '', $blog_ti
*
* @since MU
*
* @uses wpmu_validate_user_signup() to retrieve an array of the new user data and errors
* @uses wpmu_validate_blog_signup() to retrieve an array of the new site data and errors
* @uses apply_filters() to make signup $meta filterable
* @uses signup_user() to signup a new user
* @uses signup_blog() to signup a the new user to a new site
* @return bool True if the site signup was validated, false if error
*/
function validate_blog_signup() {