WordPress.org

Make WordPress Core

Ticket #30191: 30191.diff

File 30191.diff, 64.2 KB (added by DrewAPicture, 6 years ago)
  • src/wp-admin/includes/class-wp-list-table.php

     
    184184
    185185        /**
    186186         * Checks the current user's permissions
    187          * @uses wp_die()
    188187         *
    189188         * @since 3.1.0
    190189         * @access public
  • src/wp-admin/includes/class-wp-themes-list-table.php

     
    255255         *
    256256         * @since 3.4.0
    257257         * @access public
    258          *
    259          * @uses $this->features Array of all feature search terms.
    260          * @uses get_pagenum()
    261          * @uses _pagination_args['total_pages']
    262258         */
    263259        public function _js_vars( $extra_args = array() ) {
    264260                $search_string = isset( $_REQUEST['s'] ) ? esc_attr( wp_unslash( $_REQUEST['s'] ) ) : '';
  • src/wp-admin/includes/file.php

     
    5050 *
    5151 * @since 1.5.0
    5252 *
    53  * @uses _cleanup_header_comment
    5453 * @uses $wp_file_descriptions
    5554 * @param string $file Filesystem path or filename
    5655 * @return string Description of file from $wp_file_descriptions or basename of $file if description doesn't exist
     
    7574 *
    7675 * @since 1.5.0
    7776 *
    78  * @uses get_option
    7977 * @return string Full filesystem path to the root of the WordPress installation
    8078 */
    8179function get_home_path() {
     
    163161 *
    164162 * @since 1.5.0
    165163 *
    166  * @uses wp_die
    167  * @uses validate_file
    168164 * @param string $file file the users is attempting to edit
    169165 * @param array $allowed_files Array of allowed files to edit, $file must match an entry exactly
    170166 * @return null
  • src/wp-admin/includes/ms.php

     
    395395 * Get the remaining upload space for this blog.
    396396 *
    397397 * @since MU
    398  * @uses upload_is_user_over_quota()
    399  * @uses get_space_allowed()
    400  * @uses get_upload_space_available()
    401398 *
    402399 * @param int $size Current max size in bytes
    403400 * @return int Max size in bytes
  • src/wp-admin/includes/nav-menu.php

     
    550550 * @since 3.6.0
    551551 *
    552552 * @uses global $one_theme_location_no_menus to determine if no menus exist
    553  * @uses disabled() to output the disabled attribute in $other_attributes param in submit_button()
    554553 *
    555554 * @param int|string $nav_menu_selected_id (id, name or slug) of the currently-selected menu
    556555 * @return string Disabled attribute if at least one menu exists, false if not
     
    12471246 *
    12481247 * @since 3.6.0
    12491248 *
    1250  * @uses wp_get_nav_menu_items() to retrieve the nav menu's menu items
    1251  * @uses wp_defer_term_counter() to enable then disable term counting
    1252  *
    12531249 * @param int|string $nav_menu_selected_id (id, slug, or name ) of the currently-selected menu
    12541250 * @param string $nav_menu_selected_title Title of the currently-selected menu
    12551251 * @return array $messages The menu updated message
  • src/wp-admin/includes/post.php

     
    10691069/**
    10701070 * Returns the list of classes to be used by a metabox
    10711071 *
    1072  * @uses get_user_option()
    10731072 * @since 2.5.0
    10741073 *
    10751074 * @param unknown_type $id
     
    15001499 * @subpackage Post_Revisions
    15011500 * @since 2.6.0
    15021501 *
    1503  * @uses _wp_translate_postdata()
    1504  * @uses _wp_post_revision_fields()
    1505  *
    15061502 * @param mixed $post_data Associative array containing the post data or int post ID.
    15071503 * @return mixed The autosave revision ID. WP_Error or 0 on error.
    15081504 */
     
    15661562 * @package WordPress
    15671563 * @since 2.7.0
    15681564 *
    1569  * @uses get_post_status()
    1570  * @uses edit_post()
    1571  * @uses get_post()
    1572  * @uses current_user_can()
    1573  * @uses wp_die()
    1574  * @uses wp_create_post_autosave()
    1575  * @uses add_query_arg()
    1576  * @uses wp_create_nonce()
    1577  *
    15781565 * @return str URL to redirect to show the preview
    15791566 */
    15801567function post_preview() {
  • src/wp-admin/includes/screen.php

     
    177177 * Set the current screen object
    178178 *
    179179 * @since 3.0.0
    180  * @uses $current_screen
    181180 *
    182181 * @param mixed $hook_name Optional. The hook name (also known as the hook suffix) used to determine the screen,
    183182 *      or an existing screen object.
  • src/wp-admin/includes/template.php

     
    14661466 * The password is passed through {@link esc_attr()} to ensure that it
    14671467 * is safe for placing in an html attribute.
    14681468 *
    1469  * @uses attr
    14701469 * @since 2.7.0
    14711470 */
    14721471function the_post_password() {
     
    14991498 * A simple wrapper to display the "s" parameter in a GET URI. This function
    15001499 * should only be used when {@link the_search_query()} cannot.
    15011500 *
    1502  * @uses attr
    15031501 * @since 2.7.0
    15041502 *
    15051503 */
  • src/wp-includes/author-template.php

     
    1616 * @since 1.5.0
    1717 *
    1818 * @uses $authordata The current author's DB object.
    19  * @uses apply_filters() Calls 'the_author' hook on the author display name.
    2019 *
    2120 * @param string $deprecated Deprecated.
    2221 * @return string The author's display name.
     
    7170 *
    7271 * @since 2.8.0
    7372 *
    74  * @uses $post The current post's DB object.
    75  * @uses get_post_meta() Retrieves the ID of the author who last edited the current post.
    76  * @uses get_userdata() Retrieves the author's DB object.
    77  * @uses apply_filters() Calls 'the_modified_author' hook on the author display name.
    7873 * @return string The author's display name.
    7974 */
    8075function get_the_modified_author() {
     
    108103 * Retrieve the requested data of the author of the current post.
    109104 * @link http://codex.wordpress.org/Template_Tags/the_author_meta
    110105 * @since 2.8.0
    111  * @uses $authordata The current author's DB object (if $user_id not specified).
    112106 * @param string $field selects the field of the users record.
    113107 * @param int $user_id Optional. User ID.
    114108 * @return string The author's field from the current author's DB object.
     
    168162 *
    169163 * If the author has a home page set, return an HTML link, otherwise just return the
    170164 * author's name.
    171  *
    172  * @uses get_the_author_meta()
    173  * @uses get_the_author()
    174165 */
    175166function get_the_author_link() {
    176167        if ( get_the_author_meta('url') ) {
     
    189180 * @link http://codex.wordpress.org/Template_Tags/the_author_link
    190181 *
    191182 * @since 2.1.0
    192  *
    193  * @uses get_the_author_link()
    194183 */
    195184function the_author_link() {
    196185        echo get_the_author_link();
     
    201190 *
    202191 * @since 1.5.0
    203192 *
    204  * @uses $post The current post in the Loop's DB object.
    205  * @uses count_user_posts()
    206193 * @return int The number of posts by the author.
    207194 */
    208195function get_the_author_posts() {
     
    218205 *
    219206 * @link http://codex.wordpress.org/Template_Tags/the_author_posts
    220207 * @since 0.71
    221  * @uses get_the_author_posts() Echoes returned value from function.
    222208 */
    223209function the_author_posts() {
    224210        echo get_the_author_posts();
     
    233219 *
    234220 * @link http://codex.wordpress.org/Template_Tags/the_author_posts_link
    235221 * @since 1.2.0
    236  * @uses $authordata The current author's DB object.
    237  * @uses get_author_posts_url()
    238  * @uses get_the_author()
    239222 * @param string $deprecated Deprecated.
    240223 */
    241224function the_author_posts_link($deprecated = '') {
  • src/wp-includes/bookmark.php

     
    6060 * Retrieve single bookmark data item or field.
    6161 *
    6262 * @since 2.3.0
    63  * @uses get_bookmark() Gets bookmark object using $bookmark as ID
    64  * @uses sanitize_bookmark_field() Sanitizes Bookmark field based on $context.
    6563 *
    6664 * @param string $field The name of the data field to return
    6765 * @param int $bookmark The bookmark ID to get field
     
    407405 * Deletes bookmark cache
    408406 *
    409407 * @since 2.7.0
    410  * @uses wp_cache_delete() Deletes the contents of 'get_bookmarks'
    411408 */
    412409function clean_bookmark_cache( $bookmark_id ) {
    413410        wp_cache_delete( $bookmark_id, 'bookmark' );
  • src/wp-includes/category-template.php

     
    6666 * Retrieve post categories.
    6767 *
    6868 * @since 0.71
    69  * @uses $post
    7069 *
    7170 * @param int $id Optional, default to current post ID. The post ID.
    7271 * @return array
     
    248247 * As of 2.7, the function can be used anywhere if it is provided a post ID or post object.
    249248 *
    250249 * @since 1.2.0
    251  * @uses has_category()
    252250 *
    253251 * @param int|string|array $category Category ID, name or slug, or array of said.
    254252 * @param int|object $post Optional. Post to check instead of the current post. (since 2.7.0)
  • src/wp-includes/category.php

     
    6363 * The category will converted to maintain backwards compatibility.
    6464 *
    6565 * @since 1.5.1
    66  * @uses get_term() Used to get the category data from the taxonomy.
    6766 *
    6867 * @param int|object $category Category ID or Category row object
    6968 * @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N
     
    210209 * Sanitizes category data based on context.
    211210 *
    212211 * @since 2.3.0
    213  * @uses sanitize_term() See this function for what context are supported.
    214212 *
    215213 * @param object|array $category Category data
    216214 * @param string $context Optional. Default is 'display'.
     
    224222 * Sanitizes data in single category key field.
    225223 *
    226224 * @since 2.3.0
    227  * @uses sanitize_term_field() See function for more details.
    228225 *
    229226 * @param string $field Category key to sanitize
    230227 * @param mixed $value Category value to sanitize
     
    243240 *
    244241 * @since 2.3.0
    245242 * @see get_terms() For list of arguments to pass.
    246  * @uses apply_filters() Calls 'get_tags' hook on array of tags and with $args.
    247243 *
    248244 * @param string|array $args Tag arguments to use when retrieving tags.
    249245 * @return array List of tags.
     
    297293 * Remove the category cache data based on ID.
    298294 *
    299295 * @since 2.1.0
    300  * @uses clean_term_cache() Clears the cache for the category based on ID
    301296 *
    302297 * @param int $id Category ID
    303298 */
  • src/wp-includes/class-http.php

     
    17851785         * some proxies can not handle this. We also have the constant available for defining other
    17861786         * hosts that won't be sent through the proxy.
    17871787         *
    1788          * @uses WP_PROXY_BYPASS_HOSTS
    17891788         * @since 2.8.0
    17901789         *
    17911790         * @param string $uri URI to check.
  • src/wp-includes/class-oembed.php

     
    565565 * @access private
    566566 *
    567567 * @see WP_oEmbed
    568  * @uses WP_oEmbed
    569568 *
    570569 * @return WP_oEmbed object.
    571570 */
  • src/wp-includes/class-wp-customize-manager.php

     
    12831283 * Returns either '', a 3 or 6 digit hex color (without a #), or null.
    12841284 *
    12851285 * @since 3.4.0
    1286  * @uses sanitize_hex_color()
    12871286 *
    12881287 * @param string $color
    12891288 * @return string|null
  • src/wp-includes/class-wp-customize-setting.php

     
    556556
    557557        /**
    558558         * @since 3.4.0
    559          * @uses remove_theme_mod()
    560559         *
    561560         * @param $value
    562561         */
  • src/wp-includes/class-wp-embed.php

     
    4343         * calls {@link do_shortcode()}, and then re-registers the old shortcodes.
    4444         *
    4545         * @uses $shortcode_tags
    46          * @uses remove_all_shortcodes()
    47          * @uses add_shortcode()
    48          * @uses do_shortcode()
    4946         *
    5047         * @param string $content Content to parse
    5148         * @return string Content with shortcode parsed
     
    122119         * Attempts to convert a URL into embed HTML. Starts by checking the URL against the regex of the registered embed handlers.
    123120         * If none of the regex matches and it's enabled, then the URL will be given to the {@link WP_oEmbed} class.
    124121         *
    125          * @uses wp_oembed_get()
    126          * @uses wp_parse_args()
    127          * @uses wp_embed_defaults()
    128          * @uses WP_Embed::maybe_make_link()
    129          * @uses get_option()
    130          * @uses author_can()
    131          * @uses wp_cache_get()
    132          * @uses wp_cache_set()
    133          * @uses get_post_meta()
    134          * @uses update_post_meta()
    135          *
    136122         * @param array $attr {
    137123         *     Shortcode attributes. Optional.
    138124         *
     
    332318        /**
    333319         * Callback function for {@link WP_Embed::autoembed()}.
    334320         *
    335          * @uses WP_Embed::shortcode()
    336          *
    337321         * @param array $match A regex match array.
    338322         * @return string The embed HTML on success, otherwise the original URL.
    339323         */
  • src/wp-includes/class-wp-theme.php

     
    855855         * for all other URLs returned by WP_Theme, so we pass it to the public function
    856856         * get_theme_root_uri() and allow it to run the theme_root_uri filter.
    857857         *
    858          * @uses get_theme_root_uri()
    859          *
    860858         * @since 3.4.0
    861859         * @access public
    862860         *
  • src/wp-includes/class-wp.php

     
    532532        /**
    533533         * Set up the Loop based on the query variables.
    534534         *
    535          * @uses WP::$query_vars
    536535         * @since 2.0.0
    537536         */
    538537        public function query_posts() {
  • src/wp-includes/comment.php

     
    853853 * Add meta data field to a comment.
    854854 *
    855855 * @since 2.9.0
    856  * @uses add_metadata
    857856 * @link http://codex.wordpress.org/Function_Reference/add_comment_meta
    858857 *
    859858 * @param int $comment_id Comment ID.
     
    874873 * allows removing all metadata matching key, if needed.
    875874 *
    876875 * @since 2.9.0
    877  * @uses delete_metadata
    878876 * @link http://codex.wordpress.org/Function_Reference/delete_comment_meta
    879877 *
    880878 * @param int $comment_id comment ID
     
    890888 * Retrieve comment meta field for a comment.
    891889 *
    892890 * @since 2.9.0
    893  * @uses get_metadata
    894891 * @link http://codex.wordpress.org/Function_Reference/get_comment_meta
    895892 *
    896893 * @param int $comment_id Comment ID.
     
    912909 * If the meta field for the comment does not exist, it will be added.
    913910 *
    914911 * @since 2.9.0
    915  * @uses update_metadata
    916912 * @link http://codex.wordpress.org/Function_Reference/update_comment_meta
    917913 *
    918914 * @param int $comment_id Comment ID.
     
    12501246 * Calculate what page number a comment will appear on for comment paging.
    12511247 *
    12521248 * @since 2.7.0
    1253  * @uses get_comment() Gets the full comment of the $comment_ID parameter.
    1254  * @uses get_option() Get various settings to control function and defaults.
    1255  * @uses get_page_of_comment() Used to loop up to top level comment.
    12561249 *
    12571250 * @param int $comment_ID Comment ID.
    12581251 * @param array $args Optional args.
     
    14401433 *
    14411434 * @since 2.0.0
    14421435 * @uses $wpdb
    1443  * @uses wp_transition_comment_status() Passes new and old comment status along with $comment object
    14441436 *
    14451437 * @param int $comment_id Comment ID
    14461438 * @param bool $force_delete Whether to bypass trash and force deletion. Default is false.
     
    15071499 *
    15081500 * @since 2.9.0
    15091501 *
    1510  * @uses wp_delete_comment() if trash is disabled
    1511  *
    15121502 * @param int $comment_id Comment ID.
    15131503 * @return bool True on success, false on failure.
    15141504 */
     
    20432033 * If the comment status is not in the list, then false is returned.
    20442034 *
    20452035 * @since 1.0.0
    2046  * @uses wp_transition_comment_status() Passes new and old comment status along with $comment object
    20472036 *
    20482037 * @param int $comment_id Comment ID.
    20492038 * @param string $comment_status New comment status, either 'hold', 'approve', 'spam', or 'trash'.
     
    21142103 *
    21152104 * @since 2.0.0
    21162105 * @uses $wpdb
    2117  * @uses wp_transition_comment_status() Passes new and old comment status along with $comment object
    21182106 *
    21192107 * @param array $commentarr Contains information on the comment.
    21202108 * @return int Comment was updated if value is 1, or was not updated if value is 0.
     
    24662454 *
    24672455 * @since 0.71
    24682456 * @uses $wp_version
    2469  * @uses IXR_Client
    24702457 *
    24712458 * @param string $content Post content to check for links.
    24722459 * @param int $post_ID Post ID.
     
    26092596 *
    26102597 * @since 1.2.0
    26112598 * @uses $wp_version
    2612  * @uses IXR_Client
    26132599 *
    26142600 * @param string $server Host of blog to connect to.
    26152601 * @param string $path Path to send the ping.
  • src/wp-includes/deprecated.php

     
    16991699 * and the rest of the content will be removed.
    17001700 *
    17011701 * @since 0.71
    1702  * @uses apply_filters() Calls 'the_content_rss' on the content before processing.
    17031702 *
    17041703 * @deprecated 2.9.0
    17051704 * @deprecated Use the_content_feed()
     
    18071806 * contains a context after its last vertical bar.
    18081807 *
    18091808 * @since 2.5.0
    1810  * @uses translate()
    18111809 * @deprecated 3.0.0
    18121810 * @deprecated Use _x()
    18131811 * @see _x()
     
    31523150 * @since 2.0.0
    31533151 * @deprecated 3.4.0
    31543152 *
    3155  * @uses do_action() Will call the 'clean_page_cache' hook action.
    3156  *
    31573153 * @param int $id Page ID to clean
    31583154 */
    31593155function clean_page_cache( $id ) {
  • src/wp-includes/feed.php

     
    7171 * 'default_feed' filter.
    7272 *
    7373 * @since 2.5.0
    74  * @uses apply_filters() Calls 'default_feed' hook on the default feed string.
    7574 *
    7675 * @return string Default feed, or for example 'rss2', 'atom', etc.
    7776 */
     
    165164 * Display the post title in the feed.
    166165 *
    167166 * @since 0.71
    168  * @uses get_the_title_rss() Used to retrieve current post title.
    169167 */
    170168function the_title_rss() {
    171169        echo get_the_title_rss();
     
    203201 * Display the post content for feeds.
    204202 *
    205203 * @since 2.9.0
    206  * @uses apply_filters() Calls 'the_content_feed' on the content before processing.
    207  * @see get_the_content()
    208204 *
    209205 * @param string $feed_type The type of feed. rss2 | atom | rss | rdf
    210206 */
     
    313309 * Retrieve the current comment author for use in the feeds.
    314310 *
    315311 * @since 2.0.0
    316  * @uses get_comment_author()
    317312 *
    318313 * @return string Comment Author
    319314 */
     
    343338 * Display the current comment content for use in the feeds.
    344339 *
    345340 * @since 1.0.0
    346  * @uses get_comment_text()
    347341 */
    348342function comment_text_rss() {
    349343        $comment_text = get_comment_text();
     
    454448 * attributes.
    455449 *
    456450 * @since 1.5.0
    457  * @uses get_post_custom() To get the current post enclosure metadata.
    458451 */
    459452function rss_enclosure() {
    460453        if ( post_password_required() )
     
    494487 * enclosure(s) consist of link HTML tag(s) with a URI and other attributes.
    495488 *
    496489 * @since 2.2.0
    497  * @uses get_post_custom() To get the current post enclosure metadata.
    498490 */
    499491function atom_enclosure() {
    500492        if ( post_password_required() )
  • src/wp-includes/formatting.php

     
    12261226 * Used for querying the database for a value from URL.
    12271227 *
    12281228 * @since 3.1.0
    1229  * @uses sanitize_title()
    12301229 *
    12311230 * @param string $title The string to be sanitized.
    12321231 * @return string The sanitized string.
     
    22302229 *
    22312230 * @since 1.2.0
    22322231 *
    2233  * @uses get_option() to retrieve the value of 'gmt_offset'.
    22342232 * @param string $string The date to be converted.
    22352233 * @param string $format The format string for the returned date (default is Y-m-d H:i:s)
    22362234 * @return string GMT version of the date provided.
     
    30233021 * is applied to the returned cleaned URL.
    30243022 *
    30253023 * @since 2.8.0
    3026  * @uses wp_kses_bad_protocol() To only permit protocols in the URL set
    3027  *              via $protocols or the common ones set in the function.
    30283024 *
    30293025 * @param string $url The URL to be cleaned.
    30303026 * @param array $protocols Optional. An array of acceptable protocols.
     
    30823078 * Performs esc_url() for database usage.
    30833079 *
    30843080 * @since 2.8.0
    3085  * @uses esc_url()
    30863081 *
    30873082 * @param string $url The URL to be cleaned.
    30883083 * @param array $protocols An array of acceptable protocols.
     
    34783473 *
    34793474 * KSES already converts lone greater than signs.
    34803475 *
    3481  * @uses wp_pre_kses_less_than_callback in the callback function.
    34823476 * @since 2.3.0
    34833477 *
    34843478 * @param string $text Text to be converted.
     
    34913485/**
    34923486 * Callback function used by preg_replace.
    34933487 *
    3494  * @uses esc_html to format the $matches text.
    34953488 * @since 2.3.0
    34963489 *
    34973490 * @param array $matches Populated by matches to preg_replace.
  • src/wp-includes/functions.php

     
    22742274 *
    22752275 * @since 2.8.6
    22762276 *
    2277  * @uses wp_get_upload_mime_types() to fetch the list of mime types
    2278  *
    22792277 * @param int|WP_User $user Optional. User to check. Defaults to current user.
    22802278 * @return array Array of mime types keyed by the file extension regex corresponding
    22812279 *               to those types.
     
    32003198 * Append the Widgets menu to the themes main menu.
    32013199 *
    32023200 * @since 2.2.0
    3203  *
    3204  * @uses $submenu The administration submenu list.
    32053201 */
    32063202function wp_widgets_add_menu() {
    32073203        global $submenu;
  • src/wp-includes/general-template.php

     
    1717 *
    1818 * @since 1.5.0
    1919 *
    20  * @uses locate_template()
    21  *
    2220 * @param string $name The name of the specialised header.
    2321 */
    2422function get_header( $name = null ) {
     
    5957 *
    6058 * @since 1.5.0
    6159 *
    62  * @uses locate_template()
    63  *
    6460 * @param string $name The name of the specialised footer.
    6561 */
    6662function get_footer( $name = null ) {
     
    10197 *
    10298 * @since 1.5.0
    10399 *
    104  * @uses locate_template()
    105  *
    106100 * @param string $name The name of the specialised sidebar.
    107101 */
    108102function get_sidebar( $name = null ) {
     
    150144 *
    151145 * @since 3.0.0
    152146 *
    153  * @uses locate_template()
    154  *
    155147 * @param string $slug The slug name for the generic template.
    156148 * @param string $name The name of the specialised template.
    157149 */
     
    307299 *
    308300 * @since 2.7.0
    309301 *
    310  * @uses wp_nonce_url() To protect against CSRF.
    311  * @uses site_url() To generate the log out URL.
    312  *
    313302 * @param string $redirect Path to redirect to on logout.
    314303 * @return string A log out URL.
    315304 */
     
    340329 *
    341330 * @since 2.7.0
    342331 *
    343  * @uses site_url() To generate the log in URL.
    344  *
    345332 * @param string $redirect Path to redirect to on login.
    346333 * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false.
    347334 * @return string A log in URL.
     
    373360 *
    374361 * @since 3.6.0
    375362 *
    376  * @uses site_url() To generate the registration URL.
    377  *
    378363 * @return string User registration URL.
    379364 */
    380365function wp_registration_url() {
     
    496481 *
    497482 * @since 2.8.0
    498483 *
    499  * @uses site_url() To generate the lost password URL
    500  *
    501484 * @param string $redirect Path to redirect to on login.
    502485 * @return string Lost password URL.
    503486 */
     
    14291412 * no posts for the month, then it will not be displayed.
    14301413 *
    14311414 * @since 1.0.0
    1432  * @uses calendar_week_mod()
    14331415 *
    14341416 * @param bool $initial Optional, default is true. Use initial calendar names.
    14351417 * @param bool $echo Optional, default is true. Set to false for return.
     
    17111693 *
    17121694 * @since 0.71
    17131695 *
    1714  * @uses get_the_date()
    17151696 * @param string $d Optional. PHP date format defaults to the date_format option if not specified.
    17161697 * @param string $before Optional. Output before the date.
    17171698 * @param string $after Optional. Output after the date.
     
    20322013 *
    20332014 * @since 0.71
    20342015 * @uses $wp_locale
    2035  * @uses $post
    20362016 */
    20372017function the_weekday() {
    20382018        global $wp_locale;
     
    23582338 * to ensure that it is safe for placing in an html attribute.
    23592339 *
    23602340 * @since 2.3.0
    2361  * @uses esc_attr()
    23622341 *
    23632342 * @param bool $escaped Whether the result is escaped. Default true.
    23642343 *      Only use when you are later escaping it. Do not use unescaped.
     
    23852364 * The search query string is passed through {@link esc_attr()}
    23862365 * to ensure that it is safe for placing in an html attribute.
    23872366 *
    2388  * @uses esc_attr()
    23892367 * @since 2.1.0
    23902368 */
    23912369function the_search_query() {
  • src/wp-includes/kses.php

     
    661661 *
    662662 * @access private
    663663 * @since 1.0.0
    664  * @uses wp_kses_attr()
    665664 *
    666665 * @param string $string Content to filter
    667666 * @param array $allowed_html Allowed HTML elements
     
    13181317 * Sanitize content with allowed HTML Kses rules.
    13191318 *
    13201319 * @since 1.0.0
    1321  * @uses $allowedtags
    13221320 *
    13231321 * @param string $data Content to filter, expected to be escaped with slashes
    13241322 * @return string Filtered content
     
    13311329 * Sanitize content with allowed HTML Kses rules.
    13321330 *
    13331331 * @since 2.9.0
    1334  * @uses $allowedtags
    13351332 *
    13361333 * @param string $data Content to filter, expected to not be escaped
    13371334 * @return string Filtered content
     
    13921389 * 'excerpt_save_pre', and 'content_filtered_save_pre' hooks.
    13931390 *
    13941391 * @since 2.0.0
    1395  * @uses add_filter() See description for what functions are added to what hooks.
    13961392 */
    13971393function kses_init_filters() {
    13981394        // Normal filtering
     
    14471443 * to have Kses filter the content. If the user does not have unfiltered_html
    14481444 * capability, then Kses filters are added.
    14491445 *
    1450  * @uses kses_remove_filters() Removes the Kses filters
    1451  * @uses kses_init_filters() Adds the Kses filters back if the user
    1452  *              does not have unfiltered HTML capability.
    14531446 * @since 2.0.0
    14541447 */
    14551448function kses_init() {
  • src/wp-includes/link-template.php

     
    18801880 * Can be either next post link or previous.
    18811881 *
    18821882 * @since 2.5.0
    1883  * @uses get_adjacent_post_link()
    18841883 *
    18851884 * @param string       $format         Link anchor format.
    18861885 * @param string       $link           Link permalink format.
     
    20482047 * Display the next posts page link.
    20492048 *
    20502049 * @since 0.71
    2051  * @uses get_next_posts_link()
    20522050 *
    20532051 * @param string $label Content for link text.
    20542052 * @param int $max_page Optional. Max pages.
     
    21262124 * Display the previous posts page link.
    21272125 *
    21282126 * @since 0.71
    2129  * @uses get_previous_posts_link()
    21302127 *
    21312128 * @param string $label Optional. Previous page link text.
    21322129 */
     
    26062603 *
    26072604 * @since 3.0.0
    26082605 *
    2609  * @uses get_home_url()
    2610  *
    26112606 * @param  string $path   (optional) Path relative to the home url.
    26122607 * @param  string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.
    26132608 * @return string Home url link with optional path appended.
     
    26752670 *
    26762671 * @since 3.0.0
    26772672 *
    2678  * @uses get_site_url()
    2679  *
    26802673 * @param string $path Optional. Path relative to the site url.
    26812674 * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
    26822675 * @return string Site url link with optional path appended.
     
    32583251 *  Attached to the wp_head action.
    32593252 *
    32603253 * @since 3.0.0
    3261  *
    3262  * @uses wp_get_shortlink()
    32633254 */
    32643255function wp_shortlink_wp_head() {
    32653256        $shortlink = wp_get_shortlink( 0, 'query' );
     
    32763267 * Attached to the wp action.
    32773268 *
    32783269 * @since 3.0.0
    3279  *
    3280  * @uses wp_get_shortlink()
    32813270 */
    32823271function wp_shortlink_header() {
    32833272        if ( headers_sent() )
  • src/wp-includes/media.php

     
    2525 * height as the second element.
    2626 *
    2727 * @since 2.5.0
    28  * @uses wp_constrain_dimensions() This function passes the widths and the heights.
    2928 *
    3029 * @param int $width Width of the image
    3130 * @param int $height Height of the image
     
    684683 * @since 2.5.0
    685684 *
    686685 * @see add_image_size()
    687  * @uses wp_get_attachment_image_src() Gets attachment file URL and dimensions
    688686 *
    689687 * @param int          $attachment_id Image attachment ID.
    690688 * @param string|array $size          Optional. Default 'thumbnail'.
     
    19951993 *
    19961994 * @since 3.5.0
    19971995 * @see get_attachment_taxonomies()
    1998  * @uses get_taxonomies()
    19991996 *
    20001997 * @param string $output The type of output to return, either taxonomy 'names' or 'objects'. 'names' is the default.
    20011998 * @return array The names of all taxonomy of $object_type.
     
    20992096 * Based on a supplied width/height example, return the biggest possible dimensions based on the max width/height.
    21002097 *
    21012098 * @since 2.9.0
    2102  * @uses wp_constrain_dimensions() This function passes the widths and the heights.
    21032099 *
    21042100 * @param int $example_width The width of an example embed.
    21052101 * @param int $example_height The height of an example embed.
     
    21222118 * @since 2.9.0
    21232119 * @see WP_oEmbed
    21242120 *
    2125  * @uses _wp_oembed_get_object()
    2126  * @uses WP_oEmbed::get_html()
    2127  *
    21282121 * @param string $url The URL that should be embedded.
    21292122 * @param array $args Additional arguments and parameters.
    21302123 * @return bool|string False on failure or the embed HTML on success.
     
    21412134 * @since 2.9.0
    21422135 * @see WP_oEmbed
    21432136 *
    2144  * @uses _wp_oembed_get_object()
    2145  *
    21462137 * @param string $format The format of URL that this provider can handle. You can use asterisks as wildcards.
    21472138 * @param string $provider The URL to the oEmbed provider.
    21482139 * @param boolean $regex Whether the $format parameter is in a regex format.
     
    21642155 * @since 3.5.0
    21652156 * @see WP_oEmbed
    21662157 *
    2167  * @uses _wp_oembed_get_object()
    2168  *
    21692158 * @param string $format The URL format for the oEmbed provider to remove.
    21702159 */
    21712160function wp_oembed_remove_provider( $format ) {
  • src/wp-includes/meta.php

     
    576576 *
    577577 * @since 3.3.0
    578578 *
    579  * @uses get_metadata_by_mid() Calls get_metadata_by_mid() to fetch the meta key, value
    580  *              and object_id of the given meta_id.
    581  *
    582579 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
    583580 * @param int $meta_id ID for a specific meta row
    584581 * @param string $meta_value Metadata value
     
    670667 *
    671668 * @since 3.3.0
    672669 *
    673  * @uses get_metadata_by_mid() Calls get_metadata_by_mid() to fetch the meta key, value
    674  *              and object_id of the given meta_id.
    675  *
    676670 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
    677671 * @param int $meta_id ID for a specific meta row
    678672 * @return bool True on successful delete, false on failure.
  • src/wp-includes/ms-deprecated.php

     
    232232 * @since MU
    233233 * @deprecated 3.3.0
    234234 * @deprecated Use wp_redirect()
    235  * @uses wpmu_admin_redirect_add_updated_param()
    236235 *
    237236 * @param string $url
    238237 */
     
    297296 * @since MU
    298297 * @deprecated 3.6.0
    299298 * @deprecated Use get_user_by()
    300  * @uses get_user_by()
    301299 *
    302300 * @param string $string Either an email address or a login.
    303301 * @return int
  • src/wp-includes/ms-functions.php

     
    1111 * Gets the network's site and user counts.
    1212 *
    1313 * @since MU 1.0
    14  * @uses get_blog_count()
    15  * @uses get_user_count()
    1614 *
    1715 * @return array Site and user count for the network.
    1816 */
     
    5856 * is returned.
    5957 *
    6058 * @since MU 1.0
    61  * @uses get_blogs_of_user()
    62  * @uses add_user_to_blog()
    63  * @uses get_blog_details()
    6459 *
    6560 * @param int $user_id The unique ID of the user
    6661 * @return object The blog object
     
    298293 * Create an empty blog.
    299294 *
    300295 * @since MU 1.0
    301  * @uses install_blog()
    302296 *
    303297 * @param string $domain The new blog's domain.
    304298 * @param string $path The new blog's path.
     
    455449 * relevant errors if necessary.
    456450 *
    457451 * @since MU
    458  * @uses is_email_address_unsafe()
    459  * @uses username_exists()
    460  * @uses email_exists()
    461452 *
    462453 * @param string $user_name The login name provided by the user.
    463454 * @param string $user_email The email provided by the user.
     
    580571 * the way that WordPress validates new site signups.
    581572 *
    582573 * @since MU
    583  * @uses domain_exists()
    584  * @uses username_exists()
    585574 *
    586575 * @param string $blogname The blog name provided by the user. Must be unique.
    587576 * @param string $blog_title The blog title provided by the user.
     
    713702 * Record site signup information for future activation.
    714703 *
    715704 * @since MU
    716  * @uses wpmu_signup_blog_notification()
    717705 *
    718706 * @param string $domain The requested domain.
    719707 * @param string $path The requested path.
     
    749737 * new site registration is not.
    750738 *
    751739 * @since MU
    752  * @uses wpmu_signup_user_notification()
    753740 *
    754741 * @param string $user The user's requested login name.
    755742 * @param string $user_email The user's email address.
     
    978965 * by a Super Admin).
    979966 *
    980967 * @since MU
    981  * @uses wp_generate_password()
    982  * @uses wpmu_welcome_user_notification()
    983  * @uses add_user_to_blog()
    984  * @uses wpmu_create_user()
    985  * @uses wpmu_create_blog()
    986  * @uses wpmu_welcome_notification()
    987968 *
    988969 * @param string $key The activation key provided to the user.
    989970 * @return array An array containing information about the activated user and/or blog
     
    10781059 * use 'user_register').
    10791060 *
    10801061 * @since MU
    1081  * @uses wp_create_user()
    10821062 *
    10831063 * @param string $user_name The new user's login name.
    10841064 * @param string $password The new user's password.
     
    11211101 * root domain (eg 'blog1.example.com'), and $path is '/'.
    11221102 *
    11231103 * @since MU
    1124  * @uses domain_exists()
    1125  * @uses insert_blog()
    1126  * @uses wp_install_defaults()
    1127  * @uses add_user_to_blog()
    11281104 *
    11291105 * @param string $domain The new site's domain.
    11301106 * @param string $path The new site's path.
     
    12481224 * the notification email.
    12491225 *
    12501226 * @since MU
    1251  * @uses apply_filters() Filter newuser_notify_siteadmin to change the content of the email message
    12521227 *
    12531228 * @param int $user_id The new user's ID.
    12541229 * @return bool
     
    13541329 * points to the new blog.
    13551330 *
    13561331 * @since MU
    1357  * @uses make_db_current_silent()
    1358  * @uses populate_roles()
    13591332 *
    13601333 * @param int $blog_id The value returned by insert_blog().
    13611334 * @param string $blog_title The title of the new site.
     
    14081381 * @since MU
    14091382 * @deprecated MU
    14101383 * @deprecated Use wp_install_defaults()
    1411  * @uses wp_install_defaults()
    14121384 *
    14131385 * @param int $blog_id Ignored in this function.
    14141386 * @param int $user_id
     
    16281600 * the most recent post_date_gmt.
    16291601 *
    16301602 * @since MU
    1631  * @uses get_blogs_of_user()
    16321603 *
    16331604 * @param int $user_id
    16341605 * @return array Contains the blog_id, post_id, post_date_gmt, and post_gmt_ts
     
    16751646 * a blog has exceeded its allowed upload space.
    16761647 *
    16771648 * @since MU
    1678  * @uses recurse_dirsize()
    16791649 *
    16801650 * @param string $directory
    16811651 * @return int
     
    18891859 * Add a nonce field to the signup page.
    18901860 *
    18911861 * @since MU
    1892  * @uses wp_nonce_field()
    18931862 */
    18941863function signup_nonce_fields() {
    18951864        $id = mt_rand();
     
    19011870 * Process the signup nonce created in signup_nonce_fields().
    19021871 *
    19031872 * @since MU
    1904  * @uses wp_create_nonce()
    19051873 *
    19061874 * @param array $result
    19071875 * @return array
     
    19471915 * added, as when a user is invited through the regular WP Add User interface.
    19481916 *
    19491917 * @since MU
    1950  * @uses add_existing_user_to_blog()
    19511918 */
    19521919function maybe_add_existing_user_to_blog() {
    19531920        if ( false === strpos( $_SERVER[ 'REQUEST_URI' ], '/newbloguser/' ) )
     
    19731940 * Add a user to a blog based on details from maybe_add_existing_user_to_blog().
    19741941 *
    19751942 * @since MU
    1976  * @uses add_user_to_blog()
    19771943 *
    19781944 * @param array $details
    19791945 */
     
    20311997 * Check to see whether a user is marked as a spammer, based on user login.
    20321998 *
    20331999 * @since MU
    2034  * @uses get_user_by()
    20352000 *
    20362001 * @param string|WP_User $user Optional. Defaults to current user. WP_User object,
    20372002 *      or user login name as a string.
     
    20542019 * Public blogs have a setting of 1, private blogs are 0.
    20552020 *
    20562021 * @since MU
    2057  * @uses update_blog_status()
    20582022 *
    20592023 * @param int $old_value
    20602024 * @param int $value The new public value
     
    20692033 * Check whether a usermeta key has to do with the current blog.
    20702034 *
    20712035 * @since MU
    2072  * @uses wp_get_current_user()
    20732036 *
    20742037 * @param string $key
    20752038 * @param int $user_id Optional. Defaults to current user.
     
    22062169 * on a network when a site is created or its status is updated.
    22072170 *
    22082171 * @since 3.7.0
    2209  *
    2210  * @uses wp_update_network_site_counts()
    22112172 */
    22122173function wp_maybe_update_network_site_counts() {
    22132174        $is_small_network = ! wp_is_large_network( 'sites' );
     
    22352196 * on a network when a user is created or its status is updated.
    22362197 *
    22372198 * @since 3.7.0
    2238  *
    2239  * @uses wp_update_network_user_counts()
    22402199 */
    22412200function wp_maybe_update_network_user_counts() {
    22422201        $is_small_network = ! wp_is_large_network( 'users' );
  • src/wp-includes/nav-menu.php

     
    1212 *
    1313 * @since 3.0.0
    1414 *
    15  * @uses get_term
    16  * @uses get_term_by
    17  *
    1815 * @param string $menu Menu ID, slug, or name.
    1916 * @return mixed false if $menu param isn't supplied or term does not exist, menu object if successful.
    2017 */
  • src/wp-includes/option.php

     
    141141/**
    142142 * Print option value after sanitizing for forms.
    143143 *
    144  * @uses attr Sanitizes value.
    145144 * @since 1.5.0
    146145 *
    147146 * @param string $option Option name.
  • src/wp-includes/pluggable.php

     
    7272 * @since 0.71
    7373 *
    7474 * @uses $current_user Checks if the current user is set
    75  * @uses wp_validate_auth_cookie() Retrieves current logged in user.
    7675 *
    7776 * @return bool|null False on XML-RPC Request and invalid auth cookie. Null when current user set.
    7877 */
     
    12151214 *
    12161215 * @since 2.3.0
    12171216 *
    1218  * @uses wp_validate_redirect() To validate the redirect is to an allowed host.
    1219  *
    12201217 * @return void Does not return anything
    12211218 **/
    12221219function wp_safe_redirect($location, $status = 302) {
     
    18721869 * Get hash of given string.
    18731870 *
    18741871 * @since 2.0.3
    1875  * @uses wp_salt() Get WordPress salt
    18761872 *
    18771873 * @param string $data Plain text to hash
    18781874 * @return string Hash of $data
     
    20692065 * @since 2.5.0
    20702066 *
    20712067 * @uses $wpdb WordPress database object for queries
    2072  * @uses wp_hash_password() Used to encrypt the user's password before passing to the database
    20732068 *
    20742069 * @param string $password The plaintext new user password
    20752070 * @param int $user_id User ID
  • src/wp-includes/plugin.php

     
    357357 *
    358358 * @since 3.9.0
    359359 *
    360  * @uses current_filter()
    361  *
    362360 * @return string Hook name of the current action.
    363361 */
    364362function current_action() {
     
    401399 *
    402400 * @since 3.9.0
    403401 *
    404  * @uses doing_filter()
    405  *
    406402 * @param string|null $action Optional. Action to check. Defaults to null, which checks
    407403 *                            if any action is currently being run.
    408404 * @return bool Whether the action is currently in the stack.
     
    421417 *
    422418 * @since 1.2.0
    423419 *
    424  * @uses add_filter() Adds an action. Parameter list and functionality are the same.
    425  *
    426420 * @param string   $tag             The name of the action to which the $function_to_add is hooked.
    427421 * @param callback $function_to_add The name of the function you wish to be called.
    428422 * @param int      $priority        Optional. Used to specify the order in which the functions
     
    646640 *
    647641 * @since 1.5.0
    648642 *
    649  * @uses WP_PLUGIN_DIR, WPMU_PLUGIN_DIR
    650  *
    651643 * @param string $file The filename of plugin.
    652644 * @return string The name of a plugin.
    653645 */
     
    832824 * @since 2.5.0
    833825 * @access private
    834826 *
    835  * @uses $wp_filter Used to process all of the functions in the 'all' hook.
    836  *
    837827 * @param array $args The collected parameters from the hook that was called.
    838828 */
    839829function _wp_call_all_hook($args) {
  • src/wp-includes/post-formats.php

     
    3636 *
    3737 * @since 3.1.0
    3838 *
    39  * @uses has_term()
    40  *
    4139 * @param string|array $format Optional. The format or formats to check.
    4240 * @param object|int $post Optional. The post to check. If not supplied, defaults to the current post if used in the loop.
    4341 * @return bool True if the post has any of the given formats (or any format, if no format specified), false otherwise.
     
    108106 *
    109107 * @since 3.1.0
    110108 *
    111  * @uses get_post_format_strings()
    112  *
    113109 * @return array The array of post format slugs.
    114110 */
    115111function get_post_format_slugs() {
     
    122118 *
    123119 * @since 3.1.0
    124120 *
    125  * @uses get_post_format_strings()
    126  *
    127121 * @param string $slug A post format slug.
    128122 * @return string The translated post format name.
    129123 */
  • src/wp-includes/post-template.php

     
    2121 * Retrieve the ID of the current item in the WordPress Loop.
    2222 *
    2323 * @since 2.1.0
    24  * @uses $post
    2524 *
    2625 * @return int|bool The ID of the current item in the WordPress Loop. False if $post is not set.
    2726 */
     
    907906 *
    908907 * @internal This will probably change at some point...
    909908 * @since 1.2.0
    910  * @uses apply_filters() Calls 'the_meta_key' on list item HTML content, with key and value as separate parameters.
    911909 */
    912910function the_meta() {
    913911        if ( $keys = get_post_custom_keys() ) {
     
    14661464 * Retrieve an attachment page link using an image or icon, if possible.
    14671465 *
    14681466 * @since 2.5.0
    1469  * @uses apply_filters() Calls 'wp_get_attachment_link' filter on HTML content with same parameters as function.
    14701467 *
    14711468 * @param int|WP_Post $id Optional. Post ID or post object.
    14721469 * @param string $size Optional, default is 'thumbnail'. Size of image, either array or string.
     
    16021599 * specific to that template.
    16031600 *
    16041601 * @since 2.5.0
    1605  * @uses $wp_query
    16061602 *
    16071603 * @param string $template The specific template name if specific matching is required.
    16081604 * @return bool True on success, false on failure.
     
    16491645 *
    16501646 * @since 2.6.0
    16511647 *
    1652  * @uses date_i18n()
    1653  *
    16541648 * @param int|object $revision Revision ID or revision object.
    16551649 * @param bool $link Optional, default is true. Link to revisions's page?
    16561650 * @return string i18n formatted datetimestamp or localized 'Current Revision'.
     
    16861680 *
    16871681 * @since 3.6.0
    16881682 *
    1689  * @uses date_i18n()
    1690  *
    16911683 * @param int|object $revision Revision ID or revision object.
    16921684 * @param bool $link Optional, default is true. Link to revisions's page?
    16931685 * @return string gravatar, user, i18n formatted datetimestamp or localized 'Current Revision'.
     
    17371729 *
    17381730 * @since 2.6.0
    17391731 *
    1740  * @uses wp_get_post_revisions()
    1741  * @uses wp_post_revision_title_expanded()
    1742  * @uses get_edit_post_link()
    1743  * @uses get_the_author_meta()
    1744  *
    17451732 * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
    17461733 * @param string $type 'all' (default), 'revision' or 'autosave'
    17471734 * @return null
  • src/wp-includes/post.php

     
    29422942 *
    29432943 * @since 2.3.0
    29442944 *
    2945  * @uses wp_get_object_terms()
    2946  *
    29472945 * @param int   $post_id Optional. The Post ID. Does not default to the ID of the
    29482946 *                       global $post. Defualt 0.
    29492947 * @param array $args Optional. Overwrite the defaults
     
    29622960 *
    29632961 * @since 2.8.0
    29642962 *
    2965  * @uses wp_get_object_terms()
    2966  *
    29672963 * @param int    $post_id  Optional. The Post ID. Does not default to the ID of the
    29682964 *                         global $post. Default 0.
    29692965 * @param string $taxonomy Optional. The taxonomy for which to retrieve terms. Default 'post_tag'.
  • src/wp-includes/query.php

     
    406406 *
    407407 * @see WP_Query::is_front_page()
    408408 * @since 2.5.0
    409  * @uses is_home()
    410  * @uses get_option()
    411409 *
    412410 * @return bool True, if front of site.
    413411 */
     
    23572355         *
    23582356         * @since 1.5.0
    23592357         * @access public
    2360          * @uses do_action_ref_array() Calls 'pre_get_posts' hook before retrieving posts.
    23612358         *
    23622359         * @return array List of posts.
    23632360         */
     
    36923689         *
    36933690         * @since 1.5.0
    36943691         * @access public
    3695          * @uses $post
    3696          * @uses do_action_ref_array() Calls 'loop_start' if loop has just started
    36973692         */
    36983693        public function the_post() {
    36993694                global $post;
     
    37203715         *
    37213716         * @since 1.5.0
    37223717         * @access public
    3723          * @uses do_action_ref_array() Calls 'loop_end' if loop is ended
    37243718         *
    37253719         * @return bool True if posts are available, false if end of loop.
    37263720         */
     
    37783772         * @since 2.2.0
    37793773         * @access public
    37803774         * @global object $comment Current comment.
    3781          * @uses do_action() Calls 'comment_loop_start' hook when first comment is processed.
    37823775         */
    37833776        public function the_comment() {
    37843777                global $comment;
     
    42804273         * Otherwise the same as @see WP_Query::is_home()
    42814274         *
    42824275         * @since 3.1.0
    4283          * @uses is_home()
    4284          * @uses get_option()
    42854276         *
    42864277         * @return bool True, if front of site.
    42874278         */
     
    46884679 * @since 1.5.0
    46894680 *
    46904681 * @param object $post Post data.
    4691  * @uses do_action_ref_array() Calls 'the_post'
    46924682 * @return bool True when finished.
    46934683 */
    46944684function setup_postdata( $post ) {
  • src/wp-includes/revision.php

     
    7777 *
    7878 * @since 2.6.0
    7979 *
    80  * @uses _wp_put_post_revision()
    81  *
    8280 * @param int $post_id The ID of the post to save as a revision.
    8381 * @return mixed Null or 0 if error, new revision ID, if success.
    8482 */
     
    192190 *
    193191 * @since 2.6.0
    194192 *
    195  * @uses wp_get_post_revisions()
    196  *
    197193 * @param int $post_id The post ID.
    198194 * @param int $user_id optional The post author ID.
    199195 * @return object|bool The autosaved data or false on failure or when no autosave exists.
     
    252248 * @since 2.6.0
    253249 * @access private
    254250 *
    255  * @uses wp_insert_post()
    256  *
    257251 * @param int|object|array $post Post ID, post object OR post array.
    258252 * @param bool $autosave Optional. Is the revision an autosave?
    259253 * @return mixed WP_Error or 0 if error, new revision ID if success.
     
    296290 *
    297291 * @since 2.6.0
    298292 *
    299  * @uses get_post()
    300  *
    301293 * @param int|object $post The post ID or object.
    302294 * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N.
    303295 * @param string $filter Optional sanitation filter. @see sanitize_post().
     
    329321 *
    330322 * @since 2.6.0
    331323 *
    332  * @uses wp_get_post_revision()
    333  * @uses wp_update_post()
    334  *
    335324 * @param int|object $revision_id Revision ID or revision object.
    336325 * @param array $fields Optional. What fields to restore from. Defaults to all.
    337326 * @return mixed Null if error, false if no fields to restore, (int) post ID if success.
     
    390379 *
    391380 * @since 2.6.0
    392381 *
    393  * @uses wp_get_post_revision()
    394  * @uses wp_delete_post()
    395  *
    396382 * @param int|object $revision_id Revision ID or revision object.
    397383 * @return mixed Null or WP_Error if error, deleted post if success.
    398384 */
     
    424410 *
    425411 * @since 2.6.0
    426412 *
    427  * @uses get_children()
    428  *
    429413 * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
    430414 * @return array An array of revisions, or an empty array if none.
    431415 */
     
    453437 *
    454438 * @since 3.6.0
    455439 *
    456  * @uses wp_revisions_to_keep()
    457  *
    458440 * @param object $post The post object.
    459441 * @return bool True if number of revisions to keep isn't zero, false otherwise.
    460442 */
     
    468450 *
    469451 * @since 3.6.0
    470452 *
    471  * @uses post_type_supports()
    472  *
    473453 * @param object $post The post object.
    474454 * @return int The number of revisions to keep.
    475455 */
     
    587567 * @since 3.6.0
    588568 * @access private
    589569 *
    590  * @uses wp_get_post_revisions()
    591  *
    592570 * @param object $post Post object
    593571 * @param array $revisions Current revisions of the post
    594572 * @return bool true if the revisions were upgraded, false if problems
  • src/wp-includes/shortcodes.php

     
    185185 * @since 2.5.0
    186186 *
    187187 * @uses $shortcode_tags
    188  * @uses get_shortcode_regex() Gets the search pattern for searching shortcodes.
    189188 *
    190189 * @param string $content Content to search for shortcodes
    191190 * @return string Content with shortcodes filtered out.
  • src/wp-includes/taxonomy.php

     
    134134 *
    135135 * @since 3.0.0
    136136 * @uses $wp_taxonomies
    137  * @see register_taxonomy
    138137 *
    139138 * @param array $args An array of key => value arguments to match against the taxonomy objects.
    140139 * @param string $output The type of output to return, either taxonomy 'names' or 'objects'. 'names' is the default.
     
    200199 * @since 2.3.0
    201200 *
    202201 * @uses $wp_taxonomies
    203  * @uses taxonomy_exists() Checks whether taxonomy exists
    204202 *
    205203 * @param string $taxonomy Name of taxonomy object to return
    206204 * @return object|bool The Taxonomy Object or false if $taxonomy doesn't exist
     
    242240 *
    243241 * @since 2.3.0
    244242 *
    245  * @uses taxonomy_exists() Checks whether taxonomy exists
    246  * @uses get_taxonomy() Used to get the taxonomy object
    247  *
    248243 * @param string $taxonomy Name of taxonomy object
    249244 * @return bool Whether the taxonomy is hierarchical
    250245 */
     
    568563 * @since 2.3.0
    569564 *
    570565 * @uses $wpdb
    571  * @uses wp_parse_args() Creates an array from string $args.
    572566 *
    573567 * @param int|array $term_ids Term id or array of term ids of terms that will be used
    574568 * @param string|array $taxonomies String of taxonomy name or Array of string values of taxonomy names
     
    12681262 * @since 2.3.0
    12691263 *
    12701264 * @uses $wpdb
    1271  * @uses sanitize_term() Cleanses the term based on $filter context before returning.
    12721265 * @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param.
    12731266 *
    12741267 * @param int|object $term If integer, will get from database. If object will apply filters and return $term.
     
    13641357 * @since 2.3.0
    13651358 *
    13661359 * @uses $wpdb
    1367  * @uses sanitize_term() Cleanses the term based on $filter context before returning.
    13681360 * @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param.
    13691361 *
    13701362 * @param string $field Either 'slug', 'name', 'id' (term_id), or 'term_taxonomy_id'
     
    14551447 * @since 2.3.0
    14561448 *
    14571449 * @uses $wpdb
    1458  * @uses _get_term_hierarchy()
    1459  * @uses get_term_children() Used to get the children of both $taxonomy and the parent $term
    14601450 *
    14611451 * @param string $term_id ID of Term to get children
    14621452 * @param string $taxonomy Taxonomy Name
     
    14961486 *
    14971487 * @since 2.3.0
    14981488 *
    1499  * @uses sanitize_term_field() Passes the return value in sanitize_term_field on success.
    1500  *
    15011489 * @param string $field Term field to fetch
    15021490 * @param int $term Term ID
    15031491 * @param string $taxonomy Taxonomy Name
     
    15271515 *
    15281516 * @since 2.3.0
    15291517 *
    1530  * @uses sanitize_term() Passes the return value on success
    1531  *
    15321518 * @param int|object $id Term ID or Object
    15331519 * @param string $taxonomy Taxonomy Name
    15341520 * @return mixed|null|WP_Error Will return empty string if $term is not an object.
     
    21052091 *
    21062092 * @since 2.3.0
    21072093 *
    2108  * @uses sanitize_term_field Used to sanitize all fields in a term
    2109  *
    21102094 * @param array|object $term The term to check
    21112095 * @param string $taxonomy The taxonomy name to use
    21122096 * @param string $context Default is 'display'.
     
    23152299 *
    23162300 * @since 2.3.0
    23172301 *
    2318  * @uses get_terms()
    2319  * @uses wp_parse_args() Turns strings into arrays and merges defaults into an array.
    2320  *
    23212302 * @param string $taxonomy Taxonomy name
    23222303 * @param array|string $args Overwrite defaults. See get_terms()
    23232304 * @return int|WP_Error How many terms are in $taxonomy. WP_Error if $taxonomy does not exist.
     
    23452326 * taxonomy itself.
    23462327 *
    23472328 * @since 2.3.0
    2348  * @uses wp_remove_object_terms()
    23492329 *
    23502330 * @param int $object_id The term Object Id that refers to the term
    23512331 * @param string|array $taxonomies List of Taxonomy Names or single Taxonomy name.
     
    25442524 * Deletes one existing category.
    25452525 *
    25462526 * @since 2.0.0
    2547  * @uses wp_delete_term()
    25482527 *
    25492528 * @param int $cat_ID
    25502529 * @return mixed Returns true if completes delete action; false if term doesn't exist;
     
    29672946 * exists under.
    29682947 *
    29692948 * @since 2.3.0
    2970  * @uses wp_remove_object_terms()
    29712949 *
    29722950 * @param int              $object_id The object to relate to.
    29732951 * @param array|int|string $terms     A single term slug, single term id, or array of either term slugs or ids.
     
    30913069 * Add term(s) associated with a given object.
    30923070 *
    30933071 * @since 3.6.0
    3094  * @uses wp_set_object_terms()
    30953072 *
    30963073 * @param int $object_id The ID of the object to which the terms will be added.
    30973074 * @param array|int|string $terms The slug(s) or ID(s) of the term(s) to add.
     
    36903667 *
    36913668 * @since 2.3.0
    36923669 *
    3693  * @uses wp_cache_get() Retrieves taxonomy relationship from cache
    3694  *
    36953670 * @param int|array $id Term object ID
    36963671 * @param string $taxonomy Taxonomy Name
    36973672 * @return bool|array Empty array if $terms found, but not $taxonomy. False if nothing is in cache for $taxonomy and $id.
     
    37153690 * for each term and it also increases for each taxonomy the term belongs to.
    37163691 *
    37173692 * @since 2.3.0
    3718  * @uses wp_get_object_terms() Used to get terms from the database to update
    37193693 *
    37203694 * @param string|array $object_ids Single or list of term object ID(s)
    37213695 * @param array|string $object_type The taxonomy object type
     
    38063780 * @access private
    38073781 * @since 2.3.0
    38083782 *
    3809  * @uses update_option() Stores all of the children in "$taxonomy_children"
    3810  *       option. That is the name of the taxonomy, immediately followed by '_children'.
    3811  *
    38123783 * @param string $taxonomy Taxonomy Name
    38133784 * @return array Empty if $taxonomy isn't hierarchical or returns children as Term IDs.
    38143785 */
     
    41364107 * 'template' : The template to use for displaying the taxonomy terms.
    41374108 *
    41384109 * @since 2.5.0
    4139  * @uses get_the_taxonomies()
    41404110 *
    41414111 * @param array $args Override the defaults.
    41424112 */
     
    42144184 *
    42154185 * @since 2.5.0
    42164186 *
    4217  * @uses get_object_taxonomies()
    4218  *
    42194187 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
    42204188 * @return array
    42214189 */
     
    42334201 * If no terms are given, determines if object is associated with any terms in the given taxonomy.
    42344202 *
    42354203 * @since 2.7.0
    4236  * @uses get_object_term_cache()
    4237  * @uses wp_get_object_terms()
    42384204 *
    42394205 * @param int $object_id ID of the object (post ID, link ID, ...)
    42404206 * @param string $taxonomy Single taxonomy name
     
    42794245 * Determine if the given object type is associated with the given taxonomy.
    42804246 *
    42814247 * @since 3.0.0
    4282  * @uses get_object_taxonomies()
    42834248 *
    42844249 * @param string $object_type Object type string
    42854250 * @param string $taxonomy Single taxonomy name
     
    43614326 * Attached to the wp_update_term_parent filter.
    43624327 *
    43634328 * @since 3.1.0
    4364  * @uses wp_find_hierarchy_loop()
    43654329 *
    43664330 * @param int $parent term_id of the parent for the term we're checking.
    43674331 * @param int $term_id The term we're checking.
  • src/wp-includes/theme.php

     
    271271 * Retrieve name of the current theme.
    272272 *
    273273 * @since 1.5.0
    274  * @uses apply_filters() Calls 'template' filter on template option.
    275274 *
    276275 * @return string Template name.
    277276 */
  • src/wp-includes/user.php

     
    316316 *
    317317 * @since MU
    318318 *
    319  * @uses wp_get_current_user
    320  *
    321319 * @return int The current user's ID
    322320 */
    323321function get_current_user_id() {
     
    11111109 * Find out whether a user is a member of a given blog.
    11121110 *
    11131111 * @since MU 1.1
    1114  * @uses get_blogs_of_user()
    11151112 *
    11161113 * @param int $user_id Optional. The unique ID of the user. Defaults to the current user.
    11171114 * @param int $blog_id Optional. ID of the blog to check. Defaults to the current site.
     
    11371134 * Post meta data is called "Custom Fields" on the Administration Screens.
    11381135 *
    11391136 * @since 3.0.0
    1140  * @uses add_metadata()
    11411137 * @link http://codex.wordpress.org/Function_Reference/add_user_meta
    11421138 *
    11431139 * @param int $user_id User ID.
     
    11581154 * allows removing all metadata matching key, if needed.
    11591155 *
    11601156 * @since 3.0.0
    1161  * @uses delete_metadata()
    11621157 * @link http://codex.wordpress.org/Function_Reference/delete_user_meta
    11631158 *
    11641159 * @param int $user_id user ID
     
    11741169 * Retrieve user meta field for a user.
    11751170 *
    11761171 * @since 3.0.0
    1177  * @uses get_metadata()
    11781172 * @link http://codex.wordpress.org/Function_Reference/get_user_meta
    11791173 *
    11801174 * @param int $user_id User ID.
     
    11961190 * If the meta field for the user does not exist, it will be added.
    11971191 *
    11981192 * @since 3.0.0
    1199  * @uses update_metadata
    12001193 * @link http://codex.wordpress.org/Function_Reference/update_user_meta
    12011194 *
    12021195 * @param int $user_id User ID.
     
    16391632 * Checks whether an username is valid.
    16401633 *
    16411634 * @since 2.0.1
    1642  * @uses apply_filters() Calls 'validate_username' hook on $valid check and $username as parameters
    16431635 *
    16441636 * @param string $username Username.
    16451637 * @return bool Whether username given is valid
  • src/wp-includes/widgets.php

     
    554554 * @since 2.2.0
    555555 *
    556556 * @see register_sidebar() The second parameter is documented by register_sidebar() and is the same here.
    557  * @uses parse_str() Converts a string to an array to be used in the rest of the function.
    558  * @uses register_sidebar() Sends single sidebar information [name, id] to this
    559  *      function to handle building the sidebar.
    560557 *
    561558 * @param int $number Number of sidebars to create.
    562559 * @param string|array $args Builds Sidebar based off of 'name' and 'id' values.
     
    631628 *
    632629 * @since 2.2.0
    633630 * @uses $wp_registered_sidebars Stores the new sidebar in this array by sidebar ID.
    634  * @uses add_theme_support() to ensure widget support has been added.
    635631 *
    636632 * @param string|array $args Arguments for the sidebar being registered.
    637633 * @return string Sidebar ID added to $wp_registered_sidebars global.
     
    932928 * Remove control callback for widget.
    933929 *
    934930 * @since 2.2.0
    935  * @uses wp_register_widget_control() Unregisters by using empty callback.
    936931 *
    937932 * @param int|string $id Widget ID.
    938933 */
  • src/wp-includes/wp-db.php

     
    867867        /**
    868868         * Gets blog prefix.
    869869         *
    870          * @uses is_multisite()
    871870         * @since 3.0.0
    872871         * @param int $blog_id Optional.
    873872         * @return string Blog prefix.
     
    906905         * @uses wpdb::$old_tables
    907906         * @uses wpdb::$global_tables
    908907         * @uses wpdb::$ms_global_tables
    909          * @uses is_multisite()
    910908         *
    911909         * @param string $scope Optional. Can be all, global, ms_global, blog, or old tables. Defaults to all.
    912910         * @param bool $prefix Optional. Whether to include table prefixes. Default true. If blog
  • src/wp-signup.php

     
    153153 *
    154154 * @since MU
    155155 *
    156  * @uses wp_get_current_user() to retrieve the current user
    157  * @uses wpmu_validate_blog_signup() to validate new site signup for the current user
    158156 * @return array Contains the new site data and error messages.
    159157 */
    160158function validate_blog_form() {
     
    208206 *
    209207 * @since MU
    210208 *
    211  * @uses wpmu_validate_user_signup() to retrieve an array of user data
    212209 * @return array Contains username, email, and error messages.
    213210 */
    214211function validate_user_form() {
     
    220217 *
    221218 * @since MU
    222219 *
    223  * @uses wp_get_current_user() to get the current user
    224220 * @param string $blogname The new site name
    225221 * @param string $blog_title The new blog title
    226222 * @param array $errors
     
    303299 *
    304300 * @since MU
    305301 *
    306  * @uses wp_get_current_user() to retrieve the current user
    307  * @uses wpmu_create_blog() to add a new site
    308  * @uses confirm_another_blog_signup() to confirm the user's new site signup
    309302 * @return bool True if blog signup was validated, false if error
    310303 */
    311304function validate_another_blog_signup() {
     
    394387 *
    395388 * @since MU
    396389 *
    397  * @uses apply_filters() filter $filtered_results
    398  * @uses show_user_form() to display the user registration form
    399390 * @param string $user_name The username
    400391 * @param string $user_email The user's email
    401392 * @param array $errors
     
    467458 *
    468459 * @since MU
    469460 *
    470  * @uses validate_user_form() to retrieve an array of the user data
    471  * @uses wpmu_signup_user() to signup the new user
    472  * @uses confirm_user_signup() to confirm the new user signup
    473461 * @return bool True if new user signup was validated, false if error
    474462 */
    475463function validate_user_signup() {
     
    519507 *
    520508 * @since MU
    521509 *
    522  * @uses apply_filters() to filter $filtered_results
    523  * @uses show_blog_form() to display the blog signup form
    524510 * @param string $user_name The username
    525511 * @param string $user_email The user's email address
    526512 * @param string $blogname The site name
     
    584570 *
    585571 * @since MU
    586572 *
    587  * @uses wpmu_validate_user_signup() to retrieve an array of the new user data and errors
    588  * @uses wpmu_validate_blog_signup() to retrieve an array of the new site data and errors
    589  * @uses apply_filters() to make signup $meta filterable
    590  * @uses signup_user() to signup a new user
    591  * @uses signup_blog() to signup a the new user to a new site
    592573 * @return bool True if the site signup was validated, false if error
    593574 */
    594575function validate_blog_signup() {