X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/61343b82c4f0da4c68e4c6373daafff4a81efdd1..53f4633144ed68c8b8fb5861f992b5489894a940:/wp-includes/deprecated.php diff --git a/wp-includes/deprecated.php b/wp-includes/deprecated.php index d86709a7..ac391055 100644 --- a/wp-includes/deprecated.php +++ b/wp-includes/deprecated.php @@ -53,8 +53,8 @@ function get_postdata($postid) { * Sets up the WordPress Loop. * * @since 1.0.1 - * @deprecated 1.5 - * @deprecated Use The Loop - {@link http://codex.wordpress.org/The_Loop Use new WordPress Loop} + * @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; @@ -121,8 +121,8 @@ function the_category_head($before='', $after='') { /** * Prints link to the previous post. * - * @since 1.5 - * @deprecated 2.0 + * @since 1.5.0 + * @deprecated 2.0.0 * @deprecated Use previous_post_link() * @see previous_post_link() * @@ -159,7 +159,7 @@ function previous_post($format='%', $previous='previous post: ', $title='yes', $ * Prints link to the next post. * * @since 0.71 - * @deprecated 2.0 + * @deprecated 2.0.0 * @deprecated Use next_post_link() * @see next_post_link() * @@ -194,8 +194,8 @@ function next_post($format='%', $next='next post: ', $title='yes', $in_same_cat= /** * Whether user can create a post. * - * @since 1.5 - * @deprecated 2.0 + * @since 1.5.0 + * @deprecated 2.0.0 * @deprecated Use current_user_can() * @see current_user_can() * @@ -214,8 +214,8 @@ function user_can_create_post($user_id, $blog_id = 1, $category_id = 'None') { /** * Whether user can create a post. * - * @since 1.5 - * @deprecated 2.0 + * @since 1.5.0 + * @deprecated 2.0.0 * @deprecated Use current_user_can() * @see current_user_can() * @@ -234,8 +234,8 @@ function user_can_create_draft($user_id, $blog_id = 1, $category_id = 'None') { /** * Whether user can edit a post. * - * @since 1.5 - * @deprecated 2.0 + * @since 1.5.0 + * @deprecated 2.0.0 * @deprecated Use current_user_can() * @see current_user_can() * @@ -263,8 +263,8 @@ function user_can_edit_post($user_id, $post_id, $blog_id = 1) { /** * Whether user can delete a post. * - * @since 1.5 - * @deprecated 2.0 + * @since 1.5.0 + * @deprecated 2.0.0 * @deprecated Use current_user_can() * @see current_user_can() * @@ -283,8 +283,8 @@ function user_can_delete_post($user_id, $post_id, $blog_id = 1) { /** * Whether user can set new posts' dates. * - * @since 1.5 - * @deprecated 2.0 + * @since 1.5.0 + * @deprecated 2.0.0 * @deprecated Use current_user_can() * @see current_user_can() * @@ -303,8 +303,8 @@ function user_can_set_post_date($user_id, $blog_id = 1, $category_id = 'None') { /** * Whether user can delete a post. * - * @since 1.5 - * @deprecated 2.0 + * @since 1.5.0 + * @deprecated 2.0.0 * @deprecated Use current_user_can() * @see current_user_can() * @@ -323,8 +323,8 @@ function user_can_edit_post_date($user_id, $post_id, $blog_id = 1) { /** * Whether user can delete a post. * - * @since 1.5 - * @deprecated 2.0 + * @since 1.5.0 + * @deprecated 2.0.0 * @deprecated Use current_user_can() * @see current_user_can() * @@ -343,8 +343,8 @@ function user_can_edit_post_comments($user_id, $post_id, $blog_id = 1) { /** * Whether user can delete a post. * - * @since 1.5 - * @deprecated 2.0 + * @since 1.5.0 + * @deprecated 2.0.0 * @deprecated Use current_user_can() * @see current_user_can() * @@ -363,8 +363,8 @@ function user_can_delete_post_comments($user_id, $post_id, $blog_id = 1) { /** * Can user can edit other user. * - * @since 1.5 - * @deprecated 2.0 + * @since 1.5.0 + * @deprecated 2.0.0 * @deprecated Use current_user_can() * @see current_user_can() * @@ -387,7 +387,7 @@ function user_can_edit_user($user_id, $other_user) { * Gets the links associated with category $cat_name. * * @since 0.71 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated Use get_bookmarks() * @see get_bookmarks() * @@ -421,13 +421,13 @@ function get_linksbyname($cat_name = "noname", $before = '', $after = '
', * Gets the links associated with the named category. * * @since 1.0.1 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated Use wp_list_bookmarks() * @see wp_list_bookmarks() * * @param string $category The category to use. * @param string $args - * @return bool|null + * @return string|null */ function wp_get_linksbyname($category, $args = '') { _deprecated_function(__FUNCTION__, '2.1', 'wp_list_bookmarks()'); @@ -451,15 +451,13 @@ function wp_get_linksbyname($category, $args = '') { /** * Gets an array of link objects associated with category $cat_name. * - * - * $links = get_linkobjectsbyname('fred'); - * foreach ($links as $link) { - * echo '
  • '.$link->link_name.'
    • '; - * } - *     + * $links = get_linkobjectsbyname( 'fred' ); + * foreach ( $links as $link ) { + * echo '
  • ' . $link->link_name . '
    • '; + * } * * @since 1.0.1 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated Use get_bookmarks() * @see get_bookmarks() * @@ -468,7 +466,7 @@ function wp_get_linksbyname($category, $args = '') { * Or maybe owner. If you start the name with an underscore the order will be reversed. You can also * specify 'rand' as the order which will return links in a random order. * @param int $limit Limit to X entries. If not specified, all entries are shown. - * @return unknown + * @return array */ function get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit = -1) { _deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' ); @@ -485,34 +483,32 @@ function get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit * Gets an array of link objects associated with category n. * * Usage: - * - * $links = get_linkobjects(1); - * if ($links) { - * foreach ($links as $link) { - * echo '
  • '.$link->link_name.'
    '.$link->link_description.'
    • '; - * } - * } - *     + * + * $links = get_linkobjects(1); + * if ($links) { + * foreach ($links as $link) { + * echo '
  • '.$link->link_name.'
    '.$link->link_description.'
    • '; + * } + * } * * Fields are: - *
      - *
    1. link_id
      2. - *
    2. link_url
      3. - *
    3. link_name
      4. - *
    4. link_image
      5. - *
    5. link_target
      6. - *
    6. link_category
      7. - *
    7. link_description
      8. - *
    8. link_visible
      9. - *
    9. link_owner
      10. - *
    10. link_rating
      11. - *
    11. link_updated
      12. - *
    12. link_rel
      13. - *
    13. link_notes
      14. - *
    + * + * - link_id + * - link_url + * - link_name + * - link_image + * - link_target + * - link_category + * - link_description + * - link_visible + * - link_owner + * - link_rating + * - link_updated + * - link_rel + * - link_notes * * @since 1.0.1 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated Use get_bookmarks() * @see get_bookmarks() * @@ -522,7 +518,7 @@ function get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit * underscore the order will be reversed. You can also specify 'rand' as the * order which will return links in a random order. * @param int $limit Limit to X entries. If not specified, all entries are shown. - * @return unknown + * @return array */ function get_linkobjects($category = 0, $orderby = 'name', $limit = 0) { _deprecated_function( __FUNCTION__, '2.1', 'get_bookmarks()' ); @@ -540,7 +536,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 + * @deprecated 2.1.0 * @deprecated Use get_bookmarks() * @see get_bookmarks() * @@ -568,7 +564,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 + * @deprecated 2.1.0 * @deprecated Use get_bookmarks() * @see get_bookmarks() * @@ -582,7 +578,7 @@ function get_linksbyname_withrating($cat_name = "noname", $before = '', $after = * underscore the order will be reversed. You can also specify 'rand' as the * order which will return links in a random order. * @param bool $show_description Whether to show the description if show_images=false/not defined. - * @param string $limit Limit to X entries. If not specified, all entries are shown. + * @param int $limit Limit to X entries. If not specified, all entries are shown. * @param int $show_updated Whether to show last updated timestamp */ function get_links_withrating($category = -1, $before = '', $after = '
    ', $between = " ", $show_images = true, @@ -596,7 +592,7 @@ function get_links_withrating($category = -1, $before = '', $after = '
    ', $ * Gets the auto_toggle setting. * * @since 0.71 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated No alternative function available * * @param int $id The category to get. If no category supplied uses 0 @@ -609,7 +605,7 @@ function get_autotoggle($id = 0) { /** * @since 0.71 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated Use wp_list_categories() * @see wp_list_categories() * @@ -631,7 +627,7 @@ function get_autotoggle($id = 0) { * @param string $feed_image * @param string $exclude * @param bool $hierarchical - * @return unknown + * @return false|null */ function list_cats($optionall = 1, $all = 'All', $sort_column = 'ID', $sort_order = 'asc', $file = '', $list = true, $optiondates = 0, $optioncount = 0, $hide_empty = 1, $use_desc_for_title = 1, $children=false, $child_of=0, $categories=0, @@ -644,13 +640,13 @@ function list_cats($optionall = 1, $all = 'All', $sort_column = 'ID', $sort_orde } /** - * @since 1.2 - * @deprecated 2.1 + * @since 1.2.0 + * @deprecated 2.1.0 * @deprecated Use wp_list_categories() * @see wp_list_categories() * * @param string|array $args - * @return unknown + * @return false|null|string */ function wp_list_cats($args = '') { _deprecated_function( __FUNCTION__, '2.1', 'wp_list_categories()' ); @@ -677,7 +673,7 @@ function wp_list_cats($args = '') { /** * @since 0.71 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated Use wp_dropdown_categories() * @see wp_dropdown_categories() * @@ -691,7 +687,7 @@ function wp_list_cats($args = '') { * @param bool $optionnone * @param int $selected * @param int $exclude - * @return unknown + * @return string */ function dropdown_cats($optionall = 1, $all = 'All', $orderby = 'ID', $order = 'asc', $show_last_update = 0, $show_count = 0, $hide_empty = 1, $optionnone = false, @@ -713,8 +709,10 @@ function dropdown_cats($optionall = 1, $all = 'All', $orderby = 'ID', $order = ' } /** - * @since 1.2 - * @deprecated 2.1 + * List authors. + * + * @since 1.2.0 + * @deprecated 2.1.0 * @deprecated Use wp_list_authors() * @see wp_list_authors() * @@ -724,7 +722,7 @@ function dropdown_cats($optionall = 1, $all = 'All', $orderby = 'ID', $order = ' * @param bool $hide_empty * @param string $feed * @param string $feed_image - * @return unknown + * @return null|string */ function list_authors($optioncount = false, $exclude_admin = true, $show_fullname = false, $hide_empty = true, $feed = '', $feed_image = '') { _deprecated_function( __FUNCTION__, '2.1', 'wp_list_authors()' ); @@ -735,13 +733,13 @@ function list_authors($optioncount = false, $exclude_admin = true, $show_fullnam /** * @since 1.0.1 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated Use wp_get_post_categories() * @see wp_get_post_categories() * * @param int $blogid Not Used * @param int $post_ID - * @return unknown + * @return array */ function wp_get_post_cats($blogid = '1', $post_ID = 0) { _deprecated_function( __FUNCTION__, '2.1', 'wp_get_post_categories()' ); @@ -752,14 +750,14 @@ function wp_get_post_cats($blogid = '1', $post_ID = 0) { * Sets the categories that the post id belongs to. * * @since 1.0.1 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated Use wp_set_post_categories() * @see wp_set_post_categories() * * @param int $blogid Not used * @param int $post_ID * @param array $post_categories - * @return unknown + * @return bool|mixed */ function wp_set_post_cats($blogid = '1', $post_ID = 0, $post_categories = array()) { _deprecated_function( __FUNCTION__, '2.1', 'wp_set_post_categories()' ); @@ -768,7 +766,7 @@ function wp_set_post_cats($blogid = '1', $post_ID = 0, $post_categories = array( /** * @since 0.71 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated Use wp_get_archives() * @see wp_get_archives() * @@ -778,7 +776,7 @@ function wp_set_post_cats($blogid = '1', $post_ID = 0, $post_categories = array( * @param string $before * @param string $after * @param bool $show_post_count - * @return unknown + * @return string|null */ function get_archives($type='', $limit='', $format='html', $before = '', $after = '', $show_post_count = false) { _deprecated_function( __FUNCTION__, '2.1', 'wp_get_archives()' ); @@ -789,8 +787,8 @@ function get_archives($type='', $limit='', $format='html', $before = '', $after /** * Returns or Prints link to the author's posts. * - * @since 1.2 - * @deprecated 2.1 + * @since 1.2.0 + * @deprecated 2.1.0 * @deprecated Use get_author_posts_url() * @see get_author_posts_url() * @@ -813,7 +811,7 @@ function get_author_link($echo, $author_id, $author_nicename = '') { * Print list of pages based on arguments. * * @since 0.71 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated Use wp_link_pages() * @see wp_link_pages() * @@ -838,7 +836,7 @@ function link_pages($before='
    ', $after='
    ', $next_or_number='number', * Get value based on option. * * @since 0.71 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated Use get_option() * @see get_option() * @@ -855,7 +853,7 @@ function get_settings($option) { * Print the permalink of the current post in the loop. * * @since 0.71 - * @deprecated 1.2 + * @deprecated 1.2.0 * @deprecated Use the_permalink() * @see the_permalink() */ @@ -868,7 +866,7 @@ function permalink_link() { * Print the permalink to the RSS feed. * * @since 0.71 - * @deprecated 2.3 + * @deprecated 2.3.0 * @deprecated Use the_permalink_rss() * @see the_permalink_rss() * @@ -884,7 +882,7 @@ function permalink_single_rss($deprecated = '') { * * @see get_links() for argument information that can be used in $args * @since 1.0.1 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated Use wp_list_bookmarks() * @see wp_list_bookmarks() * @@ -924,7 +922,7 @@ function wp_get_links($args = '') { * Gets the links associated with category by id. * * @since 0.71 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated Use get_bookmarks() * @see get_bookmarks() * @@ -1033,7 +1031,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 + * @deprecated 2.1.0 * @deprecated Use wp_list_bookmarks() * @see wp_list_bookmarks() * @@ -1076,7 +1074,7 @@ function get_links_list($order = 'name') { * Show the link to the links popup and the number of links. * * @since 0.71 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated {@internal Use function instead is unknown}} * * @param string $text the text of the link @@ -1091,12 +1089,12 @@ function links_popup_script($text = 'Links', $width=400, $height=400, $file='lin /** * @since 1.0.1 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated Use sanitize_bookmark_field() * @see sanitize_bookmark_field() * * @param object $link - * @return unknown + * @return mixed */ function get_linkrating($link) { _deprecated_function( __FUNCTION__, '2.1', 'sanitize_bookmark_field()' ); @@ -1107,7 +1105,7 @@ function get_linkrating($link) { * Gets the name of category by id. * * @since 0.71 - * @deprecated 2.1 + * @deprecated 2.1.0 * @deprecated Use get_category() * @see get_category() * @@ -1137,7 +1135,7 @@ function get_linkcatname($id = 0) { * Print RSS comment feed link. * * @since 1.0.1 - * @deprecated 2.5 + * @deprecated 2.5.0 * @deprecated Use post_comments_feed_link() * @see post_comments_feed_link() * @@ -1151,14 +1149,14 @@ function comments_rss_link($link_text = 'Comments RSS') { /** * Print/Return link to category RSS2 feed. * - * @since 1.2 - * @deprecated 2.5 + * @since 1.2.0 + * @deprecated 2.5.0 * @deprecated Use get_category_feed_link() * @see get_category_feed_link() * * @param bool $echo * @param int $cat_ID - * @return string|null + * @return string */ function get_category_rss_link($echo = false, $cat_ID = 1) { _deprecated_function( __FUNCTION__, '2.5', 'get_category_feed_link()' ); @@ -1173,14 +1171,14 @@ function get_category_rss_link($echo = false, $cat_ID = 1) { /** * Print/Return link to author RSS feed. * - * @since 1.2 - * @deprecated 2.5 + * @since 1.2.0 + * @deprecated 2.5.0 * @deprecated Use get_author_feed_link() * @see get_author_feed_link() * * @param bool $echo * @param int $author_id - * @return string|null + * @return string */ function get_author_rss_link($echo = false, $author_id = 1) { _deprecated_function( __FUNCTION__, '2.5', 'get_author_feed_link()' ); @@ -1194,8 +1192,8 @@ function get_author_rss_link($echo = false, $author_id = 1) { /** * Return link to the post RSS feed. * - * @since 1.5 - * @deprecated 2.2 + * @since 1.5.0 + * @deprecated 2.2.0 * @deprecated Use get_post_comments_feed_link() * @see get_post_comments_feed_link() * @@ -1209,14 +1207,14 @@ function comments_rss() { /** * An alias of wp_create_user(). * - * @since 2.0 - * @deprecated 2.0 + * @since 2.0.0 + * @deprecated 2.0.0 * @deprecated Use wp_create_user() * @see wp_create_user() * * @param string $username The user's username. * @param string $password The user's password. - * @param string $email The user's email (optional). + * @param string $email The user's email. * @return int The new user's ID. */ function create_user($username, $password, $email) { @@ -1227,7 +1225,7 @@ function create_user($username, $password, $email) { /** * Unused function. * - * @deprecated 2.5 + * @deprecated 2.5.0 */ function gzip_compression() { _deprecated_function( __FUNCTION__, '2.5' ); @@ -1238,7 +1236,7 @@ function gzip_compression() { * Retrieve an array of comment data about comment $comment_ID. * * @since 0.71 - * @deprecated 2.7 + * @deprecated 2.7.0 * @deprecated Use get_comment() * @see get_comment() * @@ -1256,7 +1254,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 + * @deprecated 2.8.0 * @deprecated Use get_cat_name() * @see get_cat_name() * @@ -1272,7 +1270,7 @@ function get_catname( $cat_ID ) { * Retrieve category children list separated before and after the term IDs. * * @since 1.2.0 - * @deprecated 2.8 + * @deprecated 2.8.0 * @deprecated Use get_term_children() * @see get_term_children() * @@ -1306,11 +1304,32 @@ function get_category_children( $id, $before = '/', $after = '', $visited = arra return $chain; } +/** + * Retrieves all category IDs. + * + * @since 2.0.0 + * @deprecated 4.0.0 Use get_terms() instead. + * @see get_terms() + * @link https://codex.wordpress.org/Function_Reference/get_all_category_ids + * + * @return object List of all of the category IDs. + */ +function get_all_category_ids() { + _deprecated_function( __FUNCTION__, '4.0', 'get_terms()' ); + + if ( ! $cat_ids = wp_cache_get( 'all_category_ids', 'category' ) ) { + $cat_ids = get_terms( 'category', array('fields' => 'ids', 'get' => 'all') ); + wp_cache_add( 'all_category_ids', $cat_ids, 'category' ); + } + + return $cat_ids; +} + /** * Retrieve the description of the author of the current post. * - * @since 1.5 - * @deprecated 2.8 + * @since 1.5.0 + * @deprecated 2.8.0 * @deprecated Use get_the_author_meta('description') * @see get_the_author_meta() * @@ -1325,7 +1344,7 @@ function get_the_author_description() { * Display the description of the author of the current post. * * @since 1.0.0 - * @deprecated 2.8 + * @deprecated 2.8.0 * @deprecated Use the_author_meta('description') * @see the_author_meta() */ @@ -1337,8 +1356,8 @@ function the_author_description() { /** * Retrieve the login name of the author of the current post. * - * @since 1.5 - * @deprecated 2.8 + * @since 1.5.0 + * @deprecated 2.8.0 * @deprecated Use get_the_author_meta('login') * @see get_the_author_meta() * @@ -1353,7 +1372,7 @@ function get_the_author_login() { * Display the login name of the author of the current post. * * @since 0.71 - * @deprecated 2.8 + * @deprecated 2.8.0 * @deprecated Use the_author_meta('login') * @see the_author_meta() */ @@ -1365,8 +1384,8 @@ function the_author_login() { /** * Retrieve the first name of the author of the current post. * - * @since 1.5 - * @deprecated 2.8 + * @since 1.5.0 + * @deprecated 2.8.0 * @deprecated Use get_the_author_meta('first_name') * @see get_the_author_meta() * @@ -1381,7 +1400,7 @@ function get_the_author_firstname() { * Display the first name of the author of the current post. * * @since 0.71 - * @deprecated 2.8 + * @deprecated 2.8.0 * @deprecated Use the_author_meta('first_name') * @see the_author_meta() */ @@ -1393,8 +1412,8 @@ function the_author_firstname() { /** * Retrieve the last name of the author of the current post. * - * @since 1.5 - * @deprecated 2.8 + * @since 1.5.0 + * @deprecated 2.8.0 * @deprecated Use get_the_author_meta('last_name') * @see get_the_author_meta() * @@ -1409,7 +1428,7 @@ function get_the_author_lastname() { * Display the last name of the author of the current post. * * @since 0.71 - * @deprecated 2.8 + * @deprecated 2.8.0 * @deprecated Use the_author_meta('last_name') * @see the_author_meta() */ @@ -1421,8 +1440,8 @@ function the_author_lastname() { /** * Retrieve the nickname of the author of the current post. * - * @since 1.5 - * @deprecated 2.8 + * @since 1.5.0 + * @deprecated 2.8.0 * @deprecated Use get_the_author_meta('nickname') * @see get_the_author_meta() * @@ -1437,7 +1456,7 @@ function get_the_author_nickname() { * Display the nickname of the author of the current post. * * @since 0.71 - * @deprecated 2.8 + * @deprecated 2.8.0 * @deprecated Use the_author_meta('nickname') * @see the_author_meta() */ @@ -1449,8 +1468,8 @@ function the_author_nickname() { /** * Retrieve the email of the author of the current post. * - * @since 1.5 - * @deprecated 2.8 + * @since 1.5.0 + * @deprecated 2.8.0 * @deprecated Use get_the_author_meta('email') * @see get_the_author_meta() * @@ -1465,7 +1484,7 @@ function get_the_author_email() { * Display the email of the author of the current post. * * @since 0.71 - * @deprecated 2.8 + * @deprecated 2.8.0 * @deprecated Use the_author_meta('email') * @see the_author_meta() */ @@ -1477,8 +1496,8 @@ function the_author_email() { /** * Retrieve the ICQ number of the author of the current post. * - * @since 1.5 - * @deprecated 2.8 + * @since 1.5.0 + * @deprecated 2.8.0 * @deprecated Use get_the_author_meta('icq') * @see get_the_author_meta() * @@ -1493,7 +1512,7 @@ function get_the_author_icq() { * Display the ICQ number of the author of the current post. * * @since 0.71 - * @deprecated 2.8 + * @deprecated 2.8.0 * @deprecated Use the_author_meta('icq') * @see the_author_meta() */ @@ -1505,8 +1524,8 @@ function the_author_icq() { /** * Retrieve the Yahoo! IM name of the author of the current post. * - * @since 1.5 - * @deprecated 2.8 + * @since 1.5.0 + * @deprecated 2.8.0 * @deprecated Use get_the_author_meta('yim') * @see get_the_author_meta() * @@ -1521,7 +1540,7 @@ function get_the_author_yim() { * Display the Yahoo! IM name of the author of the current post. * * @since 0.71 - * @deprecated 2.8 + * @deprecated 2.8.0 * @deprecated Use the_author_meta('yim') * @see the_author_meta() */ @@ -1533,8 +1552,8 @@ function the_author_yim() { /** * Retrieve the MSN address of the author of the current post. * - * @since 1.5 - * @deprecated 2.8 + * @since 1.5.0 + * @deprecated 2.8.0 * @deprecated Use get_the_author_meta('msn') * @see get_the_author_meta() * @@ -1549,7 +1568,7 @@ function get_the_author_msn() { * Display the MSN address of the author of the current post. * * @since 0.71 - * @deprecated 2.8 + * @deprecated 2.8.0 * @deprecated Use the_author_meta('msn') * @see the_author_meta() */ @@ -1561,8 +1580,8 @@ function the_author_msn() { /** * Retrieve the AIM address of the author of the current post. * - * @since 1.5 - * @deprecated 2.8 + * @since 1.5.0 + * @deprecated 2.8.0 * @deprecated Use get_the_author_meta('aim') * @see get_the_author_meta() * @@ -1578,7 +1597,7 @@ function get_the_author_aim() { * * @since 0.71 * @see the_author_meta() - * @deprecated 2.8 + * @deprecated 2.8.0 * @deprecated Use the_author_meta('aim') */ function the_author_aim() { @@ -1590,7 +1609,7 @@ function the_author_aim() { * Retrieve the specified author's preferred display name. * * @since 1.0.0 - * @deprecated 2.8 + * @deprecated 2.8.0 * @deprecated Use get_the_author_meta('display_name') * @see get_the_author_meta() * @@ -1605,8 +1624,8 @@ function get_author_name( $auth_id = false ) { /** * Retrieve the URL to the home page of the author of the current post. * - * @since 1.5 - * @deprecated 2.8 + * @since 1.5.0 + * @deprecated 2.8.0 * @deprecated Use get_the_author_meta('url') * @see get_the_author_meta() * @@ -1621,7 +1640,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 + * @deprecated 2.8.0 * @deprecated Use the_author_meta('url') * @see the_author_meta() */ @@ -1633,12 +1652,12 @@ function the_author_url() { /** * Retrieve the ID of the author of the current post. * - * @since 1.5 - * @deprecated 2.8 + * @since 1.5.0 + * @deprecated 2.8.0 * @deprecated Use get_the_author_meta('ID') * @see get_the_author_meta() * - * @return int The author's ID. + * @return string|int The author's ID. */ function get_the_author_ID() { _deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'ID\')' ); @@ -1649,7 +1668,7 @@ function get_the_author_ID() { * Display the ID of the author of the current post. * * @since 0.71 - * @deprecated 2.8 + * @deprecated 2.8.0 * @deprecated Use the_author_meta('ID') * @see the_author_meta() */ @@ -1675,17 +1694,14 @@ function the_author_ID() { * dots added to the end. If there is content left over, then dots will be added * and the rest of the content will be removed. * - * @package WordPress - * @subpackage Feed * @since 0.71 - * @uses apply_filters() Calls 'the_content_rss' on the content before processing. * * @deprecated 2.9.0 * @deprecated 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. - * @param int|bool $stripteaser Optional. Default is 0. + * @param int $stripteaser Optional. Default is 0. * @param string $more_file Optional. * @param int $cut Optional. Amount of words to keep for the content. * @param int $encode_html Optional. How to encode the content. @@ -1740,7 +1756,7 @@ function make_url_footnote( $content ) { _deprecated_function( __FUNCTION__, '2.9', '' ); preg_match_all( '/(.+?)<\/a>/', $content, $matches ); $links_summary = "\n"; - for ( $i=0; $iID ) ) { // We have an image without a thumbnail $src = wp_get_attachment_url( $post->ID ); $src_file = & $file; - $class = 'attachmentimage'; } elseif ( $src = wp_mime_type_icon( $post->ID ) ) { // No thumb, no image. We'll look for a mime-related icon instead. @@ -1947,7 +1960,7 @@ function get_attachment_icon_src( $id = 0, $fullsize = false ) { * @param int $id Optional. Post ID. * @param bool $fullsize Optional, default to false. Whether to have full size image. * @param array $max_dims Optional. Dimensions of image. - * @return string HTML content. + * @return false|string HTML content. */ function get_attachment_icon( $id = 0, $fullsize = false, $max_dims = false ) { _deprecated_function( __FUNCTION__, '2.5', 'wp_get_attachment_image()' ); @@ -2004,7 +2017,7 @@ function get_attachment_icon( $id = 0, $fullsize = false, $max_dims = false ) { * @param int $id Optional. Post ID. * @param bool $fullsize Optional, default to false. Whether to have full size image. * @param array $max_dims Optional. Dimensions of image. - * @return string + * @return false|string */ function get_attachment_innerHTML($id = 0, $fullsize = false, $max_dims = false) { _deprecated_function( __FUNCTION__, '2.5', 'wp_get_attachment_image()' ); @@ -2148,7 +2161,7 @@ function attribute_escape( $text ) { * @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 mixed $params ,... Widget parameters. */ function register_sidebar_widget($name, $output_callback, $classname = '') { _deprecated_function( __FUNCTION__, '2.8', 'wp_register_sidebar_widget()' ); @@ -2383,7 +2396,7 @@ function update_usermeta( $user_id, $meta_key, $meta_value ) { if ( !$cur ) $wpdb->insert($wpdb->usermeta, compact('user_id', 'meta_key', 'meta_value') ); - else if ( $cur->meta_value != $meta_value ) + elseif ( $cur->meta_value != $meta_value ) $wpdb->update($wpdb->usermeta, compact('meta_value'), compact('user_id', 'meta_key') ); else return false; @@ -2407,7 +2420,8 @@ function update_usermeta( $user_id, $meta_key, $meta_value ) { * * @since 2.2.0 * @deprecated 3.1.0 - * @uses $wpdb WordPress database object for queries + * + * @global wpdb $wpdb WordPress database abstraction object. * @uses $blog_id The Blog id of the blog for those that use more than one blog * * @param int $id Blog ID. @@ -2431,7 +2445,7 @@ function get_users_of_blog( $id = '' ) { * @deprecated 3.0.0 * @deprecated Use add_theme_support( 'automatic-feed-links' ) * - * @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' )" ); @@ -2487,7 +2501,7 @@ function funky_javascript_callback($matches) { } /** - * Fixes javascript bugs in browsers. + * Fixes JavaScript bugs in browsers. * * Converts unicode characters to HTML numbered entities. * @@ -2501,7 +2515,7 @@ function funky_javascript_callback($matches) { */ function funky_javascript_fix($text) { _deprecated_function( __FUNCTION__, '3.0' ); - // Fixes for browsers' javascript bugs + // Fixes for browsers' JavaScript bugs. global $is_macIE, $is_winIE; if ( $is_winIE || $is_macIE ) @@ -2618,7 +2632,6 @@ function the_editor($content, $id = 'content', $prev_id = 'title', $media_button _deprecated_function( __FUNCTION__, '3.3', 'wp_editor()' ); wp_editor( $content, $id, array( 'media_buttons' => $media_buttons ) ); - return; } /** @@ -2670,7 +2683,7 @@ function sanitize_user_object($user, $context = 'display') { if ( is_object($user) ) { if ( !isset($user->ID) ) $user->ID = 0; - if ( !is_a( $user, 'WP_User' ) ) { + if ( ! ( $user instanceof WP_User ) ) { $vars = get_object_vars($user); foreach ( array_keys($vars) as $field ) { if ( is_string($user->$field) || is_numeric($user->$field) ) @@ -2971,7 +2984,7 @@ function get_current_theme() { /** * Accepts matches array from preg_replace_callback in wpautop() or a string. * - * Ensures that the contents of a <
    >...<
    > HTML block are not + * Ensures that the contents of a `
    ...
    ` HTML block are not * converted into paragraphs or line-breaks. * * @since 1.2.0 @@ -3027,7 +3040,7 @@ function add_custom_image_header( $wp_head_callback, $admin_head_callback, $admi * @deprecated Use remove_theme_support('custom-header') * @see remove_theme_support() * - * @return bool Whether support was removed. + * @return null|bool Whether support was removed. */ function remove_custom_image_header() { _deprecated_function( __FUNCTION__, '3.4', 'remove_theme_support( \'custom-header\' )' ); @@ -3064,7 +3077,7 @@ function add_custom_background( $wp_head_callback = '', $admin_head_callback = ' * @since 3.1.0 * @see add_custom_background() * - * @return bool Whether support was removed. + * @return null|bool Whether support was removed. */ function remove_custom_background() { _deprecated_function( __FUNCTION__, '3.4', 'remove_theme_support( \'custom-background\' )' ); @@ -3133,8 +3146,6 @@ function update_page_cache( &$pages ) { * @since 2.0.0 * @deprecated 3.4.0 * - * @uses do_action() Will call the 'clean_page_cache' hook action. - * * @param int $id Page ID to clean */ function clean_page_cache( $id ) { @@ -3280,7 +3291,7 @@ function image_resize( $file, $max_w, $max_h, $crop = false, $suffix = null, $de * * @param int $postid Post ID. * @param string $mode How to return result, either OBJECT, ARRAY_N, or ARRAY_A. - * @return object|array Post object or array holding post contents and information + * @return WP_Post|null Post object or array holding post contents and information */ function wp_get_single_post( $postid = 0, $mode = OBJECT ) { _deprecated_function( __FUNCTION__, '3.5', 'get_post()' ); @@ -3378,3 +3389,250 @@ function wp_convert_bytes_to_hr( $bytes ) { return $size . $unit; } + +/** + * Formerly used internally to tidy up the search terms. + * + * @access private + * @since 2.9.0 + * @deprecated 3.7.0 + */ +function _search_terms_tidy( $t ) { + _deprecated_function( __FUNCTION__, '3.7' ); + return trim( $t, "\"'\n\r " ); +} + +/** + * Determine if TinyMCE is available. + * + * Checks to see if the user has deleted the tinymce files to slim down + * their WordPress install. + * + * @since 2.1.0 + * @deprecated 3.9.0 + * + * @return bool Whether TinyMCE exists. + */ +function rich_edit_exists() { + global $wp_rich_edit_exists; + _deprecated_function( __FUNCTION__, '3.9' ); + + if ( ! isset( $wp_rich_edit_exists ) ) + $wp_rich_edit_exists = file_exists( ABSPATH . WPINC . '/js/tinymce/tinymce.js' ); + + return $wp_rich_edit_exists; +} + +/** + * Old callback for tag link tooltips. + * + * @since 2.7.0 + * @deprecated 3.9.0 + * @access private + */ +function default_topic_count_text( $count ) { + return $count; +} + +/** + * Formerly used to escape strings before inserting into the DB. + * + * Has not performed this function for many, many years. Use wpdb::prepare() instead. + * + * @since 0.71 + * @deprecated 3.9.0 + * + * @param string $content The text to format. + * @return string The very same text. + */ +function format_to_post( $content ) { + _deprecated_function( __FUNCTION__, '3.9' ); + return $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() + * + * @param string $text The text to be escaped. + * @return string text, safe for inclusion in LIKE query. + */ +function like_escape($text) { + _deprecated_function( __FUNCTION__, '4.0', 'wpdb::esc_like()' ); + return str_replace( array( "%", "_" ), array( "\\%", "\\_" ), $text ); +} + +/** + * Determines if the URL can be accessed over SSL. + * + * Determines if the URL can be accessed over SSL by using the WordPress HTTP API to access + * the URL using https as the scheme. + * + * @since 2.5.0 + * @deprecated 4.0.0 + * + * @param string $url The URL to test. + * @return bool Whether SSL access is available. + */ +function url_is_accessable_via_ssl( $url ) { + _deprecated_function( __FUNCTION__, '4.0' ); + + $response = wp_remote_get( set_url_scheme( $url, 'https' ) ); + + if ( !is_wp_error( $response ) ) { + $status = wp_remote_retrieve_response_code( $response ); + if ( 200 == $status || 401 == $status ) { + return true; + } + } + + 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 + * + * @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 ); +} +