WordPress 4.3
[autoinstalls/wordpress.git] / wp-includes / deprecated.php
index 43cf743b77e4047c547f3c7c797a1af23875f863..ac3910550d49f73b2a9d5570421427589926456b 100644 (file)
@@ -54,7 +54,7 @@ function get_postdata($postid) {
  *
  * @since 1.0.1
  * @deprecated 1.5.0
- * @deprecated Use The Loop - {@link http://codex.wordpress.org/The_Loop Use new WordPress Loop}
+ * @deprecated Use The Loop - {@link https://codex.wordpress.org/The_Loop Use new WordPress Loop}
  */
 function start_wp() {
        global $wp_query;
@@ -427,7 +427,7 @@ function get_linksbyname($cat_name = "noname", $before = '', $after = '<br />',
  *
  * @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,12 +451,10 @@ function wp_get_linksbyname($category, $args = '') {
 /**
  * Gets an array of link objects associated with category $cat_name.
  *
- * <code>
- *     $links = get_linkobjectsbyname('fred');
- *     foreach ($links as $link) {
- *             echo '<li>'.$link->link_name.'</li>';
- *     }
- * </code>
+ *     $links = get_linkobjectsbyname( 'fred' );
+ *     foreach ( $links as $link ) {
+ *             echo '<li>' . $link->link_name . '</li>';
+ *     }
  *
  * @since 1.0.1
  * @deprecated 2.1.0
@@ -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,31 +483,29 @@ function get_linkobjectsbyname($cat_name = "noname" , $orderby = 'name', $limit
  * Gets an array of link objects associated with category n.
  *
  * Usage:
- * <code>
- *     $links = get_linkobjects(1);
- *     if ($links) {
- *             foreach ($links as $link) {
- *                     echo '<li>'.$link->link_name.'<br />'.$link->link_description.'</li>';
- *             }
- *     }
- * </code>
+ *
+ *     $links = get_linkobjects(1);
+ *     if ($links) {
+ *             foreach ($links as $link) {
+ *                     echo '<li>'.$link->link_name.'<br />'.$link->link_description.'</li>';
+ *             }
+ *     }
  *
  * Fields are:
- * <ol>
- *     <li>link_id</li>
- *     <li>link_url</li>
- *     <li>link_name</li>
- *     <li>link_image</li>
- *     <li>link_target</li>
- *     <li>link_category</li>
- *     <li>link_description</li>
- *     <li>link_visible</li>
- *     <li>link_owner</li>
- *     <li>link_rating</li>
- *     <li>link_updated</li>
- *     <li>link_rel</li>
- *     <li>link_notes</li>
- * </ol>
+ *
+ * - 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.0
@@ -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()' );
@@ -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 = '<br />', $between = " ", $show_images = true,
@@ -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,
@@ -650,7 +646,7 @@ function list_cats($optionall = 1, $all = 'All', $sort_column = 'ID', $sort_orde
  * @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()' );
@@ -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,
@@ -726,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()' );
@@ -743,7 +739,7 @@ function list_authors($optioncount = false, $exclude_admin = true, $show_fullnam
  *
  * @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()' );
@@ -761,7 +757,7 @@ function wp_get_post_cats($blogid = '1', $post_ID = 0) {
  * @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()' );
@@ -780,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()' );
@@ -1098,7 +1094,7 @@ function links_popup_script($text = 'Links', $width=400, $height=400, $file='lin
  * @see sanitize_bookmark_field()
  *
  * @param object $link
- * @return unknown
+ * @return mixed
  */
 function get_linkrating($link) {
        _deprecated_function( __FUNCTION__, '2.1', 'sanitize_bookmark_field()' );
@@ -1160,7 +1156,7 @@ function comments_rss_link($link_text = 'Comments RSS') {
  *
  * @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()' );
@@ -1182,7 +1178,7 @@ function get_category_rss_link($echo = false, $cat_ID = 1) {
  *
  * @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()' );
@@ -1218,7 +1214,7 @@ function comments_rss() {
  *
  * @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) {
@@ -1308,6 +1304,27 @@ 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.
  *
@@ -1640,7 +1657,7 @@ function the_author_url() {
  * @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\')' );
@@ -1678,14 +1695,13 @@ function the_author_ID() {
  * and the rest of the content will be removed.
  *
  * @since 0.71
- * @uses apply_filters() Calls 'the_content_rss' on the content before processing.
  *
  * @deprecated 2.9.0
  * @deprecated Use the_content_feed()
  * @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(.+?)href=\"(.+?)\"(.*?)>(.+?)<\/a>/', $content, $matches );
        $links_summary = "\n";
-       for ( $i=0; $i<count($matches[0]); $i++ ) {
+       for ( $i = 0, $c = count( $matches[0] ); $i < $c; $i++ ) {
                $link_match = $matches[0][$i];
                $link_number = '['.($i+1).']';
                $link_url = $matches[2][$i];
@@ -1786,7 +1802,6 @@ function _c( $text, $domain = 'default' ) {
  * contains a context after its last vertical bar.
  *
  * @since 2.5.0
- * @uses translate()
  * @deprecated 3.0.0
  * @deprecated Use _x()
  * @see _x()
@@ -1916,13 +1931,11 @@ function get_attachment_icon_src( $id = 0, $fullsize = false ) {
                // We have a thumbnail desired, specified and existing
 
                $src_file = basename($src);
-               $class = 'attachmentthumb';
        } elseif ( wp_attachment_is_image( $post->ID ) ) {
                // 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 <<pre>>...<</pre>> HTML block are not
+ * Ensures that the contents of a `<pre>...</pre>` 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()' );
@@ -3438,3 +3449,190 @@ 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 );
+}
+