Ticket #30191: 30191.diff
| File 30191.diff, 64.2 KB (added by , 12 years ago) |
|---|
-
src/wp-admin/includes/class-wp-list-table.php
184 184 185 185 /** 186 186 * Checks the current user's permissions 187 * @uses wp_die()188 187 * 189 188 * @since 3.1.0 190 189 * @access public -
src/wp-admin/includes/class-wp-themes-list-table.php
255 255 * 256 256 * @since 3.4.0 257 257 * @access public 258 *259 * @uses $this->features Array of all feature search terms.260 * @uses get_pagenum()261 * @uses _pagination_args['total_pages']262 258 */ 263 259 public function _js_vars( $extra_args = array() ) { 264 260 $search_string = isset( $_REQUEST['s'] ) ? esc_attr( wp_unslash( $_REQUEST['s'] ) ) : ''; -
src/wp-admin/includes/file.php
50 50 * 51 51 * @since 1.5.0 52 52 * 53 * @uses _cleanup_header_comment54 53 * @uses $wp_file_descriptions 55 54 * @param string $file Filesystem path or filename 56 55 * @return string Description of file from $wp_file_descriptions or basename of $file if description doesn't exist … … 75 74 * 76 75 * @since 1.5.0 77 76 * 78 * @uses get_option79 77 * @return string Full filesystem path to the root of the WordPress installation 80 78 */ 81 79 function get_home_path() { … … 163 161 * 164 162 * @since 1.5.0 165 163 * 166 * @uses wp_die167 * @uses validate_file168 164 * @param string $file file the users is attempting to edit 169 165 * @param array $allowed_files Array of allowed files to edit, $file must match an entry exactly 170 166 * @return null -
src/wp-admin/includes/ms.php
395 395 * Get the remaining upload space for this blog. 396 396 * 397 397 * @since MU 398 * @uses upload_is_user_over_quota()399 * @uses get_space_allowed()400 * @uses get_upload_space_available()401 398 * 402 399 * @param int $size Current max size in bytes 403 400 * @return int Max size in bytes -
src/wp-admin/includes/nav-menu.php
550 550 * @since 3.6.0 551 551 * 552 552 * @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()554 553 * 555 554 * @param int|string $nav_menu_selected_id (id, name or slug) of the currently-selected menu 556 555 * @return string Disabled attribute if at least one menu exists, false if not … … 1247 1246 * 1248 1247 * @since 3.6.0 1249 1248 * 1250 * @uses wp_get_nav_menu_items() to retrieve the nav menu's menu items1251 * @uses wp_defer_term_counter() to enable then disable term counting1252 *1253 1249 * @param int|string $nav_menu_selected_id (id, slug, or name ) of the currently-selected menu 1254 1250 * @param string $nav_menu_selected_title Title of the currently-selected menu 1255 1251 * @return array $messages The menu updated message -
src/wp-admin/includes/post.php
1069 1069 /** 1070 1070 * Returns the list of classes to be used by a metabox 1071 1071 * 1072 * @uses get_user_option()1073 1072 * @since 2.5.0 1074 1073 * 1075 1074 * @param unknown_type $id … … 1500 1499 * @subpackage Post_Revisions 1501 1500 * @since 2.6.0 1502 1501 * 1503 * @uses _wp_translate_postdata()1504 * @uses _wp_post_revision_fields()1505 *1506 1502 * @param mixed $post_data Associative array containing the post data or int post ID. 1507 1503 * @return mixed The autosave revision ID. WP_Error or 0 on error. 1508 1504 */ … … 1566 1562 * @package WordPress 1567 1563 * @since 2.7.0 1568 1564 * 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 *1578 1565 * @return str URL to redirect to show the preview 1579 1566 */ 1580 1567 function post_preview() { -
src/wp-admin/includes/screen.php
177 177 * Set the current screen object 178 178 * 179 179 * @since 3.0.0 180 * @uses $current_screen181 180 * 182 181 * @param mixed $hook_name Optional. The hook name (also known as the hook suffix) used to determine the screen, 183 182 * or an existing screen object. -
src/wp-admin/includes/template.php
1466 1466 * The password is passed through {@link esc_attr()} to ensure that it 1467 1467 * is safe for placing in an html attribute. 1468 1468 * 1469 * @uses attr1470 1469 * @since 2.7.0 1471 1470 */ 1472 1471 function the_post_password() { … … 1499 1498 * A simple wrapper to display the "s" parameter in a GET URI. This function 1500 1499 * should only be used when {@link the_search_query()} cannot. 1501 1500 * 1502 * @uses attr1503 1501 * @since 2.7.0 1504 1502 * 1505 1503 */ -
src/wp-includes/author-template.php
16 16 * @since 1.5.0 17 17 * 18 18 * @uses $authordata The current author's DB object. 19 * @uses apply_filters() Calls 'the_author' hook on the author display name.20 19 * 21 20 * @param string $deprecated Deprecated. 22 21 * @return string The author's display name. … … 71 70 * 72 71 * @since 2.8.0 73 72 * 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.78 73 * @return string The author's display name. 79 74 */ 80 75 function get_the_modified_author() { … … 108 103 * Retrieve the requested data of the author of the current post. 109 104 * @link http://codex.wordpress.org/Template_Tags/the_author_meta 110 105 * @since 2.8.0 111 * @uses $authordata The current author's DB object (if $user_id not specified).112 106 * @param string $field selects the field of the users record. 113 107 * @param int $user_id Optional. User ID. 114 108 * @return string The author's field from the current author's DB object. … … 168 162 * 169 163 * If the author has a home page set, return an HTML link, otherwise just return the 170 164 * author's name. 171 *172 * @uses get_the_author_meta()173 * @uses get_the_author()174 165 */ 175 166 function get_the_author_link() { 176 167 if ( get_the_author_meta('url') ) { … … 189 180 * @link http://codex.wordpress.org/Template_Tags/the_author_link 190 181 * 191 182 * @since 2.1.0 192 *193 * @uses get_the_author_link()194 183 */ 195 184 function the_author_link() { 196 185 echo get_the_author_link(); … … 201 190 * 202 191 * @since 1.5.0 203 192 * 204 * @uses $post The current post in the Loop's DB object.205 * @uses count_user_posts()206 193 * @return int The number of posts by the author. 207 194 */ 208 195 function get_the_author_posts() { … … 218 205 * 219 206 * @link http://codex.wordpress.org/Template_Tags/the_author_posts 220 207 * @since 0.71 221 * @uses get_the_author_posts() Echoes returned value from function.222 208 */ 223 209 function the_author_posts() { 224 210 echo get_the_author_posts(); … … 233 219 * 234 220 * @link http://codex.wordpress.org/Template_Tags/the_author_posts_link 235 221 * @since 1.2.0 236 * @uses $authordata The current author's DB object.237 * @uses get_author_posts_url()238 * @uses get_the_author()239 222 * @param string $deprecated Deprecated. 240 223 */ 241 224 function the_author_posts_link($deprecated = '') { -
src/wp-includes/bookmark.php
60 60 * Retrieve single bookmark data item or field. 61 61 * 62 62 * @since 2.3.0 63 * @uses get_bookmark() Gets bookmark object using $bookmark as ID64 * @uses sanitize_bookmark_field() Sanitizes Bookmark field based on $context.65 63 * 66 64 * @param string $field The name of the data field to return 67 65 * @param int $bookmark The bookmark ID to get field … … 407 405 * Deletes bookmark cache 408 406 * 409 407 * @since 2.7.0 410 * @uses wp_cache_delete() Deletes the contents of 'get_bookmarks'411 408 */ 412 409 function clean_bookmark_cache( $bookmark_id ) { 413 410 wp_cache_delete( $bookmark_id, 'bookmark' ); -
src/wp-includes/category-template.php
66 66 * Retrieve post categories. 67 67 * 68 68 * @since 0.71 69 * @uses $post70 69 * 71 70 * @param int $id Optional, default to current post ID. The post ID. 72 71 * @return array … … 248 247 * As of 2.7, the function can be used anywhere if it is provided a post ID or post object. 249 248 * 250 249 * @since 1.2.0 251 * @uses has_category()252 250 * 253 251 * @param int|string|array $category Category ID, name or slug, or array of said. 254 252 * @param int|object $post Optional. Post to check instead of the current post. (since 2.7.0) -
src/wp-includes/category.php
63 63 * The category will converted to maintain backwards compatibility. 64 64 * 65 65 * @since 1.5.1 66 * @uses get_term() Used to get the category data from the taxonomy.67 66 * 68 67 * @param int|object $category Category ID or Category row object 69 68 * @param string $output Optional. Constant OBJECT, ARRAY_A, or ARRAY_N … … 210 209 * Sanitizes category data based on context. 211 210 * 212 211 * @since 2.3.0 213 * @uses sanitize_term() See this function for what context are supported.214 212 * 215 213 * @param object|array $category Category data 216 214 * @param string $context Optional. Default is 'display'. … … 224 222 * Sanitizes data in single category key field. 225 223 * 226 224 * @since 2.3.0 227 * @uses sanitize_term_field() See function for more details.228 225 * 229 226 * @param string $field Category key to sanitize 230 227 * @param mixed $value Category value to sanitize … … 243 240 * 244 241 * @since 2.3.0 245 242 * @see get_terms() For list of arguments to pass. 246 * @uses apply_filters() Calls 'get_tags' hook on array of tags and with $args.247 243 * 248 244 * @param string|array $args Tag arguments to use when retrieving tags. 249 245 * @return array List of tags. … … 297 293 * Remove the category cache data based on ID. 298 294 * 299 295 * @since 2.1.0 300 * @uses clean_term_cache() Clears the cache for the category based on ID301 296 * 302 297 * @param int $id Category ID 303 298 */ -
src/wp-includes/class-http.php
1785 1785 * some proxies can not handle this. We also have the constant available for defining other 1786 1786 * hosts that won't be sent through the proxy. 1787 1787 * 1788 * @uses WP_PROXY_BYPASS_HOSTS1789 1788 * @since 2.8.0 1790 1789 * 1791 1790 * @param string $uri URI to check. -
src/wp-includes/class-oembed.php
565 565 * @access private 566 566 * 567 567 * @see WP_oEmbed 568 * @uses WP_oEmbed569 568 * 570 569 * @return WP_oEmbed object. 571 570 */ -
src/wp-includes/class-wp-customize-manager.php
1283 1283 * Returns either '', a 3 or 6 digit hex color (without a #), or null. 1284 1284 * 1285 1285 * @since 3.4.0 1286 * @uses sanitize_hex_color()1287 1286 * 1288 1287 * @param string $color 1289 1288 * @return string|null -
src/wp-includes/class-wp-customize-setting.php
556 556 557 557 /** 558 558 * @since 3.4.0 559 * @uses remove_theme_mod()560 559 * 561 560 * @param $value 562 561 */ -
src/wp-includes/class-wp-embed.php
43 43 * calls {@link do_shortcode()}, and then re-registers the old shortcodes. 44 44 * 45 45 * @uses $shortcode_tags 46 * @uses remove_all_shortcodes()47 * @uses add_shortcode()48 * @uses do_shortcode()49 46 * 50 47 * @param string $content Content to parse 51 48 * @return string Content with shortcode parsed … … 122 119 * Attempts to convert a URL into embed HTML. Starts by checking the URL against the regex of the registered embed handlers. 123 120 * If none of the regex matches and it's enabled, then the URL will be given to the {@link WP_oEmbed} class. 124 121 * 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 *136 122 * @param array $attr { 137 123 * Shortcode attributes. Optional. 138 124 * … … 332 318 /** 333 319 * Callback function for {@link WP_Embed::autoembed()}. 334 320 * 335 * @uses WP_Embed::shortcode()336 *337 321 * @param array $match A regex match array. 338 322 * @return string The embed HTML on success, otherwise the original URL. 339 323 */ -
src/wp-includes/class-wp-theme.php
855 855 * for all other URLs returned by WP_Theme, so we pass it to the public function 856 856 * get_theme_root_uri() and allow it to run the theme_root_uri filter. 857 857 * 858 * @uses get_theme_root_uri()859 *860 858 * @since 3.4.0 861 859 * @access public 862 860 * -
src/wp-includes/class-wp.php
532 532 /** 533 533 * Set up the Loop based on the query variables. 534 534 * 535 * @uses WP::$query_vars536 535 * @since 2.0.0 537 536 */ 538 537 public function query_posts() { -
src/wp-includes/comment.php
853 853 * Add meta data field to a comment. 854 854 * 855 855 * @since 2.9.0 856 * @uses add_metadata857 856 * @link http://codex.wordpress.org/Function_Reference/add_comment_meta 858 857 * 859 858 * @param int $comment_id Comment ID. … … 874 873 * allows removing all metadata matching key, if needed. 875 874 * 876 875 * @since 2.9.0 877 * @uses delete_metadata878 876 * @link http://codex.wordpress.org/Function_Reference/delete_comment_meta 879 877 * 880 878 * @param int $comment_id comment ID … … 890 888 * Retrieve comment meta field for a comment. 891 889 * 892 890 * @since 2.9.0 893 * @uses get_metadata894 891 * @link http://codex.wordpress.org/Function_Reference/get_comment_meta 895 892 * 896 893 * @param int $comment_id Comment ID. … … 912 909 * If the meta field for the comment does not exist, it will be added. 913 910 * 914 911 * @since 2.9.0 915 * @uses update_metadata916 912 * @link http://codex.wordpress.org/Function_Reference/update_comment_meta 917 913 * 918 914 * @param int $comment_id Comment ID. … … 1250 1246 * Calculate what page number a comment will appear on for comment paging. 1251 1247 * 1252 1248 * @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.1256 1249 * 1257 1250 * @param int $comment_ID Comment ID. 1258 1251 * @param array $args Optional args. … … 1440 1433 * 1441 1434 * @since 2.0.0 1442 1435 * @uses $wpdb 1443 * @uses wp_transition_comment_status() Passes new and old comment status along with $comment object1444 1436 * 1445 1437 * @param int $comment_id Comment ID 1446 1438 * @param bool $force_delete Whether to bypass trash and force deletion. Default is false. … … 1507 1499 * 1508 1500 * @since 2.9.0 1509 1501 * 1510 * @uses wp_delete_comment() if trash is disabled1511 *1512 1502 * @param int $comment_id Comment ID. 1513 1503 * @return bool True on success, false on failure. 1514 1504 */ … … 2043 2033 * If the comment status is not in the list, then false is returned. 2044 2034 * 2045 2035 * @since 1.0.0 2046 * @uses wp_transition_comment_status() Passes new and old comment status along with $comment object2047 2036 * 2048 2037 * @param int $comment_id Comment ID. 2049 2038 * @param string $comment_status New comment status, either 'hold', 'approve', 'spam', or 'trash'. … … 2114 2103 * 2115 2104 * @since 2.0.0 2116 2105 * @uses $wpdb 2117 * @uses wp_transition_comment_status() Passes new and old comment status along with $comment object2118 2106 * 2119 2107 * @param array $commentarr Contains information on the comment. 2120 2108 * @return int Comment was updated if value is 1, or was not updated if value is 0. … … 2466 2454 * 2467 2455 * @since 0.71 2468 2456 * @uses $wp_version 2469 * @uses IXR_Client2470 2457 * 2471 2458 * @param string $content Post content to check for links. 2472 2459 * @param int $post_ID Post ID. … … 2609 2596 * 2610 2597 * @since 1.2.0 2611 2598 * @uses $wp_version 2612 * @uses IXR_Client2613 2599 * 2614 2600 * @param string $server Host of blog to connect to. 2615 2601 * @param string $path Path to send the ping. -
src/wp-includes/deprecated.php
1699 1699 * and the rest of the content will be removed. 1700 1700 * 1701 1701 * @since 0.71 1702 * @uses apply_filters() Calls 'the_content_rss' on the content before processing.1703 1702 * 1704 1703 * @deprecated 2.9.0 1705 1704 * @deprecated Use the_content_feed() … … 1807 1806 * contains a context after its last vertical bar. 1808 1807 * 1809 1808 * @since 2.5.0 1810 * @uses translate()1811 1809 * @deprecated 3.0.0 1812 1810 * @deprecated Use _x() 1813 1811 * @see _x() … … 3152 3150 * @since 2.0.0 3153 3151 * @deprecated 3.4.0 3154 3152 * 3155 * @uses do_action() Will call the 'clean_page_cache' hook action.3156 *3157 3153 * @param int $id Page ID to clean 3158 3154 */ 3159 3155 function clean_page_cache( $id ) { -
src/wp-includes/feed.php
71 71 * 'default_feed' filter. 72 72 * 73 73 * @since 2.5.0 74 * @uses apply_filters() Calls 'default_feed' hook on the default feed string.75 74 * 76 75 * @return string Default feed, or for example 'rss2', 'atom', etc. 77 76 */ … … 165 164 * Display the post title in the feed. 166 165 * 167 166 * @since 0.71 168 * @uses get_the_title_rss() Used to retrieve current post title.169 167 */ 170 168 function the_title_rss() { 171 169 echo get_the_title_rss(); … … 203 201 * Display the post content for feeds. 204 202 * 205 203 * @since 2.9.0 206 * @uses apply_filters() Calls 'the_content_feed' on the content before processing.207 * @see get_the_content()208 204 * 209 205 * @param string $feed_type The type of feed. rss2 | atom | rss | rdf 210 206 */ … … 313 309 * Retrieve the current comment author for use in the feeds. 314 310 * 315 311 * @since 2.0.0 316 * @uses get_comment_author()317 312 * 318 313 * @return string Comment Author 319 314 */ … … 343 338 * Display the current comment content for use in the feeds. 344 339 * 345 340 * @since 1.0.0 346 * @uses get_comment_text()347 341 */ 348 342 function comment_text_rss() { 349 343 $comment_text = get_comment_text(); … … 454 448 * attributes. 455 449 * 456 450 * @since 1.5.0 457 * @uses get_post_custom() To get the current post enclosure metadata.458 451 */ 459 452 function rss_enclosure() { 460 453 if ( post_password_required() ) … … 494 487 * enclosure(s) consist of link HTML tag(s) with a URI and other attributes. 495 488 * 496 489 * @since 2.2.0 497 * @uses get_post_custom() To get the current post enclosure metadata.498 490 */ 499 491 function atom_enclosure() { 500 492 if ( post_password_required() ) -
src/wp-includes/formatting.php
1226 1226 * Used for querying the database for a value from URL. 1227 1227 * 1228 1228 * @since 3.1.0 1229 * @uses sanitize_title()1230 1229 * 1231 1230 * @param string $title The string to be sanitized. 1232 1231 * @return string The sanitized string. … … 2230 2229 * 2231 2230 * @since 1.2.0 2232 2231 * 2233 * @uses get_option() to retrieve the value of 'gmt_offset'.2234 2232 * @param string $string The date to be converted. 2235 2233 * @param string $format The format string for the returned date (default is Y-m-d H:i:s) 2236 2234 * @return string GMT version of the date provided. … … 3023 3021 * is applied to the returned cleaned URL. 3024 3022 * 3025 3023 * @since 2.8.0 3026 * @uses wp_kses_bad_protocol() To only permit protocols in the URL set3027 * via $protocols or the common ones set in the function.3028 3024 * 3029 3025 * @param string $url The URL to be cleaned. 3030 3026 * @param array $protocols Optional. An array of acceptable protocols. … … 3082 3078 * Performs esc_url() for database usage. 3083 3079 * 3084 3080 * @since 2.8.0 3085 * @uses esc_url()3086 3081 * 3087 3082 * @param string $url The URL to be cleaned. 3088 3083 * @param array $protocols An array of acceptable protocols. … … 3478 3473 * 3479 3474 * KSES already converts lone greater than signs. 3480 3475 * 3481 * @uses wp_pre_kses_less_than_callback in the callback function.3482 3476 * @since 2.3.0 3483 3477 * 3484 3478 * @param string $text Text to be converted. … … 3491 3485 /** 3492 3486 * Callback function used by preg_replace. 3493 3487 * 3494 * @uses esc_html to format the $matches text.3495 3488 * @since 2.3.0 3496 3489 * 3497 3490 * @param array $matches Populated by matches to preg_replace. -
src/wp-includes/functions.php
2274 2274 * 2275 2275 * @since 2.8.6 2276 2276 * 2277 * @uses wp_get_upload_mime_types() to fetch the list of mime types2278 *2279 2277 * @param int|WP_User $user Optional. User to check. Defaults to current user. 2280 2278 * @return array Array of mime types keyed by the file extension regex corresponding 2281 2279 * to those types. … … 3200 3198 * Append the Widgets menu to the themes main menu. 3201 3199 * 3202 3200 * @since 2.2.0 3203 *3204 * @uses $submenu The administration submenu list.3205 3201 */ 3206 3202 function wp_widgets_add_menu() { 3207 3203 global $submenu; -
src/wp-includes/general-template.php
17 17 * 18 18 * @since 1.5.0 19 19 * 20 * @uses locate_template()21 *22 20 * @param string $name The name of the specialised header. 23 21 */ 24 22 function get_header( $name = null ) { … … 59 57 * 60 58 * @since 1.5.0 61 59 * 62 * @uses locate_template()63 *64 60 * @param string $name The name of the specialised footer. 65 61 */ 66 62 function get_footer( $name = null ) { … … 101 97 * 102 98 * @since 1.5.0 103 99 * 104 * @uses locate_template()105 *106 100 * @param string $name The name of the specialised sidebar. 107 101 */ 108 102 function get_sidebar( $name = null ) { … … 150 144 * 151 145 * @since 3.0.0 152 146 * 153 * @uses locate_template()154 *155 147 * @param string $slug The slug name for the generic template. 156 148 * @param string $name The name of the specialised template. 157 149 */ … … 307 299 * 308 300 * @since 2.7.0 309 301 * 310 * @uses wp_nonce_url() To protect against CSRF.311 * @uses site_url() To generate the log out URL.312 *313 302 * @param string $redirect Path to redirect to on logout. 314 303 * @return string A log out URL. 315 304 */ … … 340 329 * 341 330 * @since 2.7.0 342 331 * 343 * @uses site_url() To generate the log in URL.344 *345 332 * @param string $redirect Path to redirect to on login. 346 333 * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false. 347 334 * @return string A log in URL. … … 373 360 * 374 361 * @since 3.6.0 375 362 * 376 * @uses site_url() To generate the registration URL.377 *378 363 * @return string User registration URL. 379 364 */ 380 365 function wp_registration_url() { … … 496 481 * 497 482 * @since 2.8.0 498 483 * 499 * @uses site_url() To generate the lost password URL500 *501 484 * @param string $redirect Path to redirect to on login. 502 485 * @return string Lost password URL. 503 486 */ … … 1429 1412 * no posts for the month, then it will not be displayed. 1430 1413 * 1431 1414 * @since 1.0.0 1432 * @uses calendar_week_mod()1433 1415 * 1434 1416 * @param bool $initial Optional, default is true. Use initial calendar names. 1435 1417 * @param bool $echo Optional, default is true. Set to false for return. … … 1711 1693 * 1712 1694 * @since 0.71 1713 1695 * 1714 * @uses get_the_date()1715 1696 * @param string $d Optional. PHP date format defaults to the date_format option if not specified. 1716 1697 * @param string $before Optional. Output before the date. 1717 1698 * @param string $after Optional. Output after the date. … … 2032 2013 * 2033 2014 * @since 0.71 2034 2015 * @uses $wp_locale 2035 * @uses $post2036 2016 */ 2037 2017 function the_weekday() { 2038 2018 global $wp_locale; … … 2358 2338 * to ensure that it is safe for placing in an html attribute. 2359 2339 * 2360 2340 * @since 2.3.0 2361 * @uses esc_attr()2362 2341 * 2363 2342 * @param bool $escaped Whether the result is escaped. Default true. 2364 2343 * Only use when you are later escaping it. Do not use unescaped. … … 2385 2364 * The search query string is passed through {@link esc_attr()} 2386 2365 * to ensure that it is safe for placing in an html attribute. 2387 2366 * 2388 * @uses esc_attr()2389 2367 * @since 2.1.0 2390 2368 */ 2391 2369 function the_search_query() { -
src/wp-includes/kses.php
661 661 * 662 662 * @access private 663 663 * @since 1.0.0 664 * @uses wp_kses_attr()665 664 * 666 665 * @param string $string Content to filter 667 666 * @param array $allowed_html Allowed HTML elements … … 1318 1317 * Sanitize content with allowed HTML Kses rules. 1319 1318 * 1320 1319 * @since 1.0.0 1321 * @uses $allowedtags1322 1320 * 1323 1321 * @param string $data Content to filter, expected to be escaped with slashes 1324 1322 * @return string Filtered content … … 1331 1329 * Sanitize content with allowed HTML Kses rules. 1332 1330 * 1333 1331 * @since 2.9.0 1334 * @uses $allowedtags1335 1332 * 1336 1333 * @param string $data Content to filter, expected to not be escaped 1337 1334 * @return string Filtered content … … 1392 1389 * 'excerpt_save_pre', and 'content_filtered_save_pre' hooks. 1393 1390 * 1394 1391 * @since 2.0.0 1395 * @uses add_filter() See description for what functions are added to what hooks.1396 1392 */ 1397 1393 function kses_init_filters() { 1398 1394 // Normal filtering … … 1447 1443 * to have Kses filter the content. If the user does not have unfiltered_html 1448 1444 * capability, then Kses filters are added. 1449 1445 * 1450 * @uses kses_remove_filters() Removes the Kses filters1451 * @uses kses_init_filters() Adds the Kses filters back if the user1452 * does not have unfiltered HTML capability.1453 1446 * @since 2.0.0 1454 1447 */ 1455 1448 function kses_init() { -
src/wp-includes/link-template.php
1880 1880 * Can be either next post link or previous. 1881 1881 * 1882 1882 * @since 2.5.0 1883 * @uses get_adjacent_post_link()1884 1883 * 1885 1884 * @param string $format Link anchor format. 1886 1885 * @param string $link Link permalink format. … … 2048 2047 * Display the next posts page link. 2049 2048 * 2050 2049 * @since 0.71 2051 * @uses get_next_posts_link()2052 2050 * 2053 2051 * @param string $label Content for link text. 2054 2052 * @param int $max_page Optional. Max pages. … … 2126 2124 * Display the previous posts page link. 2127 2125 * 2128 2126 * @since 0.71 2129 * @uses get_previous_posts_link()2130 2127 * 2131 2128 * @param string $label Optional. Previous page link text. 2132 2129 */ … … 2606 2603 * 2607 2604 * @since 3.0.0 2608 2605 * 2609 * @uses get_home_url()2610 *2611 2606 * @param string $path (optional) Path relative to the home url. 2612 2607 * @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'. 2613 2608 * @return string Home url link with optional path appended. … … 2675 2670 * 2676 2671 * @since 3.0.0 2677 2672 * 2678 * @uses get_site_url()2679 *2680 2673 * @param string $path Optional. Path relative to the site url. 2681 2674 * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme(). 2682 2675 * @return string Site url link with optional path appended. … … 3258 3251 * Attached to the wp_head action. 3259 3252 * 3260 3253 * @since 3.0.0 3261 *3262 * @uses wp_get_shortlink()3263 3254 */ 3264 3255 function wp_shortlink_wp_head() { 3265 3256 $shortlink = wp_get_shortlink( 0, 'query' ); … … 3276 3267 * Attached to the wp action. 3277 3268 * 3278 3269 * @since 3.0.0 3279 *3280 * @uses wp_get_shortlink()3281 3270 */ 3282 3271 function wp_shortlink_header() { 3283 3272 if ( headers_sent() ) -
src/wp-includes/media.php
25 25 * height as the second element. 26 26 * 27 27 * @since 2.5.0 28 * @uses wp_constrain_dimensions() This function passes the widths and the heights.29 28 * 30 29 * @param int $width Width of the image 31 30 * @param int $height Height of the image … … 684 683 * @since 2.5.0 685 684 * 686 685 * @see add_image_size() 687 * @uses wp_get_attachment_image_src() Gets attachment file URL and dimensions688 686 * 689 687 * @param int $attachment_id Image attachment ID. 690 688 * @param string|array $size Optional. Default 'thumbnail'. … … 1995 1993 * 1996 1994 * @since 3.5.0 1997 1995 * @see get_attachment_taxonomies() 1998 * @uses get_taxonomies()1999 1996 * 2000 1997 * @param string $output The type of output to return, either taxonomy 'names' or 'objects'. 'names' is the default. 2001 1998 * @return array The names of all taxonomy of $object_type. … … 2099 2096 * Based on a supplied width/height example, return the biggest possible dimensions based on the max width/height. 2100 2097 * 2101 2098 * @since 2.9.0 2102 * @uses wp_constrain_dimensions() This function passes the widths and the heights.2103 2099 * 2104 2100 * @param int $example_width The width of an example embed. 2105 2101 * @param int $example_height The height of an example embed. … … 2122 2118 * @since 2.9.0 2123 2119 * @see WP_oEmbed 2124 2120 * 2125 * @uses _wp_oembed_get_object()2126 * @uses WP_oEmbed::get_html()2127 *2128 2121 * @param string $url The URL that should be embedded. 2129 2122 * @param array $args Additional arguments and parameters. 2130 2123 * @return bool|string False on failure or the embed HTML on success. … … 2141 2134 * @since 2.9.0 2142 2135 * @see WP_oEmbed 2143 2136 * 2144 * @uses _wp_oembed_get_object()2145 *2146 2137 * @param string $format The format of URL that this provider can handle. You can use asterisks as wildcards. 2147 2138 * @param string $provider The URL to the oEmbed provider. 2148 2139 * @param boolean $regex Whether the $format parameter is in a regex format. … … 2164 2155 * @since 3.5.0 2165 2156 * @see WP_oEmbed 2166 2157 * 2167 * @uses _wp_oembed_get_object()2168 *2169 2158 * @param string $format The URL format for the oEmbed provider to remove. 2170 2159 */ 2171 2160 function wp_oembed_remove_provider( $format ) { -
src/wp-includes/meta.php
576 576 * 577 577 * @since 3.3.0 578 578 * 579 * @uses get_metadata_by_mid() Calls get_metadata_by_mid() to fetch the meta key, value580 * and object_id of the given meta_id.581 *582 579 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user) 583 580 * @param int $meta_id ID for a specific meta row 584 581 * @param string $meta_value Metadata value … … 670 667 * 671 668 * @since 3.3.0 672 669 * 673 * @uses get_metadata_by_mid() Calls get_metadata_by_mid() to fetch the meta key, value674 * and object_id of the given meta_id.675 *676 670 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user) 677 671 * @param int $meta_id ID for a specific meta row 678 672 * @return bool True on successful delete, false on failure. -
src/wp-includes/ms-deprecated.php
232 232 * @since MU 233 233 * @deprecated 3.3.0 234 234 * @deprecated Use wp_redirect() 235 * @uses wpmu_admin_redirect_add_updated_param()236 235 * 237 236 * @param string $url 238 237 */ … … 297 296 * @since MU 298 297 * @deprecated 3.6.0 299 298 * @deprecated Use get_user_by() 300 * @uses get_user_by()301 299 * 302 300 * @param string $string Either an email address or a login. 303 301 * @return int -
src/wp-includes/ms-functions.php
11 11 * Gets the network's site and user counts. 12 12 * 13 13 * @since MU 1.0 14 * @uses get_blog_count()15 * @uses get_user_count()16 14 * 17 15 * @return array Site and user count for the network. 18 16 */ … … 58 56 * is returned. 59 57 * 60 58 * @since MU 1.0 61 * @uses get_blogs_of_user()62 * @uses add_user_to_blog()63 * @uses get_blog_details()64 59 * 65 60 * @param int $user_id The unique ID of the user 66 61 * @return object The blog object … … 298 293 * Create an empty blog. 299 294 * 300 295 * @since MU 1.0 301 * @uses install_blog()302 296 * 303 297 * @param string $domain The new blog's domain. 304 298 * @param string $path The new blog's path. … … 455 449 * relevant errors if necessary. 456 450 * 457 451 * @since MU 458 * @uses is_email_address_unsafe()459 * @uses username_exists()460 * @uses email_exists()461 452 * 462 453 * @param string $user_name The login name provided by the user. 463 454 * @param string $user_email The email provided by the user. … … 580 571 * the way that WordPress validates new site signups. 581 572 * 582 573 * @since MU 583 * @uses domain_exists()584 * @uses username_exists()585 574 * 586 575 * @param string $blogname The blog name provided by the user. Must be unique. 587 576 * @param string $blog_title The blog title provided by the user. … … 713 702 * Record site signup information for future activation. 714 703 * 715 704 * @since MU 716 * @uses wpmu_signup_blog_notification()717 705 * 718 706 * @param string $domain The requested domain. 719 707 * @param string $path The requested path. … … 749 737 * new site registration is not. 750 738 * 751 739 * @since MU 752 * @uses wpmu_signup_user_notification()753 740 * 754 741 * @param string $user The user's requested login name. 755 742 * @param string $user_email The user's email address. … … 978 965 * by a Super Admin). 979 966 * 980 967 * @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()987 968 * 988 969 * @param string $key The activation key provided to the user. 989 970 * @return array An array containing information about the activated user and/or blog … … 1078 1059 * use 'user_register'). 1079 1060 * 1080 1061 * @since MU 1081 * @uses wp_create_user()1082 1062 * 1083 1063 * @param string $user_name The new user's login name. 1084 1064 * @param string $password The new user's password. … … 1121 1101 * root domain (eg 'blog1.example.com'), and $path is '/'. 1122 1102 * 1123 1103 * @since MU 1124 * @uses domain_exists()1125 * @uses insert_blog()1126 * @uses wp_install_defaults()1127 * @uses add_user_to_blog()1128 1104 * 1129 1105 * @param string $domain The new site's domain. 1130 1106 * @param string $path The new site's path. … … 1248 1224 * the notification email. 1249 1225 * 1250 1226 * @since MU 1251 * @uses apply_filters() Filter newuser_notify_siteadmin to change the content of the email message1252 1227 * 1253 1228 * @param int $user_id The new user's ID. 1254 1229 * @return bool … … 1354 1329 * points to the new blog. 1355 1330 * 1356 1331 * @since MU 1357 * @uses make_db_current_silent()1358 * @uses populate_roles()1359 1332 * 1360 1333 * @param int $blog_id The value returned by insert_blog(). 1361 1334 * @param string $blog_title The title of the new site. … … 1408 1381 * @since MU 1409 1382 * @deprecated MU 1410 1383 * @deprecated Use wp_install_defaults() 1411 * @uses wp_install_defaults()1412 1384 * 1413 1385 * @param int $blog_id Ignored in this function. 1414 1386 * @param int $user_id … … 1628 1600 * the most recent post_date_gmt. 1629 1601 * 1630 1602 * @since MU 1631 * @uses get_blogs_of_user()1632 1603 * 1633 1604 * @param int $user_id 1634 1605 * @return array Contains the blog_id, post_id, post_date_gmt, and post_gmt_ts … … 1675 1646 * a blog has exceeded its allowed upload space. 1676 1647 * 1677 1648 * @since MU 1678 * @uses recurse_dirsize()1679 1649 * 1680 1650 * @param string $directory 1681 1651 * @return int … … 1889 1859 * Add a nonce field to the signup page. 1890 1860 * 1891 1861 * @since MU 1892 * @uses wp_nonce_field()1893 1862 */ 1894 1863 function signup_nonce_fields() { 1895 1864 $id = mt_rand(); … … 1901 1870 * Process the signup nonce created in signup_nonce_fields(). 1902 1871 * 1903 1872 * @since MU 1904 * @uses wp_create_nonce()1905 1873 * 1906 1874 * @param array $result 1907 1875 * @return array … … 1947 1915 * added, as when a user is invited through the regular WP Add User interface. 1948 1916 * 1949 1917 * @since MU 1950 * @uses add_existing_user_to_blog()1951 1918 */ 1952 1919 function maybe_add_existing_user_to_blog() { 1953 1920 if ( false === strpos( $_SERVER[ 'REQUEST_URI' ], '/newbloguser/' ) ) … … 1973 1940 * Add a user to a blog based on details from maybe_add_existing_user_to_blog(). 1974 1941 * 1975 1942 * @since MU 1976 * @uses add_user_to_blog()1977 1943 * 1978 1944 * @param array $details 1979 1945 */ … … 2031 1997 * Check to see whether a user is marked as a spammer, based on user login. 2032 1998 * 2033 1999 * @since MU 2034 * @uses get_user_by()2035 2000 * 2036 2001 * @param string|WP_User $user Optional. Defaults to current user. WP_User object, 2037 2002 * or user login name as a string. … … 2054 2019 * Public blogs have a setting of 1, private blogs are 0. 2055 2020 * 2056 2021 * @since MU 2057 * @uses update_blog_status()2058 2022 * 2059 2023 * @param int $old_value 2060 2024 * @param int $value The new public value … … 2069 2033 * Check whether a usermeta key has to do with the current blog. 2070 2034 * 2071 2035 * @since MU 2072 * @uses wp_get_current_user()2073 2036 * 2074 2037 * @param string $key 2075 2038 * @param int $user_id Optional. Defaults to current user. … … 2206 2169 * on a network when a site is created or its status is updated. 2207 2170 * 2208 2171 * @since 3.7.0 2209 *2210 * @uses wp_update_network_site_counts()2211 2172 */ 2212 2173 function wp_maybe_update_network_site_counts() { 2213 2174 $is_small_network = ! wp_is_large_network( 'sites' ); … … 2235 2196 * on a network when a user is created or its status is updated. 2236 2197 * 2237 2198 * @since 3.7.0 2238 *2239 * @uses wp_update_network_user_counts()2240 2199 */ 2241 2200 function wp_maybe_update_network_user_counts() { 2242 2201 $is_small_network = ! wp_is_large_network( 'users' ); -
src/wp-includes/nav-menu.php
12 12 * 13 13 * @since 3.0.0 14 14 * 15 * @uses get_term16 * @uses get_term_by17 *18 15 * @param string $menu Menu ID, slug, or name. 19 16 * @return mixed false if $menu param isn't supplied or term does not exist, menu object if successful. 20 17 */ -
src/wp-includes/option.php
141 141 /** 142 142 * Print option value after sanitizing for forms. 143 143 * 144 * @uses attr Sanitizes value.145 144 * @since 1.5.0 146 145 * 147 146 * @param string $option Option name. -
src/wp-includes/pluggable.php
72 72 * @since 0.71 73 73 * 74 74 * @uses $current_user Checks if the current user is set 75 * @uses wp_validate_auth_cookie() Retrieves current logged in user.76 75 * 77 76 * @return bool|null False on XML-RPC Request and invalid auth cookie. Null when current user set. 78 77 */ … … 1215 1214 * 1216 1215 * @since 2.3.0 1217 1216 * 1218 * @uses wp_validate_redirect() To validate the redirect is to an allowed host.1219 *1220 1217 * @return void Does not return anything 1221 1218 **/ 1222 1219 function wp_safe_redirect($location, $status = 302) { … … 1872 1869 * Get hash of given string. 1873 1870 * 1874 1871 * @since 2.0.3 1875 * @uses wp_salt() Get WordPress salt1876 1872 * 1877 1873 * @param string $data Plain text to hash 1878 1874 * @return string Hash of $data … … 2069 2065 * @since 2.5.0 2070 2066 * 2071 2067 * @uses $wpdb WordPress database object for queries 2072 * @uses wp_hash_password() Used to encrypt the user's password before passing to the database2073 2068 * 2074 2069 * @param string $password The plaintext new user password 2075 2070 * @param int $user_id User ID -
src/wp-includes/plugin.php
357 357 * 358 358 * @since 3.9.0 359 359 * 360 * @uses current_filter()361 *362 360 * @return string Hook name of the current action. 363 361 */ 364 362 function current_action() { … … 401 399 * 402 400 * @since 3.9.0 403 401 * 404 * @uses doing_filter()405 *406 402 * @param string|null $action Optional. Action to check. Defaults to null, which checks 407 403 * if any action is currently being run. 408 404 * @return bool Whether the action is currently in the stack. … … 421 417 * 422 418 * @since 1.2.0 423 419 * 424 * @uses add_filter() Adds an action. Parameter list and functionality are the same.425 *426 420 * @param string $tag The name of the action to which the $function_to_add is hooked. 427 421 * @param callback $function_to_add The name of the function you wish to be called. 428 422 * @param int $priority Optional. Used to specify the order in which the functions … … 646 640 * 647 641 * @since 1.5.0 648 642 * 649 * @uses WP_PLUGIN_DIR, WPMU_PLUGIN_DIR650 *651 643 * @param string $file The filename of plugin. 652 644 * @return string The name of a plugin. 653 645 */ … … 832 824 * @since 2.5.0 833 825 * @access private 834 826 * 835 * @uses $wp_filter Used to process all of the functions in the 'all' hook.836 *837 827 * @param array $args The collected parameters from the hook that was called. 838 828 */ 839 829 function _wp_call_all_hook($args) { -
src/wp-includes/post-formats.php
36 36 * 37 37 * @since 3.1.0 38 38 * 39 * @uses has_term()40 *41 39 * @param string|array $format Optional. The format or formats to check. 42 40 * @param object|int $post Optional. The post to check. If not supplied, defaults to the current post if used in the loop. 43 41 * @return bool True if the post has any of the given formats (or any format, if no format specified), false otherwise. … … 108 106 * 109 107 * @since 3.1.0 110 108 * 111 * @uses get_post_format_strings()112 *113 109 * @return array The array of post format slugs. 114 110 */ 115 111 function get_post_format_slugs() { … … 122 118 * 123 119 * @since 3.1.0 124 120 * 125 * @uses get_post_format_strings()126 *127 121 * @param string $slug A post format slug. 128 122 * @return string The translated post format name. 129 123 */ -
src/wp-includes/post-template.php
21 21 * Retrieve the ID of the current item in the WordPress Loop. 22 22 * 23 23 * @since 2.1.0 24 * @uses $post25 24 * 26 25 * @return int|bool The ID of the current item in the WordPress Loop. False if $post is not set. 27 26 */ … … 907 906 * 908 907 * @internal This will probably change at some point... 909 908 * @since 1.2.0 910 * @uses apply_filters() Calls 'the_meta_key' on list item HTML content, with key and value as separate parameters.911 909 */ 912 910 function the_meta() { 913 911 if ( $keys = get_post_custom_keys() ) { … … 1466 1464 * Retrieve an attachment page link using an image or icon, if possible. 1467 1465 * 1468 1466 * @since 2.5.0 1469 * @uses apply_filters() Calls 'wp_get_attachment_link' filter on HTML content with same parameters as function.1470 1467 * 1471 1468 * @param int|WP_Post $id Optional. Post ID or post object. 1472 1469 * @param string $size Optional, default is 'thumbnail'. Size of image, either array or string. … … 1602 1599 * specific to that template. 1603 1600 * 1604 1601 * @since 2.5.0 1605 * @uses $wp_query1606 1602 * 1607 1603 * @param string $template The specific template name if specific matching is required. 1608 1604 * @return bool True on success, false on failure. … … 1649 1645 * 1650 1646 * @since 2.6.0 1651 1647 * 1652 * @uses date_i18n()1653 *1654 1648 * @param int|object $revision Revision ID or revision object. 1655 1649 * @param bool $link Optional, default is true. Link to revisions's page? 1656 1650 * @return string i18n formatted datetimestamp or localized 'Current Revision'. … … 1686 1680 * 1687 1681 * @since 3.6.0 1688 1682 * 1689 * @uses date_i18n()1690 *1691 1683 * @param int|object $revision Revision ID or revision object. 1692 1684 * @param bool $link Optional, default is true. Link to revisions's page? 1693 1685 * @return string gravatar, user, i18n formatted datetimestamp or localized 'Current Revision'. … … 1737 1729 * 1738 1730 * @since 2.6.0 1739 1731 * 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 *1745 1732 * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post. 1746 1733 * @param string $type 'all' (default), 'revision' or 'autosave' 1747 1734 * @return null -
src/wp-includes/post.php
2942 2942 * 2943 2943 * @since 2.3.0 2944 2944 * 2945 * @uses wp_get_object_terms()2946 *2947 2945 * @param int $post_id Optional. The Post ID. Does not default to the ID of the 2948 2946 * global $post. Defualt 0. 2949 2947 * @param array $args Optional. Overwrite the defaults … … 2962 2960 * 2963 2961 * @since 2.8.0 2964 2962 * 2965 * @uses wp_get_object_terms()2966 *2967 2963 * @param int $post_id Optional. The Post ID. Does not default to the ID of the 2968 2964 * global $post. Default 0. 2969 2965 * @param string $taxonomy Optional. The taxonomy for which to retrieve terms. Default 'post_tag'. -
src/wp-includes/query.php
406 406 * 407 407 * @see WP_Query::is_front_page() 408 408 * @since 2.5.0 409 * @uses is_home()410 * @uses get_option()411 409 * 412 410 * @return bool True, if front of site. 413 411 */ … … 2357 2355 * 2358 2356 * @since 1.5.0 2359 2357 * @access public 2360 * @uses do_action_ref_array() Calls 'pre_get_posts' hook before retrieving posts.2361 2358 * 2362 2359 * @return array List of posts. 2363 2360 */ … … 3692 3689 * 3693 3690 * @since 1.5.0 3694 3691 * @access public 3695 * @uses $post3696 * @uses do_action_ref_array() Calls 'loop_start' if loop has just started3697 3692 */ 3698 3693 public function the_post() { 3699 3694 global $post; … … 3720 3715 * 3721 3716 * @since 1.5.0 3722 3717 * @access public 3723 * @uses do_action_ref_array() Calls 'loop_end' if loop is ended3724 3718 * 3725 3719 * @return bool True if posts are available, false if end of loop. 3726 3720 */ … … 3778 3772 * @since 2.2.0 3779 3773 * @access public 3780 3774 * @global object $comment Current comment. 3781 * @uses do_action() Calls 'comment_loop_start' hook when first comment is processed.3782 3775 */ 3783 3776 public function the_comment() { 3784 3777 global $comment; … … 4280 4273 * Otherwise the same as @see WP_Query::is_home() 4281 4274 * 4282 4275 * @since 3.1.0 4283 * @uses is_home()4284 * @uses get_option()4285 4276 * 4286 4277 * @return bool True, if front of site. 4287 4278 */ … … 4688 4679 * @since 1.5.0 4689 4680 * 4690 4681 * @param object $post Post data. 4691 * @uses do_action_ref_array() Calls 'the_post'4692 4682 * @return bool True when finished. 4693 4683 */ 4694 4684 function setup_postdata( $post ) { -
src/wp-includes/revision.php
77 77 * 78 78 * @since 2.6.0 79 79 * 80 * @uses _wp_put_post_revision()81 *82 80 * @param int $post_id The ID of the post to save as a revision. 83 81 * @return mixed Null or 0 if error, new revision ID, if success. 84 82 */ … … 192 190 * 193 191 * @since 2.6.0 194 192 * 195 * @uses wp_get_post_revisions()196 *197 193 * @param int $post_id The post ID. 198 194 * @param int $user_id optional The post author ID. 199 195 * @return object|bool The autosaved data or false on failure or when no autosave exists. … … 252 248 * @since 2.6.0 253 249 * @access private 254 250 * 255 * @uses wp_insert_post()256 *257 251 * @param int|object|array $post Post ID, post object OR post array. 258 252 * @param bool $autosave Optional. Is the revision an autosave? 259 253 * @return mixed WP_Error or 0 if error, new revision ID if success. … … 296 290 * 297 291 * @since 2.6.0 298 292 * 299 * @uses get_post()300 *301 293 * @param int|object $post The post ID or object. 302 294 * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N. 303 295 * @param string $filter Optional sanitation filter. @see sanitize_post(). … … 329 321 * 330 322 * @since 2.6.0 331 323 * 332 * @uses wp_get_post_revision()333 * @uses wp_update_post()334 *335 324 * @param int|object $revision_id Revision ID or revision object. 336 325 * @param array $fields Optional. What fields to restore from. Defaults to all. 337 326 * @return mixed Null if error, false if no fields to restore, (int) post ID if success. … … 390 379 * 391 380 * @since 2.6.0 392 381 * 393 * @uses wp_get_post_revision()394 * @uses wp_delete_post()395 *396 382 * @param int|object $revision_id Revision ID or revision object. 397 383 * @return mixed Null or WP_Error if error, deleted post if success. 398 384 */ … … 424 410 * 425 411 * @since 2.6.0 426 412 * 427 * @uses get_children()428 *429 413 * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post. 430 414 * @return array An array of revisions, or an empty array if none. 431 415 */ … … 453 437 * 454 438 * @since 3.6.0 455 439 * 456 * @uses wp_revisions_to_keep()457 *458 440 * @param object $post The post object. 459 441 * @return bool True if number of revisions to keep isn't zero, false otherwise. 460 442 */ … … 468 450 * 469 451 * @since 3.6.0 470 452 * 471 * @uses post_type_supports()472 *473 453 * @param object $post The post object. 474 454 * @return int The number of revisions to keep. 475 455 */ … … 587 567 * @since 3.6.0 588 568 * @access private 589 569 * 590 * @uses wp_get_post_revisions()591 *592 570 * @param object $post Post object 593 571 * @param array $revisions Current revisions of the post 594 572 * @return bool true if the revisions were upgraded, false if problems -
src/wp-includes/shortcodes.php
185 185 * @since 2.5.0 186 186 * 187 187 * @uses $shortcode_tags 188 * @uses get_shortcode_regex() Gets the search pattern for searching shortcodes.189 188 * 190 189 * @param string $content Content to search for shortcodes 191 190 * @return string Content with shortcodes filtered out. -
src/wp-includes/taxonomy.php
134 134 * 135 135 * @since 3.0.0 136 136 * @uses $wp_taxonomies 137 * @see register_taxonomy138 137 * 139 138 * @param array $args An array of key => value arguments to match against the taxonomy objects. 140 139 * @param string $output The type of output to return, either taxonomy 'names' or 'objects'. 'names' is the default. … … 200 199 * @since 2.3.0 201 200 * 202 201 * @uses $wp_taxonomies 203 * @uses taxonomy_exists() Checks whether taxonomy exists204 202 * 205 203 * @param string $taxonomy Name of taxonomy object to return 206 204 * @return object|bool The Taxonomy Object or false if $taxonomy doesn't exist … … 242 240 * 243 241 * @since 2.3.0 244 242 * 245 * @uses taxonomy_exists() Checks whether taxonomy exists246 * @uses get_taxonomy() Used to get the taxonomy object247 *248 243 * @param string $taxonomy Name of taxonomy object 249 244 * @return bool Whether the taxonomy is hierarchical 250 245 */ … … 568 563 * @since 2.3.0 569 564 * 570 565 * @uses $wpdb 571 * @uses wp_parse_args() Creates an array from string $args.572 566 * 573 567 * @param int|array $term_ids Term id or array of term ids of terms that will be used 574 568 * @param string|array $taxonomies String of taxonomy name or Array of string values of taxonomy names … … 1268 1262 * @since 2.3.0 1269 1263 * 1270 1264 * @uses $wpdb 1271 * @uses sanitize_term() Cleanses the term based on $filter context before returning.1272 1265 * @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param. 1273 1266 * 1274 1267 * @param int|object $term If integer, will get from database. If object will apply filters and return $term. … … 1364 1357 * @since 2.3.0 1365 1358 * 1366 1359 * @uses $wpdb 1367 * @uses sanitize_term() Cleanses the term based on $filter context before returning.1368 1360 * @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param. 1369 1361 * 1370 1362 * @param string $field Either 'slug', 'name', 'id' (term_id), or 'term_taxonomy_id' … … 1455 1447 * @since 2.3.0 1456 1448 * 1457 1449 * @uses $wpdb 1458 * @uses _get_term_hierarchy()1459 * @uses get_term_children() Used to get the children of both $taxonomy and the parent $term1460 1450 * 1461 1451 * @param string $term_id ID of Term to get children 1462 1452 * @param string $taxonomy Taxonomy Name … … 1496 1486 * 1497 1487 * @since 2.3.0 1498 1488 * 1499 * @uses sanitize_term_field() Passes the return value in sanitize_term_field on success.1500 *1501 1489 * @param string $field Term field to fetch 1502 1490 * @param int $term Term ID 1503 1491 * @param string $taxonomy Taxonomy Name … … 1527 1515 * 1528 1516 * @since 2.3.0 1529 1517 * 1530 * @uses sanitize_term() Passes the return value on success1531 *1532 1518 * @param int|object $id Term ID or Object 1533 1519 * @param string $taxonomy Taxonomy Name 1534 1520 * @return mixed|null|WP_Error Will return empty string if $term is not an object. … … 2105 2091 * 2106 2092 * @since 2.3.0 2107 2093 * 2108 * @uses sanitize_term_field Used to sanitize all fields in a term2109 *2110 2094 * @param array|object $term The term to check 2111 2095 * @param string $taxonomy The taxonomy name to use 2112 2096 * @param string $context Default is 'display'. … … 2315 2299 * 2316 2300 * @since 2.3.0 2317 2301 * 2318 * @uses get_terms()2319 * @uses wp_parse_args() Turns strings into arrays and merges defaults into an array.2320 *2321 2302 * @param string $taxonomy Taxonomy name 2322 2303 * @param array|string $args Overwrite defaults. See get_terms() 2323 2304 * @return int|WP_Error How many terms are in $taxonomy. WP_Error if $taxonomy does not exist. … … 2345 2326 * taxonomy itself. 2346 2327 * 2347 2328 * @since 2.3.0 2348 * @uses wp_remove_object_terms()2349 2329 * 2350 2330 * @param int $object_id The term Object Id that refers to the term 2351 2331 * @param string|array $taxonomies List of Taxonomy Names or single Taxonomy name. … … 2544 2524 * Deletes one existing category. 2545 2525 * 2546 2526 * @since 2.0.0 2547 * @uses wp_delete_term()2548 2527 * 2549 2528 * @param int $cat_ID 2550 2529 * @return mixed Returns true if completes delete action; false if term doesn't exist; … … 2967 2946 * exists under. 2968 2947 * 2969 2948 * @since 2.3.0 2970 * @uses wp_remove_object_terms()2971 2949 * 2972 2950 * @param int $object_id The object to relate to. 2973 2951 * @param array|int|string $terms A single term slug, single term id, or array of either term slugs or ids. … … 3091 3069 * Add term(s) associated with a given object. 3092 3070 * 3093 3071 * @since 3.6.0 3094 * @uses wp_set_object_terms()3095 3072 * 3096 3073 * @param int $object_id The ID of the object to which the terms will be added. 3097 3074 * @param array|int|string $terms The slug(s) or ID(s) of the term(s) to add. … … 3690 3667 * 3691 3668 * @since 2.3.0 3692 3669 * 3693 * @uses wp_cache_get() Retrieves taxonomy relationship from cache3694 *3695 3670 * @param int|array $id Term object ID 3696 3671 * @param string $taxonomy Taxonomy Name 3697 3672 * @return bool|array Empty array if $terms found, but not $taxonomy. False if nothing is in cache for $taxonomy and $id. … … 3715 3690 * for each term and it also increases for each taxonomy the term belongs to. 3716 3691 * 3717 3692 * @since 2.3.0 3718 * @uses wp_get_object_terms() Used to get terms from the database to update3719 3693 * 3720 3694 * @param string|array $object_ids Single or list of term object ID(s) 3721 3695 * @param array|string $object_type The taxonomy object type … … 3806 3780 * @access private 3807 3781 * @since 2.3.0 3808 3782 * 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 *3812 3783 * @param string $taxonomy Taxonomy Name 3813 3784 * @return array Empty if $taxonomy isn't hierarchical or returns children as Term IDs. 3814 3785 */ … … 4136 4107 * 'template' : The template to use for displaying the taxonomy terms. 4137 4108 * 4138 4109 * @since 2.5.0 4139 * @uses get_the_taxonomies()4140 4110 * 4141 4111 * @param array $args Override the defaults. 4142 4112 */ … … 4214 4184 * 4215 4185 * @since 2.5.0 4216 4186 * 4217 * @uses get_object_taxonomies()4218 *4219 4187 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. 4220 4188 * @return array 4221 4189 */ … … 4233 4201 * If no terms are given, determines if object is associated with any terms in the given taxonomy. 4234 4202 * 4235 4203 * @since 2.7.0 4236 * @uses get_object_term_cache()4237 * @uses wp_get_object_terms()4238 4204 * 4239 4205 * @param int $object_id ID of the object (post ID, link ID, ...) 4240 4206 * @param string $taxonomy Single taxonomy name … … 4279 4245 * Determine if the given object type is associated with the given taxonomy. 4280 4246 * 4281 4247 * @since 3.0.0 4282 * @uses get_object_taxonomies()4283 4248 * 4284 4249 * @param string $object_type Object type string 4285 4250 * @param string $taxonomy Single taxonomy name … … 4361 4326 * Attached to the wp_update_term_parent filter. 4362 4327 * 4363 4328 * @since 3.1.0 4364 * @uses wp_find_hierarchy_loop()4365 4329 * 4366 4330 * @param int $parent term_id of the parent for the term we're checking. 4367 4331 * @param int $term_id The term we're checking. -
src/wp-includes/theme.php
271 271 * Retrieve name of the current theme. 272 272 * 273 273 * @since 1.5.0 274 * @uses apply_filters() Calls 'template' filter on template option.275 274 * 276 275 * @return string Template name. 277 276 */ -
src/wp-includes/user.php
316 316 * 317 317 * @since MU 318 318 * 319 * @uses wp_get_current_user320 *321 319 * @return int The current user's ID 322 320 */ 323 321 function get_current_user_id() { … … 1111 1109 * Find out whether a user is a member of a given blog. 1112 1110 * 1113 1111 * @since MU 1.1 1114 * @uses get_blogs_of_user()1115 1112 * 1116 1113 * @param int $user_id Optional. The unique ID of the user. Defaults to the current user. 1117 1114 * @param int $blog_id Optional. ID of the blog to check. Defaults to the current site. … … 1137 1134 * Post meta data is called "Custom Fields" on the Administration Screens. 1138 1135 * 1139 1136 * @since 3.0.0 1140 * @uses add_metadata()1141 1137 * @link http://codex.wordpress.org/Function_Reference/add_user_meta 1142 1138 * 1143 1139 * @param int $user_id User ID. … … 1158 1154 * allows removing all metadata matching key, if needed. 1159 1155 * 1160 1156 * @since 3.0.0 1161 * @uses delete_metadata()1162 1157 * @link http://codex.wordpress.org/Function_Reference/delete_user_meta 1163 1158 * 1164 1159 * @param int $user_id user ID … … 1174 1169 * Retrieve user meta field for a user. 1175 1170 * 1176 1171 * @since 3.0.0 1177 * @uses get_metadata()1178 1172 * @link http://codex.wordpress.org/Function_Reference/get_user_meta 1179 1173 * 1180 1174 * @param int $user_id User ID. … … 1196 1190 * If the meta field for the user does not exist, it will be added. 1197 1191 * 1198 1192 * @since 3.0.0 1199 * @uses update_metadata1200 1193 * @link http://codex.wordpress.org/Function_Reference/update_user_meta 1201 1194 * 1202 1195 * @param int $user_id User ID. … … 1639 1632 * Checks whether an username is valid. 1640 1633 * 1641 1634 * @since 2.0.1 1642 * @uses apply_filters() Calls 'validate_username' hook on $valid check and $username as parameters1643 1635 * 1644 1636 * @param string $username Username. 1645 1637 * @return bool Whether username given is valid -
src/wp-includes/widgets.php
554 554 * @since 2.2.0 555 555 * 556 556 * @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 this559 * function to handle building the sidebar.560 557 * 561 558 * @param int $number Number of sidebars to create. 562 559 * @param string|array $args Builds Sidebar based off of 'name' and 'id' values. … … 631 628 * 632 629 * @since 2.2.0 633 630 * @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.635 631 * 636 632 * @param string|array $args Arguments for the sidebar being registered. 637 633 * @return string Sidebar ID added to $wp_registered_sidebars global. … … 932 928 * Remove control callback for widget. 933 929 * 934 930 * @since 2.2.0 935 * @uses wp_register_widget_control() Unregisters by using empty callback.936 931 * 937 932 * @param int|string $id Widget ID. 938 933 */ -
src/wp-includes/wp-db.php
867 867 /** 868 868 * Gets blog prefix. 869 869 * 870 * @uses is_multisite()871 870 * @since 3.0.0 872 871 * @param int $blog_id Optional. 873 872 * @return string Blog prefix. … … 906 905 * @uses wpdb::$old_tables 907 906 * @uses wpdb::$global_tables 908 907 * @uses wpdb::$ms_global_tables 909 * @uses is_multisite()910 908 * 911 909 * @param string $scope Optional. Can be all, global, ms_global, blog, or old tables. Defaults to all. 912 910 * @param bool $prefix Optional. Whether to include table prefixes. Default true. If blog -
src/wp-signup.php
153 153 * 154 154 * @since MU 155 155 * 156 * @uses wp_get_current_user() to retrieve the current user157 * @uses wpmu_validate_blog_signup() to validate new site signup for the current user158 156 * @return array Contains the new site data and error messages. 159 157 */ 160 158 function validate_blog_form() { … … 208 206 * 209 207 * @since MU 210 208 * 211 * @uses wpmu_validate_user_signup() to retrieve an array of user data212 209 * @return array Contains username, email, and error messages. 213 210 */ 214 211 function validate_user_form() { … … 220 217 * 221 218 * @since MU 222 219 * 223 * @uses wp_get_current_user() to get the current user224 220 * @param string $blogname The new site name 225 221 * @param string $blog_title The new blog title 226 222 * @param array $errors … … 303 299 * 304 300 * @since MU 305 301 * 306 * @uses wp_get_current_user() to retrieve the current user307 * @uses wpmu_create_blog() to add a new site308 * @uses confirm_another_blog_signup() to confirm the user's new site signup309 302 * @return bool True if blog signup was validated, false if error 310 303 */ 311 304 function validate_another_blog_signup() { … … 394 387 * 395 388 * @since MU 396 389 * 397 * @uses apply_filters() filter $filtered_results398 * @uses show_user_form() to display the user registration form399 390 * @param string $user_name The username 400 391 * @param string $user_email The user's email 401 392 * @param array $errors … … 467 458 * 468 459 * @since MU 469 460 * 470 * @uses validate_user_form() to retrieve an array of the user data471 * @uses wpmu_signup_user() to signup the new user472 * @uses confirm_user_signup() to confirm the new user signup473 461 * @return bool True if new user signup was validated, false if error 474 462 */ 475 463 function validate_user_signup() { … … 519 507 * 520 508 * @since MU 521 509 * 522 * @uses apply_filters() to filter $filtered_results523 * @uses show_blog_form() to display the blog signup form524 510 * @param string $user_name The username 525 511 * @param string $user_email The user's email address 526 512 * @param string $blogname The site name … … 584 570 * 585 571 * @since MU 586 572 * 587 * @uses wpmu_validate_user_signup() to retrieve an array of the new user data and errors588 * @uses wpmu_validate_blog_signup() to retrieve an array of the new site data and errors589 * @uses apply_filters() to make signup $meta filterable590 * @uses signup_user() to signup a new user591 * @uses signup_blog() to signup a the new user to a new site592 573 * @return bool True if the site signup was validated, false if error 593 574 */ 594 575 function validate_blog_signup() {
![(please configure the [header_logo] section in trac.ini)](/chrome/site/your_project_logo.png)