X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/7f1521bf193b382565eb753043c161f4cb3fcda7..4feeb71a9d812a9ae371c28a3d8b442a4394ded7:/wp-includes/deprecated.php diff --git a/wp-includes/deprecated.php b/wp-includes/deprecated.php index 6345bd7c..f79761ba 100644 --- a/wp-includes/deprecated.php +++ b/wp-includes/deprecated.php @@ -13,15 +13,14 @@ */ /** - * Entire Post data. + * Retrieves all post data for a given post. * * @since 0.71 - * @deprecated 1.5.1 - * @deprecated Use get_post() + * @deprecated 1.5.1 Use get_post() * @see get_post() * - * @param int $postid - * @return array + * @param int $postid Post ID. + * @return array Post data. */ function get_postdata($postid) { _deprecated_function( __FUNCTION__, '1.5.1', 'get_post()' ); @@ -52,9 +51,12 @@ function get_postdata($postid) { /** * Sets up the WordPress Loop. * + * Use The Loop instead. + * + * @link https://codex.wordpress.org/The_Loop + * * @since 1.0.1 * @deprecated 1.5.0 - * @deprecated Use The Loop - {@link https://codex.wordpress.org/The_Loop Use new WordPress Loop} */ function start_wp() { global $wp_query; @@ -68,15 +70,14 @@ function start_wp() { } /** - * Return or Print Category ID. + * Returns or prints a category ID. * * @since 0.71 - * @deprecated 0.71 - * @deprecated use get_the_category() + * @deprecated 0.71 Use get_the_category() * @see get_the_category() * - * @param bool $echo - * @return null|int + * @param bool $echo Optional. Whether to echo the output. Default true. + * @return int Category ID. */ function the_category_ID($echo = true) { _deprecated_function( __FUNCTION__, '0.71', 'get_the_category()' ); @@ -92,17 +93,16 @@ function the_category_ID($echo = true) { } /** - * Print category with optional text before and after. + * Prints a category with optional text before and after. * * @since 0.71 - * @deprecated 0.71 - * @deprecated use get_the_category_by_ID() + * @deprecated 0.71 Use get_the_category_by_ID() * @see get_the_category_by_ID() * - * @param string $before - * @param string $after + * @param string $before Optional. Text to display before the category. Default empty. + * @param string $after Optional. Text to display after the category. Default empty. */ -function the_category_head($before='', $after='') { +function the_category_head( $before = '', $after = '' ) { global $currentcat, $previouscat; _deprecated_function( __FUNCTION__, '0.71', 'get_the_category_by_ID()' ); @@ -119,18 +119,17 @@ function the_category_head($before='', $after='') { } /** - * Prints link to the previous post. + * Prints a link to the previous post. * * @since 1.5.0 - * @deprecated 2.0.0 - * @deprecated Use previous_post_link() + * @deprecated 2.0.0 Use previous_post_link() * @see previous_post_link() * * @param string $format * @param string $previous * @param string $title * @param string $in_same_cat - * @param int $limitprev + * @param int $limitprev * @param string $excluded_categories */ function previous_post($format='%', $previous='previous post: ', $title='yes', $in_same_cat='no', $limitprev=1, $excluded_categories='') { @@ -159,8 +158,7 @@ function previous_post($format='%', $previous='previous post: ', $title='yes', $ * Prints link to the next post. * * @since 0.71 - * @deprecated 2.0.0 - * @deprecated Use next_post_link() + * @deprecated 2.0.0 Use next_post_link() * @see next_post_link() * * @param string $format @@ -195,8 +193,7 @@ function next_post($format='%', $next='next post: ', $title='yes', $in_same_cat= * Whether user can create a post. * * @since 1.5.0 - * @deprecated 2.0.0 - * @deprecated Use current_user_can() + * @deprecated 2.0.0 Use current_user_can() * @see current_user_can() * * @param int $user_id @@ -215,8 +212,7 @@ function user_can_create_post($user_id, $blog_id = 1, $category_id = 'None') { * Whether user can create a post. * * @since 1.5.0 - * @deprecated 2.0.0 - * @deprecated Use current_user_can() + * @deprecated 2.0.0 Use current_user_can() * @see current_user_can() * * @param int $user_id @@ -235,8 +231,7 @@ function user_can_create_draft($user_id, $blog_id = 1, $category_id = 'None') { * Whether user can edit a post. * * @since 1.5.0 - * @deprecated 2.0.0 - * @deprecated Use current_user_can() + * @deprecated 2.0.0 Use current_user_can() * @see current_user_can() * * @param int $user_id @@ -264,8 +259,7 @@ function user_can_edit_post($user_id, $post_id, $blog_id = 1) { * Whether user can delete a post. * * @since 1.5.0 - * @deprecated 2.0.0 - * @deprecated Use current_user_can() + * @deprecated 2.0.0 Use current_user_can() * @see current_user_can() * * @param int $user_id @@ -284,8 +278,7 @@ function user_can_delete_post($user_id, $post_id, $blog_id = 1) { * Whether user can set new posts' dates. * * @since 1.5.0 - * @deprecated 2.0.0 - * @deprecated Use current_user_can() + * @deprecated 2.0.0 Use current_user_can() * @see current_user_can() * * @param int $user_id @@ -304,8 +297,7 @@ function user_can_set_post_date($user_id, $blog_id = 1, $category_id = 'None') { * Whether user can delete a post. * * @since 1.5.0 - * @deprecated 2.0.0 - * @deprecated Use current_user_can() + * @deprecated 2.0.0 Use current_user_can() * @see current_user_can() * * @param int $user_id @@ -324,8 +316,7 @@ function user_can_edit_post_date($user_id, $post_id, $blog_id = 1) { * Whether user can delete a post. * * @since 1.5.0 - * @deprecated 2.0.0 - * @deprecated Use current_user_can() + * @deprecated 2.0.0 Use current_user_can() * @see current_user_can() * * @param int $user_id @@ -344,8 +335,7 @@ function user_can_edit_post_comments($user_id, $post_id, $blog_id = 1) { * Whether user can delete a post. * * @since 1.5.0 - * @deprecated 2.0.0 - * @deprecated Use current_user_can() + * @deprecated 2.0.0 Use current_user_can() * @see current_user_can() * * @param int $user_id @@ -364,8 +354,7 @@ function user_can_delete_post_comments($user_id, $post_id, $blog_id = 1) { * Can user can edit other user. * * @since 1.5.0 - * @deprecated 2.0.0 - * @deprecated Use current_user_can() + * @deprecated 2.0.0 Use current_user_can() * @see current_user_can() * * @param int $user_id @@ -387,8 +376,7 @@ function user_can_edit_user($user_id, $other_user) { * Gets the links associated with category $cat_name. * * @since 0.71 - * @deprecated 2.1.0 - * @deprecated Use get_bookmarks() + * @deprecated 2.1.0 Use get_bookmarks() * @see get_bookmarks() * * @param string $cat_name Optional. The category name to use. If no match is found uses all. @@ -421,8 +409,7 @@ function get_linksbyname($cat_name = "noname", $before = '', $after = '
', * Gets the links associated with the named category. * * @since 1.0.1 - * @deprecated 2.1.0 - * @deprecated Use wp_list_bookmarks() + * @deprecated 2.1.0 Use wp_list_bookmarks() * @see wp_list_bookmarks() * * @param string $category The category to use. @@ -457,8 +444,7 @@ function wp_get_linksbyname($category, $args = '') { * } * * @since 1.0.1 - * @deprecated 2.1.0 - * @deprecated Use get_bookmarks() + * @deprecated 2.1.0 Use get_bookmarks() * @see get_bookmarks() * * @param string $cat_name The category name to use. If no match is found uses all. @@ -508,8 +494,7 @@ function get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit * - link_notes * * @since 1.0.1 - * @deprecated 2.1.0 - * @deprecated Use get_bookmarks() + * @deprecated 2.1.0 Use get_bookmarks() * @see get_bookmarks() * * @param int $category The category to use. If no category supplied uses all @@ -536,8 +521,7 @@ function get_linkobjects($category = 0, $orderby = 'name', $limit = 0) { * Gets the links associated with category 'cat_name' and display rating stars/chars. * * @since 0.71 - * @deprecated 2.1.0 - * @deprecated Use get_bookmarks() + * @deprecated 2.1.0 Use get_bookmarks() * @see get_bookmarks() * * @param string $cat_name The category name to use. If no match is found uses all @@ -564,8 +548,7 @@ function get_linksbyname_withrating($cat_name = "noname", $before = '', $after = * Gets the links associated with category n and display rating stars/chars. * * @since 0.71 - * @deprecated 2.1.0 - * @deprecated Use get_bookmarks() + * @deprecated 2.1.0 Use get_bookmarks() * @see get_bookmarks() * * @param int $category The category to use. If no category supplied uses all @@ -593,7 +576,6 @@ function get_links_withrating($category = -1, $before = '', $after = '
', $ * * @since 0.71 * @deprecated 2.1.0 - * @deprecated No alternative function available * * @param int $id The category to get. If no category supplied uses 0 * @return int Only returns 0. @@ -604,9 +586,10 @@ function get_autotoggle($id = 0) { } /** + * Lists categories. + * * @since 0.71 - * @deprecated 2.1.0 - * @deprecated Use wp_list_categories() + * @deprecated 2.1.0 Use wp_list_categories() * @see wp_list_categories() * * @param int $optionall @@ -640,9 +623,10 @@ function list_cats($optionall = 1, $all = 'All', $sort_column = 'ID', $sort_orde } /** + * Lists categories. + * * @since 1.2.0 - * @deprecated 2.1.0 - * @deprecated Use wp_list_categories() + * @deprecated 2.1.0 Use wp_list_categories() * @see wp_list_categories() * * @param string|array $args @@ -672,9 +656,10 @@ function wp_list_cats($args = '') { } /** + * Deprecated method for generating a drop-down of categories. + * * @since 0.71 - * @deprecated 2.1.0 - * @deprecated Use wp_dropdown_categories() + * @deprecated 2.1.0 Use wp_dropdown_categories() * @see wp_dropdown_categories() * * @param int $optionall @@ -709,11 +694,10 @@ function dropdown_cats($optionall = 1, $all = 'All', $orderby = 'ID', $order = ' } /** - * List authors. + * Lists authors. * * @since 1.2.0 - * @deprecated 2.1.0 - * @deprecated Use wp_list_authors() + * @deprecated 2.1.0 Use wp_list_authors() * @see wp_list_authors() * * @param bool $optioncount @@ -732,9 +716,10 @@ function list_authors($optioncount = false, $exclude_admin = true, $show_fullnam } /** + * Retrieves a list of post categories. + * * @since 1.0.1 - * @deprecated 2.1.0 - * @deprecated Use wp_get_post_categories() + * @deprecated 2.1.0 Use wp_get_post_categories() * @see wp_get_post_categories() * * @param int $blogid Not Used @@ -765,9 +750,10 @@ function wp_set_post_cats($blogid = '1', $post_ID = 0, $post_categories = array( } /** + * Retrieves a list of archives. + * * @since 0.71 - * @deprecated 2.1.0 - * @deprecated Use wp_get_archives() + * @deprecated 2.1.0 Use wp_get_archives() * @see wp_get_archives() * * @param string $type @@ -788,8 +774,7 @@ function get_archives($type='', $limit='', $format='html', $before = '', $after * Returns or Prints link to the author's posts. * * @since 1.2.0 - * @deprecated 2.1.0 - * @deprecated Use get_author_posts_url() + * @deprecated 2.1.0 Use get_author_posts_url() * @see get_author_posts_url() * * @param bool $echo @@ -811,8 +796,7 @@ function get_author_link($echo, $author_id, $author_nicename = '') { * Print list of pages based on arguments. * * @since 0.71 - * @deprecated 2.1.0 - * @deprecated Use wp_link_pages() + * @deprecated 2.1.0 Use wp_link_pages() * @see wp_link_pages() * * @param string $before @@ -836,8 +820,7 @@ function link_pages($before='
', $after='
', $next_or_number='number', * Get value based on option. * * @since 0.71 - * @deprecated 2.1.0 - * @deprecated Use get_option() + * @deprecated 2.1.0 Use get_option() * @see get_option() * * @param string $option @@ -853,8 +836,7 @@ function get_settings($option) { * Print the permalink of the current post in the loop. * * @since 0.71 - * @deprecated 1.2.0 - * @deprecated Use the_permalink() + * @deprecated 1.2.0 Use the_permalink() * @see the_permalink() */ function permalink_link() { @@ -866,8 +848,7 @@ function permalink_link() { * Print the permalink to the RSS feed. * * @since 0.71 - * @deprecated 2.3.0 - * @deprecated Use the_permalink_rss() + * @deprecated 2.3.0 Use the_permalink_rss() * @see the_permalink_rss() * * @param string $deprecated @@ -880,10 +861,8 @@ function permalink_single_rss($deprecated = '') { /** * Gets the links associated with category. * - * @see get_links() for argument information that can be used in $args * @since 1.0.1 - * @deprecated 2.1.0 - * @deprecated Use wp_list_bookmarks() + * @deprecated 2.1.0 Use wp_list_bookmarks() * @see wp_list_bookmarks() * * @param string $args a query string @@ -922,8 +901,7 @@ function wp_get_links($args = '') { * Gets the links associated with category by id. * * @since 0.71 - * @deprecated 2.1.0 - * @deprecated Use get_bookmarks() + * @deprecated 2.1.0 Use get_bookmarks() * @see get_bookmarks() * * @param int $category The category to use. If no category supplied uses all @@ -1031,8 +1009,7 @@ function get_links($category = -1, $before = '', $after = '
', $between = ' * $wpdb->linkcategories and output it as a nested HTML unordered list. * * @since 1.0.1 - * @deprecated 2.1.0 - * @deprecated Use wp_list_bookmarks() + * @deprecated 2.1.0 Use wp_list_bookmarks() * @see wp_list_bookmarks() * * @param string $order Sort link categories by 'name' or 'id' @@ -1075,7 +1052,6 @@ function get_links_list($order = 'name') { * * @since 0.71 * @deprecated 2.1.0 - * @deprecated {@internal Use function instead is unknown}} * * @param string $text the text of the link * @param int $width the width of the popup window @@ -1088,15 +1064,16 @@ function links_popup_script($text = 'Links', $width=400, $height=400, $file='lin } /** + * Legacy function that retrieved the value of a link's link_rating field. + * * @since 1.0.1 - * @deprecated 2.1.0 - * @deprecated Use sanitize_bookmark_field() + * @deprecated 2.1.0 Use sanitize_bookmark_field() * @see sanitize_bookmark_field() * - * @param object $link - * @return mixed + * @param object $link Link object. + * @return mixed Value of the 'link_rating' field, false otherwise. */ -function get_linkrating($link) { +function get_linkrating( $link ) { _deprecated_function( __FUNCTION__, '2.1', 'sanitize_bookmark_field()' ); return sanitize_bookmark_field('link_rating', $link->link_rating, $link->link_id, 'display'); } @@ -1105,8 +1082,7 @@ function get_linkrating($link) { * Gets the name of category by id. * * @since 0.71 - * @deprecated 2.1.0 - * @deprecated Use get_category() + * @deprecated 2.1.0 Use get_category() * @see get_category() * * @param int $id The category to get. If no category supplied uses 0 @@ -1135,8 +1111,7 @@ function get_linkcatname($id = 0) { * Print RSS comment feed link. * * @since 1.0.1 - * @deprecated 2.5.0 - * @deprecated Use post_comments_feed_link() + * @deprecated 2.5.0 Use post_comments_feed_link() * @see post_comments_feed_link() * * @param string $link_text @@ -1150,8 +1125,7 @@ function comments_rss_link($link_text = 'Comments RSS') { * Print/Return link to category RSS2 feed. * * @since 1.2.0 - * @deprecated 2.5.0 - * @deprecated Use get_category_feed_link() + * @deprecated 2.5.0 Use get_category_feed_link() * @see get_category_feed_link() * * @param bool $echo @@ -1172,8 +1146,7 @@ function get_category_rss_link($echo = false, $cat_ID = 1) { * Print/Return link to author RSS feed. * * @since 1.2.0 - * @deprecated 2.5.0 - * @deprecated Use get_author_feed_link() + * @deprecated 2.5.0 Use get_author_feed_link() * @see get_author_feed_link() * * @param bool $echo @@ -1193,8 +1166,7 @@ function get_author_rss_link($echo = false, $author_id = 1) { * Return link to the post RSS feed. * * @since 1.5.0 - * @deprecated 2.2.0 - * @deprecated Use get_post_comments_feed_link() + * @deprecated 2.2.0 Use get_post_comments_feed_link() * @see get_post_comments_feed_link() * * @return string @@ -1208,8 +1180,7 @@ function comments_rss() { * An alias of wp_create_user(). * * @since 2.0.0 - * @deprecated 2.0.0 - * @deprecated Use wp_create_user() + * @deprecated 2.0.0 Use wp_create_user() * @see wp_create_user() * * @param string $username The user's username. @@ -1226,7 +1197,7 @@ function create_user($username, $password, $email) { * Unused function. * * @deprecated 2.5.0 -*/ + */ function gzip_compression() { _deprecated_function( __FUNCTION__, '2.5' ); return false; @@ -1236,8 +1207,7 @@ function gzip_compression() { * Retrieve an array of comment data about comment $comment_ID. * * @since 0.71 - * @deprecated 2.7.0 - * @deprecated Use get_comment() + * @deprecated 2.7.0 Use get_comment() * @see get_comment() * * @param int $comment_ID The ID of the comment @@ -1254,8 +1224,7 @@ function get_commentdata( $comment_ID, $no_cache = 0, $include_unapproved = fals * Retrieve the category name by the category ID. * * @since 0.71 - * @deprecated 2.8.0 - * @deprecated Use get_cat_name() + * @deprecated 2.8.0 Use get_cat_name() * @see get_cat_name() * * @param int $cat_ID Category ID @@ -1270,8 +1239,7 @@ function get_catname( $cat_ID ) { * Retrieve category children list separated before and after the term IDs. * * @since 1.2.0 - * @deprecated 2.8.0 - * @deprecated Use get_term_children() + * @deprecated 2.8.0 Use get_term_children() * @see get_term_children() * * @param int $id Category ID to retrieve children. @@ -1308,8 +1276,9 @@ function get_category_children( $id, $before = '/', $after = '', $visited = arra * Retrieves all category IDs. * * @since 2.0.0 - * @deprecated 4.0.0 Use get_terms() instead. + * @deprecated 4.0.0 Use get_terms() * @see get_terms() + * * @link https://codex.wordpress.org/Function_Reference/get_all_category_ids * * @return object List of all of the category IDs. @@ -1329,8 +1298,7 @@ function get_all_category_ids() { * Retrieve the description of the author of the current post. * * @since 1.5.0 - * @deprecated 2.8.0 - * @deprecated Use get_the_author_meta('description') + * @deprecated 2.8.0 Use get_the_author_meta() * @see get_the_author_meta() * * @return string The author's description. @@ -1344,8 +1312,7 @@ function get_the_author_description() { * Display the description of the author of the current post. * * @since 1.0.0 - * @deprecated 2.8.0 - * @deprecated Use the_author_meta('description') + * @deprecated 2.8.0 Use the_author_meta() * @see the_author_meta() */ function the_author_description() { @@ -1357,8 +1324,7 @@ function the_author_description() { * Retrieve the login name of the author of the current post. * * @since 1.5.0 - * @deprecated 2.8.0 - * @deprecated Use get_the_author_meta('login') + * @deprecated 2.8.0 Use get_the_author_meta() * @see get_the_author_meta() * * @return string The author's login name (username). @@ -1372,8 +1338,7 @@ function get_the_author_login() { * Display the login name of the author of the current post. * * @since 0.71 - * @deprecated 2.8.0 - * @deprecated Use the_author_meta('login') + * @deprecated 2.8.0 Use the_author_meta() * @see the_author_meta() */ function the_author_login() { @@ -1385,8 +1350,7 @@ function the_author_login() { * Retrieve the first name of the author of the current post. * * @since 1.5.0 - * @deprecated 2.8.0 - * @deprecated Use get_the_author_meta('first_name') + * @deprecated 2.8.0 Use get_the_author_meta() * @see get_the_author_meta() * * @return string The author's first name. @@ -1400,8 +1364,7 @@ function get_the_author_firstname() { * Display the first name of the author of the current post. * * @since 0.71 - * @deprecated 2.8.0 - * @deprecated Use the_author_meta('first_name') + * @deprecated 2.8.0 Use the_author_meta() * @see the_author_meta() */ function the_author_firstname() { @@ -1413,8 +1376,7 @@ function the_author_firstname() { * Retrieve the last name of the author of the current post. * * @since 1.5.0 - * @deprecated 2.8.0 - * @deprecated Use get_the_author_meta('last_name') + * @deprecated 2.8.0 Use get_the_author_meta() * @see get_the_author_meta() * * @return string The author's last name. @@ -1428,8 +1390,7 @@ function get_the_author_lastname() { * Display the last name of the author of the current post. * * @since 0.71 - * @deprecated 2.8.0 - * @deprecated Use the_author_meta('last_name') + * @deprecated 2.8.0 Use the_author_meta() * @see the_author_meta() */ function the_author_lastname() { @@ -1441,8 +1402,7 @@ function the_author_lastname() { * Retrieve the nickname of the author of the current post. * * @since 1.5.0 - * @deprecated 2.8.0 - * @deprecated Use get_the_author_meta('nickname') + * @deprecated 2.8.0 Use get_the_author_meta() * @see get_the_author_meta() * * @return string The author's nickname. @@ -1456,8 +1416,7 @@ function get_the_author_nickname() { * Display the nickname of the author of the current post. * * @since 0.71 - * @deprecated 2.8.0 - * @deprecated Use the_author_meta('nickname') + * @deprecated 2.8.0 Use the_author_meta() * @see the_author_meta() */ function the_author_nickname() { @@ -1469,8 +1428,7 @@ function the_author_nickname() { * Retrieve the email of the author of the current post. * * @since 1.5.0 - * @deprecated 2.8.0 - * @deprecated Use get_the_author_meta('email') + * @deprecated 2.8.0 Use get_the_author_meta() * @see get_the_author_meta() * * @return string The author's username. @@ -1484,8 +1442,7 @@ function get_the_author_email() { * Display the email of the author of the current post. * * @since 0.71 - * @deprecated 2.8.0 - * @deprecated Use the_author_meta('email') + * @deprecated 2.8.0 Use the_author_meta() * @see the_author_meta() */ function the_author_email() { @@ -1497,8 +1454,7 @@ function the_author_email() { * Retrieve the ICQ number of the author of the current post. * * @since 1.5.0 - * @deprecated 2.8.0 - * @deprecated Use get_the_author_meta('icq') + * @deprecated 2.8.0 Use get_the_author_meta() * @see get_the_author_meta() * * @return string The author's ICQ number. @@ -1512,8 +1468,7 @@ function get_the_author_icq() { * Display the ICQ number of the author of the current post. * * @since 0.71 - * @deprecated 2.8.0 - * @deprecated Use the_author_meta('icq') + * @deprecated 2.8.0 Use the_author_meta() * @see the_author_meta() */ function the_author_icq() { @@ -1525,8 +1480,7 @@ function the_author_icq() { * Retrieve the Yahoo! IM name of the author of the current post. * * @since 1.5.0 - * @deprecated 2.8.0 - * @deprecated Use get_the_author_meta('yim') + * @deprecated 2.8.0 Use get_the_author_meta() * @see get_the_author_meta() * * @return string The author's Yahoo! IM name. @@ -1540,8 +1494,7 @@ function get_the_author_yim() { * Display the Yahoo! IM name of the author of the current post. * * @since 0.71 - * @deprecated 2.8.0 - * @deprecated Use the_author_meta('yim') + * @deprecated 2.8.0 Use the_author_meta() * @see the_author_meta() */ function the_author_yim() { @@ -1553,8 +1506,7 @@ function the_author_yim() { * Retrieve the MSN address of the author of the current post. * * @since 1.5.0 - * @deprecated 2.8.0 - * @deprecated Use get_the_author_meta('msn') + * @deprecated 2.8.0 Use get_the_author_meta() * @see get_the_author_meta() * * @return string The author's MSN address. @@ -1568,8 +1520,7 @@ function get_the_author_msn() { * Display the MSN address of the author of the current post. * * @since 0.71 - * @deprecated 2.8.0 - * @deprecated Use the_author_meta('msn') + * @deprecated 2.8.0 Use the_author_meta() * @see the_author_meta() */ function the_author_msn() { @@ -1581,8 +1532,7 @@ function the_author_msn() { * Retrieve the AIM address of the author of the current post. * * @since 1.5.0 - * @deprecated 2.8.0 - * @deprecated Use get_the_author_meta('aim') + * @deprecated 2.8.0 Use get_the_author_meta() * @see get_the_author_meta() * * @return string The author's AIM address. @@ -1596,9 +1546,8 @@ function get_the_author_aim() { * Display the AIM address of the author of the current post. * * @since 0.71 + * @deprecated 2.8.0 Use the_author_meta('aim') * @see the_author_meta() - * @deprecated 2.8.0 - * @deprecated Use the_author_meta('aim') */ function the_author_aim() { _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'aim\')' ); @@ -1609,8 +1558,7 @@ function the_author_aim() { * Retrieve the specified author's preferred display name. * * @since 1.0.0 - * @deprecated 2.8.0 - * @deprecated Use get_the_author_meta('display_name') + * @deprecated 2.8.0 Use get_the_author_meta() * @see get_the_author_meta() * * @param int $auth_id The ID of the author. @@ -1625,8 +1573,7 @@ function get_author_name( $auth_id = false ) { * Retrieve the URL to the home page of the author of the current post. * * @since 1.5.0 - * @deprecated 2.8.0 - * @deprecated Use get_the_author_meta('url') + * @deprecated 2.8.0 Use get_the_author_meta() * @see get_the_author_meta() * * @return string The URL to the author's page. @@ -1640,8 +1587,7 @@ function get_the_author_url() { * Display the URL to the home page of the author of the current post. * * @since 0.71 - * @deprecated 2.8.0 - * @deprecated Use the_author_meta('url') + * @deprecated 2.8.0 Use the_author_meta() * @see the_author_meta() */ function the_author_url() { @@ -1653,8 +1599,7 @@ function the_author_url() { * Retrieve the ID of the author of the current post. * * @since 1.5.0 - * @deprecated 2.8.0 - * @deprecated Use get_the_author_meta('ID') + * @deprecated 2.8.0 Use get_the_author_meta() * @see get_the_author_meta() * * @return string|int The author's ID. @@ -1668,10 +1613,9 @@ function get_the_author_ID() { * Display the ID of the author of the current post. * * @since 0.71 - * @deprecated 2.8.0 - * @deprecated Use the_author_meta('ID') + * @deprecated 2.8.0 Use the_author_meta() * @see the_author_meta() -*/ + */ function the_author_ID() { _deprecated_function( __FUNCTION__, '2.8', 'the_author_meta(\'ID\')' ); the_author_meta('ID'); @@ -1696,8 +1640,7 @@ function the_author_ID() { * * @since 0.71 * - * @deprecated 2.9.0 - * @deprecated Use the_content_feed() + * @deprecated 2.9.0 Use the_content_feed() * @see the_content_feed() * * @param string $more_link_text Optional. Text to display when more content is available but not displayed. @@ -1784,8 +1727,7 @@ function make_url_footnote( $content ) { * everything is returned. * * @since 2.2.0 - * @deprecated 2.9.0 - * @deprecated Use _x() + * @deprecated 2.9.0 Use _x() * @see _x() * * @param string $text Text to translate @@ -1802,8 +1744,7 @@ function _c( $text, $domain = 'default' ) { * contains a context after its last vertical bar. * * @since 2.5.0 - * @deprecated 3.0.0 - * @deprecated Use _x() + * @deprecated 3.0.0 Use _x() * @see _x() * * @param string $text Text to translate @@ -1816,16 +1757,20 @@ function translate_with_context( $text, $domain = 'default' ) { } /** - * A version of _n(), which supports contexts. + * Legacy version of _n(), which supports contexts. + * * Strips everything from the translation after the last bar. * * @since 2.7.0 - * @deprecated 3.0.0 - * @deprecated Use _nx() + * @deprecated 3.0.0 Use _nx() * @see _nx() - * @see _n() For parameters. - * @see _c() For parameters. _c() is deprecated. * + * @param string $single The text to be used if the number is singular. + * @param string $plural The text to be used if the number is plural. + * @param int $number The number to compare against to use either the singular or plural form. + * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings. + * Default 'default'. + * @return string The translated singular or plural form. */ function _nc( $single, $plural, $number, $domain = 'default' ) { _deprecated_function( __FUNCTION__, '2.9', '_nx()' ); @@ -1836,8 +1781,7 @@ function _nc( $single, $plural, $number, $domain = 'default' ) { * Retrieve the plural or single form based on the amount. * * @since 1.2.0 - * @deprecated 2.8.0 - * @deprecated Use _n() + * @deprecated 2.8.0 Use _n() * @see _n() */ function __ngettext() { @@ -1850,8 +1794,7 @@ function __ngettext() { * Register plural strings in POT file, but don't translate them. * * @since 2.5.0 - * @deprecated 2.8.0 - * @deprecated Use _n_noop() + * @deprecated 2.8.0 Use _n_noop() * @see _n_noop() */ function __ngettext_noop() { @@ -1865,8 +1808,7 @@ function __ngettext_noop() { * Retrieve all autoload options, or all options if no autoloaded ones exist. * * @since 1.0.0 - * @deprecated 3.0.0 - * @deprecated Use wp_load_alloptions()) + * @deprecated 3.0.0 Use wp_load_alloptions()) * @see wp_load_alloptions() * * @return array List of all options. @@ -1880,8 +1822,7 @@ function get_alloptions() { * Retrieve HTML content of attachment image with link. * * @since 2.0.0 - * @deprecated 2.5.0 - * @deprecated Use wp_get_attachment_link() + * @deprecated 2.5.0 Use wp_get_attachment_link() * @see wp_get_attachment_link() * * @param int $id Optional. Post ID. @@ -1911,8 +1852,7 @@ function get_the_attachment_link($id = 0, $fullsize = false, $max_dims = false, * Retrieve icon URL and Path. * * @since 2.1.0 - * @deprecated 2.5.0 - * @deprecated Use wp_get_attachment_image_src() + * @deprecated 2.5.0 Use wp_get_attachment_image_src() * @see wp_get_attachment_image_src() * * @param int $id Optional. Post ID. @@ -1953,8 +1893,7 @@ function get_attachment_icon_src( $id = 0, $fullsize = false ) { * Retrieve HTML content of icon attachment image element. * * @since 2.0.0 - * @deprecated 2.5.0 - * @deprecated Use wp_get_attachment_image() + * @deprecated 2.5.0 Use wp_get_attachment_image() * @see wp_get_attachment_image() * * @param int $id Optional. Post ID. @@ -2010,8 +1949,7 @@ function get_attachment_icon( $id = 0, $fullsize = false, $max_dims = false ) { * Retrieve HTML content of image element. * * @since 2.0.0 - * @deprecated 2.5.0 - * @deprecated Use wp_get_attachment_image() + * @deprecated 2.5.0 Use wp_get_attachment_image() * @see wp_get_attachment_image() * * @param int $id Optional. Post ID. @@ -2034,18 +1972,20 @@ function get_attachment_innerHTML($id = 0, $fullsize = false, $max_dims = false) } /** - * Retrieve bookmark data based on ID. + * Retrieves bookmark data based on ID. * * @since 2.0.0 - * @deprecated 2.1.0 - * @deprecated Use get_bookmark() + * @deprecated 2.1.0 Use get_bookmark() * @see get_bookmark() * - * @param int $bookmark_id ID of link - * @param string $output OBJECT, ARRAY_N, or ARRAY_A - * @return object|array + * @param int $bookmark_id ID of link + * @param string $output Optional. Type of output. Accepts OBJECT, ARRAY_N, or ARRAY_A. + * Default OBJECT. + * @param string $filter Optional. How to filter the link for output. Accepts 'raw', 'edit', + * 'attribute', 'js', 'db', or 'display'. Default 'raw'. + * @return object|array Bookmark object or array, depending on the type specified by `$output`. */ -function get_link($bookmark_id, $output = OBJECT, $filter = 'raw') { +function get_link( $bookmark_id, $output = OBJECT, $filter = 'raw' ) { _deprecated_function( __FUNCTION__, '2.1', 'get_bookmark()' ); return get_bookmark($bookmark_id, $output, $filter); } @@ -2054,8 +1994,7 @@ function get_link($bookmark_id, $output = OBJECT, $filter = 'raw') { * Performs esc_url() for database or redirect usage. * * @since 2.3.1 - * @deprecated 2.8.0 - * @deprecated Use esc_url_raw() + * @deprecated 2.8.0 Use esc_url_raw() * @see esc_url_raw() * * @param string $url The URL to be cleaned. @@ -2075,8 +2014,7 @@ function sanitize_url( $url, $protocols = null ) { * is applied to the returned cleaned URL. * * @since 1.2.0 - * @deprecated 3.0.0 - * @deprecated Use esc_url() + * @deprecated 3.0.0 Use esc_url() * @see Alias for esc_url() * * @param string $url The URL to be cleaned. @@ -2098,8 +2036,7 @@ function clean_url( $url, $protocols = null, $context = 'display' ) { * The filter 'js_escape' is also applied by esc_js() * * @since 2.0.4 - * @deprecated 2.8.0 - * @deprecated Use esc_js() + * @deprecated 2.8.0 Use esc_js() * @see esc_js() * * @param string $text The text to be escaped. @@ -2111,11 +2048,16 @@ function js_escape( $text ) { } /** - * Escaping for HTML blocks. + * Legacy escaping for HTML blocks. * - * @deprecated 2.8.0 - * @deprecated Use esc_html() + * @deprecated 2.8.0 Use esc_html() * @see esc_html() + * + * @param string $string String to escape. + * @param string $quote_style Unused. + * @param false|string $charset Unused. + * @param false $double_encode Whether to double encode. Unused. + * @return string Escaped `$string`. */ function wp_specialchars( $string, $quote_style = ENT_NOQUOTES, $charset = false, $double_encode = false ) { _deprecated_function( __FUNCTION__, '2.8', 'esc_html()' ); @@ -2131,8 +2073,7 @@ function wp_specialchars( $string, $quote_style = ENT_NOQUOTES, $charset = false * Escaping for HTML attributes. * * @since 2.0.6 - * @deprecated 2.8.0 - * @deprecated Use esc_attr() + * @deprecated 2.8.0 Use esc_attr() * @see esc_attr() * * @param string $text @@ -2154,14 +2095,13 @@ function attribute_escape( $text ) { * backwards compatibility is complete. * * @since 2.2.0 - * @deprecated 2.8.0 - * @deprecated Use wp_register_sidebar_widget() + * @deprecated 2.8.0 Use wp_register_sidebar_widget() * @see wp_register_sidebar_widget() * - * @param string|int $name Widget ID. - * @param callback $output_callback Run when widget is called. - * @param string $classname Classname widget option. - * @param mixed $params ,... Widget parameters. + * @param string|int $name Widget ID. + * @param callable $output_callback Run when widget is called. + * @param string $classname Optional. Classname widget option. Default empty. + * @param mixed $params ,... Widget parameters. */ function register_sidebar_widget($name, $output_callback, $classname = '') { _deprecated_function( __FUNCTION__, '2.8', 'wp_register_sidebar_widget()' ); @@ -2189,8 +2129,7 @@ function register_sidebar_widget($name, $output_callback, $classname = '') { * Alias of {@link wp_unregister_sidebar_widget()}. * * @since 2.2.0 - * @deprecated 2.8.0 - * @deprecated Use wp_unregister_sidebar_widget() + * @deprecated 2.8.0 Use wp_unregister_sidebar_widget() * @see wp_unregister_sidebar_widget() * * @param int|string $id Widget ID. @@ -2207,16 +2146,15 @@ function unregister_sidebar_widget($id) { * first element and the third for the name or just uses the first element of * the array for the name. * - * Passes to {@link wp_register_widget_control()} after the argument list has + * Passes to wp_register_widget_control() after the argument list has * been compiled. * * @since 2.2.0 - * @deprecated 2.8.0 - * @deprecated Use wp_register_widget_control() + * @deprecated 2.8.0 Use wp_register_widget_control() * @see wp_register_widget_control() * * @param int|string $name Sidebar ID. - * @param callback $control_callback Widget control callback to display and process form. + * @param callable $control_callback Widget control callback to display and process form. * @param int $width Widget width. * @param int $height Widget height. */ @@ -2245,11 +2183,10 @@ function register_widget_control($name, $control_callback, $width = '', $height } /** - * Alias of {@link wp_unregister_widget_control()}. + * Alias of wp_unregister_widget_control(). * * @since 2.2.0 - * @deprecated 2.8.0 - * @deprecated Use wp_unregister_widget_control() + * @deprecated 2.8.0 Use wp_unregister_widget_control() * @see wp_unregister_widget_control() * * @param int|string $id Widget ID. @@ -2263,8 +2200,7 @@ function unregister_widget_control($id) { * Remove user meta data. * * @since 2.0.0 - * @deprecated 3.0.0 - * @deprecated Use delete_user_meta() + * @deprecated 3.0.0 Use delete_user_meta() * @see delete_user_meta() * * @param int $user_id User ID. @@ -2311,8 +2247,7 @@ function delete_usermeta( $user_id, $meta_key, $meta_value = '' ) { * than one metadata value, then it will be list of metadata values. * * @since 2.0.0 - * @deprecated 3.0.0 - * @deprecated Use get_user_meta() + * @deprecated 3.0.0 Use get_user_meta() * @see get_user_meta() * * @param int $user_id User ID @@ -2364,8 +2299,7 @@ function get_usermeta( $user_id, $meta_key = '' ) { * Will remove the metadata, if the meta value is empty. * * @since 2.0.0 - * @deprecated 3.0.0 - * @deprecated Use update_user_meta() + * @deprecated 3.0.0 Use update_user_meta() * @see update_user_meta() * * @param int $user_id User ID @@ -2413,19 +2347,20 @@ function update_usermeta( $user_id, $meta_key, $meta_value ) { } /** - * Get users for the blog. + * Get users for the site. * - * For setups that use the multi-blog feature. Can be used outside of the - * multi-blog feature. + * For setups that use the multisite feature. Can be used outside of the + * multisite feature. * * @since 2.2.0 - * @deprecated 3.1.0 + * @deprecated 3.1.0 Use get_users() + * @see get_users() * - * @global wpdb $wpdb WordPress database abstraction object. - * @uses $blog_id The Blog id of the blog for those that use more than one blog + * @global wpdb $wpdb WordPress database abstraction object. + * @global int $blog_id The site ID of the site for those that use more than one site. * - * @param int $id Blog ID. - * @return array List of users that are part of that Blog ID + * @param int $id Site ID. + * @return array List of users that are part of that site ID */ function get_users_of_blog( $id = '' ) { _deprecated_function( __FUNCTION__, '3.1', 'get_users()' ); @@ -2442,10 +2377,10 @@ function get_users_of_blog( $id = '' ) { * Enable/disable automatic general feed link outputting. * * @since 2.8.0 - * @deprecated 3.0.0 - * @deprecated Use add_theme_support( 'automatic-feed-links' ) + * @deprecated 3.0.0 Use add_theme_support() + * @see add_theme_support() * - * @param boolean $add Optional, default is true. Add or remove links. Defaults to true. + * @param bool $add Optional, default is true. Add or remove links. Defaults to true. */ function automatic_feed_links( $add = true ) { _deprecated_function( __FUNCTION__, '3.0', "add_theme_support( 'automatic-feed-links' )" ); @@ -2460,9 +2395,12 @@ function automatic_feed_links( $add = true ) { * Retrieve user data based on field. * * @since 1.5.0 - * @deprecated 3.0.0 - * @deprecated Use get_the_author_meta() + * @deprecated 3.0.0 Use get_the_author_meta() * @see get_the_author_meta() + * + * @param string $field User meta field. + * @param false|int $user Optional. User ID to retrieve the field for. Default false (current user). + * @return string The author's field from the current author's DB object. */ function get_profile( $field, $user = false ) { _deprecated_function( __FUNCTION__, '3.0', 'get_the_author_meta()' ); @@ -2474,12 +2412,14 @@ function get_profile( $field, $user = false ) { } /** - * Number of posts user has written. + * Retrieves the number of posts a user has written. * * @since 0.71 - * @deprecated 3.0.0 - * @deprecated Use count_user_posts() + * @deprecated 3.0.0 Use count_user_posts() * @see count_user_posts() + * + * @param int $userid User to count posts for. + * @return int Number of posts the given user has written. */ function get_usernumposts( $userid ) { _deprecated_function( __FUNCTION__, '3.0', 'count_user_posts()' ); @@ -2506,10 +2446,11 @@ function funky_javascript_callback($matches) { * Converts unicode characters to HTML numbered entities. * * @since 1.5.0 - * @uses $is_macIE - * @uses $is_winIE * @deprecated 3.0.0 * + * @global $is_macIE + * @global $is_winIE + * * @param string $text Text to be made safe. * @return string Fixed text. */ @@ -2530,8 +2471,7 @@ function funky_javascript_fix($text) { * Checks that the taxonomy name exists. * * @since 2.3.0 - * @deprecated 3.0.0 - * @deprecated Use taxonomy_exists() + * @deprecated 3.0.0 Use taxonomy_exists() * @see taxonomy_exists() * * @param string $taxonomy Name of taxonomy object @@ -2546,8 +2486,7 @@ function is_taxonomy( $taxonomy ) { * Check if Term exists. * * @since 2.3.0 - * @deprecated 3.0.0 - * @deprecated Use term_exists() + * @deprecated 3.0.0 Use term_exists() * @see term_exists() * * @param int|string $term The term to check @@ -2563,9 +2502,10 @@ function is_term( $term, $taxonomy = '', $parent = 0 ) { /** * Is the current admin page generated by a plugin? * + * Use global $plugin_page and/or get_plugin_page_hookname() hooks. + * * @since 1.5.0 * @deprecated 3.1.0 - * @deprecated Use global $plugin_page and/or get_plugin_page_hookname() hooks. * * @global $plugin_page * @@ -2615,18 +2555,18 @@ function wp_timezone_supported() { } /** - * Display editor: TinyMCE, HTML, or both. + * Displays an editor: TinyMCE, HTML, or both. * * @since 2.1.0 - * @deprecated 3.3.0 - * @deprecated Use wp_editor() + * @deprecated 3.3.0 Use wp_editor() * @see wp_editor() * - * @param string $content Textarea content. - * @param string $id Optional, default is 'content'. HTML ID attribute value. - * @param string $prev_id Optional, not used - * @param bool $media_buttons Optional, default is true. Whether to display media buttons. - * @param int $tab_index Optional, not used + * @param string $content Textarea content. + * @param string $id Optional. HTML ID attribute value. Default 'content'. + * @param string $prev_id Optional. Unused. + * @param bool $media_buttons Optional. Whether to display media buttons. Default true. + * @param int $tab_index Optional. Unused. + * @param bool $extended Optional. Unused. */ function the_editor($content, $id = 'content', $prev_id = 'title', $media_buttons = true, $tab_index = 2, $extended = true) { _deprecated_function( __FUNCTION__, '3.3', 'wp_editor()' ); @@ -2793,10 +2733,10 @@ function index_rel_link() { * @since 2.8.0 * @deprecated 3.3.0 * - * @param string $title Optional. Link title format. + * @param string $title Optional. Link title format. Default '%title'. * @return string */ -function get_parent_post_rel_link($title = '%title') { +function get_parent_post_rel_link( $title = '%title' ) { _deprecated_function( __FUNCTION__, '3.3' ); if ( ! empty( $GLOBALS['post'] ) && ! empty( $GLOBALS['post']->post_parent ) ) @@ -2823,8 +2763,10 @@ function get_parent_post_rel_link($title = '%title') { * * @since 2.8.0 * @deprecated 3.3.0 + * + * @param string $title Optional. Link title format. Default '%title'. */ -function parent_post_rel_link($title = '%title') { +function parent_post_rel_link( $title = '%title' ) { _deprecated_function( __FUNCTION__, '3.3' ); echo get_parent_post_rel_link($title); @@ -2835,6 +2777,8 @@ function parent_post_rel_link($title = '%title') { * * @since 3.2.0 * @deprecated 3.3.0 + * + * @param WP_Admin_Bar $wp_admin_bar WP_Admin_Bar instance. */ function wp_admin_bar_dashboard_view_site_menu( $wp_admin_bar ) { _deprecated_function( __FUNCTION__, '3.3' ); @@ -2852,14 +2796,13 @@ function wp_admin_bar_dashboard_view_site_menu( $wp_admin_bar ) { } /** - * Checks if the current user belong to a given blog. + * Checks if the current user belong to a given site. * * @since MU - * @deprecated 3.3.0 - * @deprecated Use is_user_member_of_blog() + * @deprecated 3.3.0 Use is_user_member_of_blog() * @see is_user_member_of_blog() * - * @param int $blog_id Blog ID + * @param int $blog_id Site ID * @return bool True if the current users belong to $blog_id, false if not. */ function is_blog_user( $blog_id = 0 ) { @@ -2872,9 +2815,14 @@ function is_blog_user( $blog_id = 0 ) { * Open the file handle for debugging. * * @since 0.71 - * @deprecated Use error_log() + * @deprecated 3.4.0 Use error_log() + * @see error_log() + * * @link http://www.php.net/manual/en/function.error-log.php - * @deprecated 3.4.0 + * + * @param string $filename File name. + * @param string $mode Type of access you required to the stream. + * @return false Always false. */ function debug_fopen( $filename, $mode ) { _deprecated_function( __FUNCTION__, 'error_log()' ); @@ -2885,9 +2833,13 @@ function debug_fopen( $filename, $mode ) { * Write contents to the file used for debugging. * * @since 0.71 - * @deprecated Use error_log() instead. + * @deprecated 3.4.0 Use error_log() + * @see error_log() + * * @link http://www.php.net/manual/en/function.error-log.php - * @deprecated 3.4.0 + * + * @param mixed $fp Unused. + * @param string $string Message to log. */ function debug_fwrite( $fp, $string ) { _deprecated_function( __FUNCTION__, 'error_log()' ); @@ -2899,9 +2851,12 @@ function debug_fwrite( $fp, $string ) { * Close the debugging file handle. * * @since 0.71 - * @deprecated Use error_log() + * @deprecated 3.4.0 Use error_log() + * @see error_log() + * * @link http://www.php.net/manual/en/function.error-log.php - * @deprecated 3.4.0 + * + * @param mixed $fp Unused. */ function debug_fclose( $fp ) { _deprecated_function( __FUNCTION__, 'error_log()' ); @@ -2915,8 +2870,7 @@ function debug_fclose( $fp ) { * broken, if it is missing style.css; index.php is optional. * * @since 1.5.0 - * @deprecated 3.4.0 - * @deprecated Use wp_get_themes() + * @deprecated 3.4.0 Use wp_get_themes() * @see wp_get_themes() * * @return array Theme list with theme data. @@ -2946,8 +2900,7 @@ function get_themes() { * Retrieve theme data. * * @since 1.5.0 - * @deprecated 3.4.0 - * @deprecated Use wp_get_theme() + * @deprecated 3.4.0 Use wp_get_theme() * @see wp_get_theme() * * @param string $theme Theme name. @@ -2966,8 +2919,7 @@ function get_theme( $theme ) { * Retrieve current theme name. * * @since 1.5.0 - * @deprecated 3.4.0 - * @deprecated Use (string) wp_get_theme() + * @deprecated 3.4.0 Use wp_get_theme() * @see wp_get_theme() * * @return string @@ -3013,13 +2965,12 @@ function clean_pre($matches) { * Add callbacks for image header display. * * @since 2.1.0 - * @deprecated 3.4.0 - * @deprecated Use add_theme_support('custom-header', $args) + * @deprecated 3.4.0 Use add_theme_support() * @see add_theme_support() * - * @param callback $wp_head_callback Call on 'wp_head' action. - * @param callback $admin_head_callback Call on custom header administration screen. - * @param callback $admin_preview_callback Output a custom header image div on the custom header administration screen. Optional. + * @param callable $wp_head_callback Call on 'wp_head' action. + * @param callable $admin_head_callback Call on custom header administration screen. + * @param callable $admin_preview_callback Output a custom header image div on the custom header administration screen. Optional. */ function add_custom_image_header( $wp_head_callback, $admin_head_callback, $admin_preview_callback = '' ) { _deprecated_function( __FUNCTION__, '3.4', 'add_theme_support( \'custom-header\', $args )' ); @@ -3036,8 +2987,7 @@ function add_custom_image_header( $wp_head_callback, $admin_head_callback, $admi * Remove image header support. * * @since 3.1.0 - * @deprecated 3.4.0 - * @deprecated Use remove_theme_support('custom-header') + * @deprecated 3.4.0 Use remove_theme_support() * @see remove_theme_support() * * @return null|bool Whether support was removed. @@ -3051,13 +3001,12 @@ function remove_custom_image_header() { * Add callbacks for background image display. * * @since 3.0.0 - * @deprecated 3.4.0 - * @deprecated Use add_theme_support('custom-background, $args) + * @deprecated 3.4.0 Use add_theme_support() * @see add_theme_support() * - * @param callback $wp_head_callback Call on 'wp_head' action. - * @param callback $admin_head_callback Call on custom background administration screen. - * @param callback $admin_preview_callback Output a custom background image div on the custom background administration screen. Optional. + * @param callable $wp_head_callback Call on 'wp_head' action. + * @param callable $admin_head_callback Call on custom background administration screen. + * @param callable $admin_preview_callback Output a custom background image div on the custom background administration screen. Optional. */ function add_custom_background( $wp_head_callback = '', $admin_head_callback = '', $admin_preview_callback = '' ) { _deprecated_function( __FUNCTION__, '3.4', 'add_theme_support( \'custom-background\', $args )' ); @@ -3075,6 +3024,7 @@ function add_custom_background( $wp_head_callback = '', $admin_head_callback = ' * Remove custom background support. * * @since 3.1.0 + * @deprecated 3.4.0 Use add_custom_background() * @see add_custom_background() * * @return null|bool Whether support was removed. @@ -3088,8 +3038,7 @@ function remove_custom_background() { * Retrieve theme data from parsed theme file. * * @since 1.5.0 - * @deprecated 3.4.0 - * @deprecated Use wp_get_theme() + * @deprecated 3.4.0 Use wp_get_theme() * @see wp_get_theme() * * @param string $theme_file Theme file path. @@ -3127,7 +3076,8 @@ function get_theme_data( $theme_file ) { * @see update_post_cache() Posts and pages are the same, alias is intentional * * @since 1.5.1 - * @deprecated 3.4.0 + * @deprecated 3.4.0 Use update_post_cache() + * @see update_post_cache() * * @param array $pages list of page objects */ @@ -3144,7 +3094,8 @@ function update_page_cache( &$pages ) { * associated with 'all_page_ids' and 'get_pages'. * * @since 2.0.0 - * @deprecated 3.4.0 + * @deprecated 3.4.0 Use clean_post_cache + * @see clean_post_cache() * * @param int $id Page ID to clean */ @@ -3160,8 +3111,7 @@ function clean_page_cache( $id ) { * Deprecated in 3.4.1 and 3.5.0. Backported to 3.3.3. * * @since 2.0.4 - * @deprecated 3.4.1 - * @deprecated Use wp_nonce_ays() + * @deprecated 3.4.1 Use wp_nonce_ays() * @see wp_nonce_ays() * * @param string $action Nonce action. @@ -3176,8 +3126,7 @@ function wp_explain_nonce( $action ) { * Display "sticky" CSS class, if a post is sticky. * * @since 2.7.0 - * @deprecated 3.5.0 - * @deprecated Use post_class() + * @deprecated 3.5.0 Use post_class() * @see post_class() * * @param int $post_id An optional post ID. @@ -3195,8 +3144,10 @@ function sticky_class( $post_id = null ) { * property with get_post_ancestors(). * * @since 2.3.4 - * @deprecated 3.5.0 + * @deprecated 3.5.0 Use get_post_ancestors() * @see get_post_ancestors() + * + * @param WP_Post &$post Post object, passed by reference (unused). */ function _get_post_ancestors( &$post ) { _deprecated_function( __FUNCTION__, '3.5' ); @@ -3206,7 +3157,7 @@ function _get_post_ancestors( &$post ) { * Load an image from a string, if PHP supports it. * * @since 2.1.0 - * @deprecated 3.5.0 + * @deprecated 3.5.0 Use wp_get_image_editor() * @see wp_get_image_editor() * * @param string $file Filename of the image to load. @@ -3246,7 +3197,7 @@ function wp_load_image( $file ) { * downgraded, not actual defects), but of your PHP version. * * @since 2.5.0 - * @deprecated 3.5.0 + * @deprecated 3.5.0 Use wp_get_image_editor() * @see wp_get_image_editor() * * @param string $file Image file path. @@ -3286,7 +3237,7 @@ function image_resize( $file, $max_w, $max_h, $crop = false, $suffix = null, $de * property or key. * * @since 1.0.0 - * @deprecated 3.5.0 + * @deprecated 3.5.0 Use get_post() * @see get_post() * * @param int $postid Post ID. @@ -3302,8 +3253,7 @@ function wp_get_single_post( $postid = 0, $mode = OBJECT ) { * Check that the user login name and password is correct. * * @since 0.71 - * @deprecated 3.5.0 - * @deprecated Use wp_authenticate() + * @deprecated 3.5.0 Use wp_authenticate() * @see wp_authenticate() * * @param string $user_login User name. @@ -3331,7 +3281,7 @@ function _save_post_hook() {} * Check if the installed version of GD supports particular image type * * @since 2.9.0 - * @deprecated 3.5.0 + * @deprecated 3.5.0 Use wp_image_editor_supports() * @see wp_image_editor_supports() * * @param string $mime_type @@ -3366,8 +3316,8 @@ function gd_edit_image_support($mime_type) { * Converts an integer byte value to a shorthand byte value. * * @since 2.3.0 - * @deprecated 3.6.0 - * @deprecated Use size_format() + * @deprecated 3.6.0 Use size_format() + * @see size_format() * * @param int $bytes An integer byte value. * @return string A shorthand byte value. @@ -3376,9 +3326,9 @@ function wp_convert_bytes_to_hr( $bytes ) { _deprecated_function( __FUNCTION__, '3.6', 'size_format()' ); $units = array( 0 => 'B', 1 => 'kB', 2 => 'MB', 3 => 'GB', 4 => 'TB' ); - $log = log( $bytes, 1024 ); + $log = log( $bytes, KB_IN_BYTES ); $power = (int) $log; - $size = pow( 1024, $log - $power ); + $size = pow( KB_IN_BYTES, $log - $power ); if ( ! is_nan( $size ) && array_key_exists( $power, $units ) ) { $unit = $units[ $power ]; @@ -3393,9 +3343,12 @@ function wp_convert_bytes_to_hr( $bytes ) { /** * Formerly used internally to tidy up the search terms. * - * @access private * @since 2.9.0 + * @access private * @deprecated 3.7.0 + * + * @param string $t Search terms to "tidy", e.g. trim. + * @return string Trimmed search terms. */ function _search_terms_tidy( $t ) { _deprecated_function( __FUNCTION__, '3.7' ); @@ -3427,8 +3380,11 @@ function rich_edit_exists() { * Old callback for tag link tooltips. * * @since 2.7.0 - * @deprecated 3.9.0 * @access private + * @deprecated 3.9.0 + * + * @param int $count Number of topics. + * @return int Number of topics. */ function default_topic_count_text( $count ) { return $count; @@ -3454,8 +3410,8 @@ function format_to_post( $content ) { * Formerly used to escape strings before searching the DB. It was poorly documented and never worked as described. * * @since 2.5.0 - * @deprecated 4.0.0 - * @deprecated Use wpdb::esc_like() + * @deprecated 4.0.0 Use wpdb::esc_like() + * @see wpdb::esc_like() * * @param string $text The text to be escaped. * @return string text, safe for inclusion in LIKE query. @@ -3491,3 +3447,310 @@ function url_is_accessable_via_ssl( $url ) { return false; } + +/** + * Start preview theme output buffer. + * + * Will only perform task if the user has permissions and template and preview + * query variables exist. + * + * @since 2.6.0 + * @deprecated 4.3.0 + */ +function preview_theme() { + _deprecated_function( __FUNCTION__, '4.3' ); +} + +/** + * Private function to modify the current template when previewing a theme + * + * @since 2.9.0 + * @deprecated 4.3.0 + * @access private + * + * @return string + */ +function _preview_theme_template_filter() { + _deprecated_function( __FUNCTION__, '4.3' ); + return ''; +} + +/** + * Private function to modify the current stylesheet when previewing a theme + * + * @since 2.9.0 + * @deprecated 4.3.0 + * @access private + * + * @return string + */ +function _preview_theme_stylesheet_filter() { + _deprecated_function( __FUNCTION__, '4.3' ); + return ''; +} + +/** + * Callback function for ob_start() to capture all links in the theme. + * + * @since 2.6.0 + * @deprecated 4.3.0 + * @access private + * + * @param string $content + * @return string + */ +function preview_theme_ob_filter( $content ) { + _deprecated_function( __FUNCTION__, '4.3' ); + return $content; +} + +/** + * Manipulates preview theme links in order to control and maintain location. + * + * Callback function for preg_replace_callback() to accept and filter matches. + * + * @since 2.6.0 + * @deprecated 4.3.0 + * @access private + * + * @param array $matches + * @return string + */ +function preview_theme_ob_filter_callback( $matches ) { + _deprecated_function( __FUNCTION__, '4.3' ); + return ''; +} + +/** + * Formats text for the rich text editor. + * + * The filter 'richedit_pre' is applied here. If $text is empty the filter will + * be applied to an empty string. + * + * @since 2.0.0 + * @deprecated 4.3.0 + * + * @param string $text The text to be formatted. + * @return string The formatted text after filter is applied. + */ +function wp_richedit_pre($text) { + _deprecated_function( __FUNCTION__, '4.3', 'format_for_editor()' ); + + if ( empty( $text ) ) { + /** + * Filter text returned for the rich text editor. + * + * This filter is first evaluated, and the value returned, if an empty string + * is passed to wp_richedit_pre(). If an empty string is passed, it results + * in a break tag and line feed. + * + * If a non-empty string is passed, the filter is evaluated on the wp_richedit_pre() + * return after being formatted. + * + * @since 2.0.0 + * @deprecated 4.3.0 + * + * @param string $output Text for the rich text editor. + */ + return apply_filters( 'richedit_pre', '' ); + } + + $output = convert_chars($text); + $output = wpautop($output); + $output = htmlspecialchars($output, ENT_NOQUOTES, get_option( 'blog_charset' ) ); + + /** This filter is documented in wp-includes/deprecated.php */ + return apply_filters( 'richedit_pre', $output ); +} + +/** + * Formats text for the HTML editor. + * + * Unless $output is empty it will pass through htmlspecialchars before the + * 'htmledit_pre' filter is applied. + * + * @since 2.5.0 + * @deprecated 4.3.0 Use format_for_editor() + * @see format_for_editor() + * + * @param string $output The text to be formatted. + * @return string Formatted text after filter applied. + */ +function wp_htmledit_pre($output) { + _deprecated_function( __FUNCTION__, '4.3', 'format_for_editor()' ); + + if ( !empty($output) ) + $output = htmlspecialchars($output, ENT_NOQUOTES, get_option( 'blog_charset' ) ); // convert only < > & + + /** + * Filter the text before it is formatted for the HTML editor. + * + * @since 2.5.0 + * @deprecated 4.3.0 + * + * @param string $output The HTML-formatted text. + */ + return apply_filters( 'htmledit_pre', $output ); +} + +/** + * Retrieve permalink from post ID. + * + * @since 1.0.0 + * @deprecated 4.4.0 Use get_permalink() + * @see get_permalink() + * + * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post. + * @return string|false + */ +function post_permalink( $post_id = 0 ) { + _deprecated_function( __FUNCTION__, '4.4', 'get_permalink()' ); + + return get_permalink( $post_id ); +} + +/** + * Perform a HTTP HEAD or GET request. + * + * If $file_path is a writable filename, this will do a GET request and write + * the file to that path. + * + * @since 2.5.0 + * @deprecated 4.4.0 Use WP_Http + * @see WP_Http + * + * @param string $url URL to fetch. + * @param string|bool $file_path Optional. File path to write request to. Default false. + * @param int $red Optional. The number of Redirects followed, Upon 5 being hit, + * returns false. Default 1. + * @return bool|string False on failure and string of headers if HEAD request. + */ +function wp_get_http( $url, $file_path = false, $red = 1 ) { + _deprecated_function( __FUNCTION__, '4.4', 'WP_Http' ); + + @set_time_limit( 60 ); + + if ( $red > 5 ) + return false; + + $options = array(); + $options['redirection'] = 5; + + if ( false == $file_path ) + $options['method'] = 'HEAD'; + else + $options['method'] = 'GET'; + + $response = wp_safe_remote_request( $url, $options ); + + if ( is_wp_error( $response ) ) + return false; + + $headers = wp_remote_retrieve_headers( $response ); + $headers['response'] = wp_remote_retrieve_response_code( $response ); + + // WP_HTTP no longer follows redirects for HEAD requests. + if ( 'HEAD' == $options['method'] && in_array($headers['response'], array(301, 302)) && isset( $headers['location'] ) ) { + return wp_get_http( $headers['location'], $file_path, ++$red ); + } + + if ( false == $file_path ) + return $headers; + + // GET request - write it to the supplied filename + $out_fp = fopen($file_path, 'w'); + if ( !$out_fp ) + return $headers; + + fwrite( $out_fp, wp_remote_retrieve_body( $response ) ); + fclose($out_fp); + clearstatcache(); + + return $headers; +} + +/** + * Whether SSL login should be forced. + * + * @since 2.6.0 + * @deprecated 4.4.0 Use force_ssl_admin() + * @see force_ssl_admin() + * + * @param string|bool $force Optional Whether to force SSL login. Default null. + * @return bool True if forced, false if not forced. + */ +function force_ssl_login( $force = null ) { + _deprecated_function( __FUNCTION__, '4.4', 'force_ssl_admin()' ); + return force_ssl_admin( $force ); +} + +/** + * Retrieve path of comment popup template in current or parent template. + * + * @since 1.5.0 + * @deprecated 4.5.0 + * + * @return string Full path to comments popup template file. + */ +function get_comments_popup_template() { + _deprecated_function( __FUNCTION__, '4.5' ); + + return ''; +} + +/** + * Whether the current URL is within the comments popup window. + * + * @since 1.5.0 + * @deprecated 4.5.0 + * + * @return bool + */ +function is_comments_popup() { + _deprecated_function( __FUNCTION__, '4.5' ); + + return false; +} + +/** + * Display the JS popup script to show a comment. + * + * @since 0.71 + * @deprecated 4.5.0 + */ +function comments_popup_script() { + _deprecated_function( __FUNCTION__, '4.5' ); +} + +/** + * Adds element attributes to open links in new windows. + * + * @since 0.71 + * @deprecated 4.5.0 + * + * @param string $text Content to replace links to open in a new window. + * @return string Content that has filtered links. + */ +function popuplinks( $text ) { + _deprecated_function( __FUNCTION__, '4.5' ); + $text = preg_replace('//i', "", $text); + return $text; +} + +/** + * Returns the base URL of the uploads directory. + * Note: this function will be removed in 4.6. + * + * @ignore + * @since 4.4.0 + * @access private + * @deprecated 4.5.0 Use wp_get_upload_dir() + * @see wp_get_upload_dir() + * + * @return string The base URL. + */ +function _wp_upload_dir_baseurl() { + _deprecated_function( __FUNCTION__, '4.5', 'wp_get_upload_dir()' ); + $upload_dir = wp_get_upload_dir(); + return $upload_dir['baseurl']; +}