]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-admin/includes/deprecated.php
WordPress 4.3
[autoinstalls/wordpress.git] / wp-admin / includes / deprecated.php
index 5d88b3a1ec76012939c695c4295533e5eb526f06..e12547e90b6d61acb655240b15cade889317e618 100644 (file)
@@ -13,8 +13,8 @@
  */
 
 /**
- * @since 2.1
- * @deprecated 2.1
+ * @since 2.1.0
+ * @deprecated 2.1.0
  * @deprecated Use wp_editor().
  * @see wp_editor()
  */
@@ -27,13 +27,12 @@ function tinymce_include() {
 /**
  * Unused Admin function.
  *
- * @since 2.0
- * @deprecated 2.5
+ * @since 2.0.0
+ * @deprecated 2.5.0
  *
  */
 function documentation_link() {
        _deprecated_function( __FUNCTION__, '2.5' );
-       return;
 }
 
 /**
@@ -80,9 +79,9 @@ function get_udims( $width, $height ) {
  * @deprecated Use wp_category_checklist()
  * @see wp_category_checklist()
  *
- * @param unknown_type $default
- * @param unknown_type $parent
- * @param unknown_type $popular_ids
+ * @param int $default
+ * @param int $parent
+ * @param array $popular_ids
  */
 function dropdown_categories( $default = 0, $parent = 0, $popular_ids = array() ) {
        _deprecated_function( __FUNCTION__, '2.6', 'wp_category_checklist()' );
@@ -98,7 +97,7 @@ function dropdown_categories( $default = 0, $parent = 0, $popular_ids = array()
  * @deprecated Use wp_link_category_checklist()
  * @see wp_link_category_checklist()
  *
- * @param unknown_type $default
+ * @param int $default
  */
 function dropdown_link_categories( $default = 0 ) {
        _deprecated_function( __FUNCTION__, '2.6', 'wp_link_category_checklist()' );
@@ -106,6 +105,22 @@ function dropdown_link_categories( $default = 0 ) {
        wp_link_category_checklist( $link_id );
 }
 
+/**
+ * Get the real filesystem path to a file to edit within the admin.
+ *
+ * @since 1.5.0
+ * @deprecated 2.9.0
+ * @uses WP_CONTENT_DIR Full filesystem path to the wp-content directory.
+ *
+ * @param string $file Filesystem path relative to the wp-content directory.
+ * @return string Full filesystem path to edit.
+ */
+function get_real_file_to_edit( $file ) {
+       _deprecated_function( __FUNCTION__, '2.9' );
+
+       return WP_CONTENT_DIR . $file;
+}
+
 /**
  * {@internal Missing Short Description}}
  *
@@ -114,12 +129,12 @@ function dropdown_link_categories( $default = 0 ) {
  * @deprecated Use wp_dropdown_categories()
  * @see wp_dropdown_categories()
  *
- * @param unknown_type $currentcat
- * @param unknown_type $currentparent
- * @param unknown_type $parent
- * @param unknown_type $level
- * @param unknown_type $categories
- * @return unknown
+ * @param int $currentcat
+ * @param int $currentparent
+ * @param int $parent
+ * @param int $level
+ * @param array $categories
+ * @return bool|null
  */
 function wp_dropdown_cats( $currentcat = 0, $currentparent = 0, $parent = 0, $level = 0, $categories = 0 ) {
        _deprecated_function( __FUNCTION__, '3.0', 'wp_dropdown_categories()' );
@@ -154,12 +169,11 @@ function wp_dropdown_cats( $currentcat = 0, $currentparent = 0, $parent = 0, $le
  * @param string $option_group A settings group name. Should correspond to a whitelisted option key name.
  *     Default whitelisted option key names include "general," "discussion," and "reading," among others.
  * @param string $option_name The name of an option to sanitize and save.
- * @param unknown_type $sanitize_callback A callback function that sanitizes the option's value.
- * @return unknown
+ * @param callable $sanitize_callback A callback function that sanitizes the option's value.
  */
 function add_option_update_handler( $option_group, $option_name, $sanitize_callback = '' ) {
        _deprecated_function( __FUNCTION__, '3.0', 'register_setting()' );
-       return register_setting( $option_group, $option_name, $sanitize_callback );
+       register_setting( $option_group, $option_name, $sanitize_callback );
 }
 
 /**
@@ -170,14 +184,13 @@ function add_option_update_handler( $option_group, $option_name, $sanitize_callb
  * @deprecated Use unregister_setting()
  * @see unregister_setting()
  *
- * @param unknown_type $option_group
- * @param unknown_type $option_name
- * @param unknown_type $sanitize_callback
- * @return unknown
+ * @param string $option_group
+ * @param string $option_name
+ * @param callable $sanitize_callback
  */
 function remove_option_update_handler( $option_group, $option_name, $sanitize_callback = '' ) {
        _deprecated_function( __FUNCTION__, '3.0', 'unregister_setting()' );
-       return unregister_setting( $option_group, $option_name, $sanitize_callback );
+       unregister_setting( $option_group, $option_name, $sanitize_callback );
 }
 
 /**
@@ -190,29 +203,26 @@ function remove_option_update_handler( $option_group, $option_name, $sanitize_ca
 **/
 function codepress_get_lang( $filename ) {
        _deprecated_function( __FUNCTION__, '3.0' );
-       return;
 }
 
 /**
- * Adds Javascript required to make CodePress work on the theme/plugin editors.
+ * Adds JavaScript required to make CodePress work on the theme/plugin editors.
  *
  * @since 2.8.0
  * @deprecated 3.0.0
 **/
 function codepress_footer_js() {
        _deprecated_function( __FUNCTION__, '3.0' );
-       return;
 }
 
 /**
  * Determine whether to use CodePress.
  *
- * @since 2.8
+ * @since 2.8.0
  * @deprecated 3.0.0
 **/
 function use_codepress() {
        _deprecated_function( __FUNCTION__, '3.0' );
-       return;
 }
 
 /**
@@ -260,7 +270,7 @@ function get_editable_authors( $user_id ) {
  *
  * @param int $user_id User ID.
  * @param bool $exclude_zeros Optional, default is true. Whether to exclude zeros.
- * @return unknown
+ * @return mixed
  */
 function get_editable_user_ids( $user_id, $exclude_zeros = true, $post_type = 'post' ) {
        _deprecated_function( __FUNCTION__, '3.1', 'get_users()' );
@@ -320,7 +330,7 @@ class WP_User_Search {
         *
         * @since 2.1.0
         * @access private
-        * @var unknown_type
+        * @var mixed
         */
        var $results;
 
@@ -329,7 +339,7 @@ class WP_User_Search {
         *
         * @since 2.1.0
         * @access private
-        * @var unknown_type
+        * @var string
         */
        var $search_term;
 
@@ -374,7 +384,7 @@ class WP_User_Search {
         *
         * @since 2.1.0
         * @access private
-        * @var unknown_type
+        * @var int
         */
        var $first_user;
 
@@ -446,7 +456,7 @@ class WP_User_Search {
         *
         * @since 2.1.0
         * @access private
-        * @var unknown_type
+        * @var WP_Error
         */
        var $search_errors;
 
@@ -455,12 +465,12 @@ class WP_User_Search {
         *
         * @since 2.7.0
         * @access private
-        * @var unknown_type
+        * @var string
         */
        var $paging_text;
 
        /**
-        * PHP4 Constructor - Sets up the object properties.
+        * PHP5 Constructor - Sets up the object properties.
         *
         * @since 2.1.0
         *
@@ -469,20 +479,33 @@ class WP_User_Search {
         * @param string $role Role name.
         * @return WP_User_Search
         */
-       function WP_User_Search ($search_term = '', $page = '', $role = '') {
+       function __construct( $search_term = '', $page = '', $role = '' ) {
                _deprecated_function( __FUNCTION__, '3.1', 'WP_User_Query' );
 
-               $this->search_term = stripslashes( $search_term );
+               $this->search_term = wp_unslash( $search_term );
                $this->raw_page = ( '' == $page ) ? false : (int) $page;
                $this->page = (int) ( '' == $page ) ? 1 : $page;
                $this->role = $role;
 
                $this->prepare_query();
                $this->query();
-               $this->prepare_vars_for_template_usage();
                $this->do_paging();
        }
 
+       /**
+        * PHP4 Constructor - Sets up the object properties.
+        *
+        * @since 2.1.0
+        *
+        * @param string $search_term Search terms string.
+        * @param int $page Optional. Page ID.
+        * @param string $role Role name.
+        * @return WP_User_Search
+        */
+       public function WP_User_Search( $search_term = '', $page = '', $role = '' ) {
+               self::__construct( $search_term, $page, $role );
+       }
+
        /**
         * {@internal Missing Short Description}}
         *
@@ -539,7 +562,7 @@ class WP_User_Search {
                if ( $this->results )
                        $this->total_users_for_query = $wpdb->get_var("SELECT COUNT(DISTINCT($wpdb->users.ID))" . $this->query_from . $this->query_where); // no limit
                else
-                       $this->search_errors = new WP_Error('no_matching_users_found', __('No matching users were found!'));
+                       $this->search_errors = new WP_Error('no_matching_users_found', __('No users found.'));
        }
 
        /**
@@ -550,9 +573,7 @@ class WP_User_Search {
         * @since 2.1.0
         * @access public
         */
-       function prepare_vars_for_template_usage() {
-               $this->search_term = stripslashes($this->search_term); // done with DB, from now on we want slashes gone
-       }
+       function prepare_vars_for_template_usage() {}
 
        /**
         * {@internal Missing Short Description}}
@@ -565,9 +586,9 @@ class WP_User_Search {
        function do_paging() {
                if ( $this->total_users_for_query > $this->users_per_page ) { // have to page the results
                        $args = array();
-                       if( ! empty($this->search_term) )
+                       if ( ! empty($this->search_term) )
                                $args['usersearch'] = urlencode($this->search_term);
-                       if( ! empty($this->role) )
+                       if ( ! empty($this->role) )
                                $args['role'] = urlencode($this->role);
 
                        $this->paging_text = paginate_links( array(
@@ -596,7 +617,7 @@ class WP_User_Search {
         * @since 2.1.0
         * @access public
         *
-        * @return unknown
+        * @return array
         */
        function get_results() {
                return (array) $this->results;
@@ -722,9 +743,11 @@ function wp_dashboard_quick_press_output() {
 
 /**
  * @since 2.7.0
- * @deprecated 3.3
+ * @deprecated 3.3.0
  * @deprecated Use wp_editor()
  * @see wp_editor()
+ *
+ * @staticvar int $num
  */
 function wp_tiny_mce( $teeny = false, $settings = false ) {
        _deprecated_function( __FUNCTION__, '3.3', 'wp_editor()' );
@@ -839,42 +862,42 @@ function favorite_actions() {
 }
 
 function media_upload_image() {
-       __deprecated_function( __FUNCTION__, '3.3', 'wp_media_upload_handler()' );
+       _deprecated_function( __FUNCTION__, '3.3', 'wp_media_upload_handler()' );
        return wp_media_upload_handler();
 }
 
 function media_upload_audio() {
-       __deprecated_function( __FUNCTION__, '3.3', 'wp_media_upload_handler()' );
+       _deprecated_function( __FUNCTION__, '3.3', 'wp_media_upload_handler()' );
        return wp_media_upload_handler();
 }
 
 function media_upload_video() {
-       __deprecated_function( __FUNCTION__, '3.3', 'wp_media_upload_handler()' );
+       _deprecated_function( __FUNCTION__, '3.3', 'wp_media_upload_handler()' );
        return wp_media_upload_handler();
 }
 
 function media_upload_file() {
-       __deprecated_function( __FUNCTION__, '3.3', 'wp_media_upload_handler()' );
+       _deprecated_function( __FUNCTION__, '3.3', 'wp_media_upload_handler()' );
        return wp_media_upload_handler();
 }
 
 function type_url_form_image() {
-       __deprecated_function( __FUNCTION__, '3.3', "wp_media_insert_url_form('image')" );
+       _deprecated_function( __FUNCTION__, '3.3', "wp_media_insert_url_form('image')" );
        return wp_media_insert_url_form( 'image' );
 }
 
 function type_url_form_audio() {
-       __deprecated_function( __FUNCTION__, '3.3', "wp_media_insert_url_form('audio')" );
+       _deprecated_function( __FUNCTION__, '3.3', "wp_media_insert_url_form('audio')" );
        return wp_media_insert_url_form( 'audio' );
 }
 
 function type_url_form_video() {
-       __deprecated_function( __FUNCTION__, '3.3', "wp_media_insert_url_form('video')" );
+       _deprecated_function( __FUNCTION__, '3.3', "wp_media_insert_url_form('video')" );
        return wp_media_insert_url_form( 'video' );
 }
 
 function type_url_form_file() {
-       __deprecated_function( __FUNCTION__, '3.3', "wp_media_insert_url_form('file')" );
+       _deprecated_function( __FUNCTION__, '3.3', "wp_media_insert_url_form('file')" );
        return wp_media_insert_url_form( 'file' );
 }
 
@@ -927,8 +950,9 @@ function get_allowed_themes() {
  * {@internal Missing Short Description}}
  *
  * @since 1.5.0
+ * @deprecated 3.4.0
  *
- * @return unknown
+ * @return array
  */
 function get_broken_themes() {
        _deprecated_function( __FUNCTION__, '3.4', "wp_get_themes( array( 'errors' => true )" );
@@ -950,8 +974,9 @@ function get_broken_themes() {
  * {@internal Missing Short Description}}
  *
  * @since 2.0.0
+ * @deprecated 3.4.0
  *
- * @return unknown
+ * @return WP_Theme
  */
 function current_theme_info() {
        _deprecated_function( __FUNCTION__, '3.4', 'wp_get_theme()' );
@@ -1015,7 +1040,7 @@ function get_default_page_to_edit() {
  * @since 1.2.0
  * @deprecated 3.5.0
  * @deprecated Use image_resize()
- * @see  image_resize()
+ * @see image_resize()
  *
  * @param mixed $file Filename of the original image, Or attachment id.
  * @param int $max_side Maximum length of a single side for the thumbnail.
@@ -1023,6 +1048,152 @@ function get_default_page_to_edit() {
  * @return string Thumbnail path on success, Error string on failure.
  */
 function wp_create_thumbnail( $file, $max_side, $deprecated = '' ) {
-       _deprecated_function( __FUNCTION__, '3.5', 'image_resize' );
+       _deprecated_function( __FUNCTION__, '3.5', 'image_resize()' );
        return apply_filters( 'wp_create_thumbnail', image_resize( $file, $max_side, $max_side ) );
 }
+
+/**
+ * This was once used to display a metabox for the nav menu theme locations.
+ *
+ * Deprecated in favor of a 'Manage Locations' tab added to nav menus management screen.
+ *
+ * @since 3.0.0
+ * @deprecated 3.6.0
+ */
+function wp_nav_menu_locations_meta_box() {
+       _deprecated_function( __FUNCTION__, '3.6' );
+}
+
+/**
+ * This was once used to kick-off the Core Updater.
+ *
+ * Deprecated in favor of instantating a Core_Upgrader instance directly,
+ * and calling the 'upgrade' method.
+ *
+ * @since 2.7.0
+ * @deprecated 3.7.0
+ * @see Core_Upgrader
+ */
+function wp_update_core($current, $feedback = '') {
+       _deprecated_function( __FUNCTION__, '3.7', 'new Core_Upgrader();' );
+
+       if ( !empty($feedback) )
+               add_filter('update_feedback', $feedback);
+
+       include( ABSPATH . 'wp-admin/includes/class-wp-upgrader.php' );
+       $upgrader = new Core_Upgrader();
+       return $upgrader->upgrade($current);
+
+}
+
+/**
+ * This was once used to kick-off the Plugin Updater.
+ *
+ * Deprecated in favor of instantating a Plugin_Upgrader instance directly,
+ * and calling the 'upgrade' method.
+ * Unused since 2.8.0.
+ *
+ * @since 2.5.0
+ * @deprecated 3.7.0
+ * @see Plugin_Upgrader
+ */
+function wp_update_plugin($plugin, $feedback = '') {
+       _deprecated_function( __FUNCTION__, '3.7', 'new Plugin_Upgrader();' );
+
+       if ( !empty($feedback) )
+               add_filter('update_feedback', $feedback);
+
+       include( ABSPATH . 'wp-admin/includes/class-wp-upgrader.php' );
+       $upgrader = new Plugin_Upgrader();
+       return $upgrader->upgrade($plugin);
+}
+
+/**
+ * This was once used to kick-off the Theme Updater.
+ *
+ * Deprecated in favor of instantating a Theme_Upgrader instance directly,
+ * and calling the 'upgrade' method.
+ * Unused since 2.8.0.
+ *
+ * @since 2.7.0
+ * @deprecated 3.7.0
+ * @see Theme_Upgrader
+ */
+function wp_update_theme($theme, $feedback = '') {
+       _deprecated_function( __FUNCTION__, '3.7', 'new Theme_Upgrader();' );
+
+       if ( !empty($feedback) )
+               add_filter('update_feedback', $feedback);
+
+       include( ABSPATH . 'wp-admin/includes/class-wp-upgrader.php' );
+       $upgrader = new Theme_Upgrader();
+       return $upgrader->upgrade($theme);
+}
+
+/**
+ * This was once used to display attachment links. Now it is deprecated and stubbed.
+ *
+ * {@internal Missing Short Description}}
+ *
+ * @since 2.0.0
+ * @deprecated 3.7.0
+ *
+ * @param int|bool $id
+ */
+function the_attachment_links( $id = false ) {
+       _deprecated_function( __FUNCTION__, '3.7' );
+}
+
+/**#@+
+ * Displays a screen icon.
+ *
+ * @since 2.7.0
+ * @since 3.8.0 Screen icons are no longer used in WordPress. This function no longer produces output.
+ * @deprecated 3.8.0
+ */
+function screen_icon() {
+       echo get_screen_icon();
+}
+function get_screen_icon() {
+       return '<!-- Screen icons are no longer used as of WordPress 3.8. -->';
+}
+/**#@-*/
+
+/**#@+
+ * Deprecated dashboard widget controls.
+ *
+ * @since 2.5.0
+ * @deprecated 3.8.0
+ */
+function wp_dashboard_incoming_links_output() {}
+function wp_dashboard_secondary_output() {}
+/**#@-*/
+
+/**#@+
+ * Deprecated dashboard widget controls.
+ *
+ * @since 2.7.0
+ * @deprecated 3.8.0
+ */
+function wp_dashboard_incoming_links() {}
+function wp_dashboard_incoming_links_control() {}
+function wp_dashboard_plugins() {}
+function wp_dashboard_primary_control() {}
+function wp_dashboard_recent_comments_control() {}
+function wp_dashboard_secondary() {}
+function wp_dashboard_secondary_control() {}
+/**#@-*/
+
+/**
+ * This was once used to move child posts to a new parent.
+ *
+ * @since 2.3.0
+ * @deprecated 3.9.0
+ * @access private
+ *
+ * @param int $old_ID
+ * @param int $new_ID
+ */
+function _relocate_children( $old_ID, $new_ID ) {
+       _deprecated_function( __FUNCTION__, '3.9' );
+}