X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/6c8f14c09105d0afa4c1574215c59b5021040e76..febc815b2c9d85be5717da9e8d164bd2daa97e31:/wp-admin/includes/deprecated.php diff --git a/wp-admin/includes/deprecated.php b/wp-admin/includes/deprecated.php index 5d88b3a1..2bf25d33 100644 --- a/wp-admin/includes/deprecated.php +++ b/wp-admin/includes/deprecated.php @@ -13,13 +13,12 @@ */ /** - * @since 2.1 - * @deprecated 2.1 - * @deprecated Use wp_editor(). + * @since 2.1.0 + * @deprecated 2.1.0 Use wp_editor() * @see wp_editor() */ function tinymce_include() { - _deprecated_function( __FUNCTION__, '2.1', 'wp_editor()' ); + _deprecated_function( __FUNCTION__, '2.1.0', 'wp_editor()' ); wp_tiny_mce(); } @@ -27,21 +26,19 @@ 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; + _deprecated_function( __FUNCTION__, '2.5.0' ); } /** * Calculates the new dimensions for a downsampled image. * * @since 2.0.0 - * @deprecated 3.0.0 - * @deprecated Use wp_constrain_dimensions() + * @deprecated 3.0.0 Use wp_constrain_dimensions() * @see wp_constrain_dimensions() * * @param int $width Current width of the image @@ -51,7 +48,7 @@ function documentation_link() { * @return array Shrunk dimensions (width, height). */ function wp_shrink_dimensions( $width, $height, $wmax = 128, $hmax = 96 ) { - _deprecated_function( __FUNCTION__, '3.0', 'wp_constrain_dimensions()' ); + _deprecated_function( __FUNCTION__, '3.0.0', 'wp_constrain_dimensions()' ); return wp_constrain_dimensions( $width, $height, $wmax, $hmax ); } @@ -59,8 +56,7 @@ function wp_shrink_dimensions( $width, $height, $wmax = 128, $hmax = 96 ) { * Calculated the new dimensions for a downsampled image. * * @since 2.0.0 - * @deprecated 3.5.0 - * @deprecated Use wp_constrain_dimensions() + * @deprecated 3.5.0 Use wp_constrain_dimensions() * @see wp_constrain_dimensions() * * @param int $width Current width of the image @@ -68,61 +64,74 @@ function wp_shrink_dimensions( $width, $height, $wmax = 128, $hmax = 96 ) { * @return array Shrunk dimensions (width, height). */ function get_udims( $width, $height ) { - _deprecated_function( __FUNCTION__, '3.5', 'wp_constrain_dimensions()' ); + _deprecated_function( __FUNCTION__, '3.5.0', 'wp_constrain_dimensions()' ); return wp_constrain_dimensions( $width, $height, 128, 96 ); } /** - * {@internal Missing Short Description}} + * Legacy function used to generate the categories checklist control. * * @since 0.71 - * @deprecated 2.6.0 - * @deprecated Use wp_category_checklist() + * @deprecated 2.6.0 Use wp_category_checklist() * @see wp_category_checklist() * - * @param unknown_type $default - * @param unknown_type $parent - * @param unknown_type $popular_ids + * @param int $default Unused. + * @param int $parent Unused. + * @param array $popular_ids Unused. */ function dropdown_categories( $default = 0, $parent = 0, $popular_ids = array() ) { - _deprecated_function( __FUNCTION__, '2.6', 'wp_category_checklist()' ); + _deprecated_function( __FUNCTION__, '2.6.0', 'wp_category_checklist()' ); global $post_ID; wp_category_checklist( $post_ID ); } /** - * {@internal Missing Short Description}} + * Legacy function used to generate a link categories checklist control. * * @since 2.1.0 - * @deprecated 2.6.0 - * @deprecated Use wp_link_category_checklist() + * @deprecated 2.6.0 Use wp_link_category_checklist() * @see wp_link_category_checklist() * - * @param unknown_type $default + * @param int $default Unused. */ function dropdown_link_categories( $default = 0 ) { - _deprecated_function( __FUNCTION__, '2.6', 'wp_link_category_checklist()' ); + _deprecated_function( __FUNCTION__, '2.6.0', 'wp_link_category_checklist()' ); global $link_id; wp_link_category_checklist( $link_id ); } /** - * {@internal Missing Short Description}} + * 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.0' ); + + return WP_CONTENT_DIR . $file; +} + +/** + * Legacy function used for generating a categories drop-down control. * * @since 1.2.0 - * @deprecated 3.0.0 - * @deprecated Use wp_dropdown_categories() + * @deprecated 3.0.0 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 Optional. ID of the current category. Default 0. + * @param int $currentparent Optional. Current parent category ID. Default 0. + * @param int $parent Optional. Parent ID to retrieve categories for. Default 0. + * @param int $level Optional. Number of levels deep to display. Default 0. + * @param array $categories Optional. Categories to include in the control. Default 0. + * @return bool|null False if no categories were found. */ function wp_dropdown_cats( $currentcat = 0, $currentparent = 0, $parent = 0, $level = 0, $categories = 0 ) { - _deprecated_function( __FUNCTION__, '3.0', 'wp_dropdown_categories()' ); + _deprecated_function( __FUNCTION__, '3.0.0', 'wp_dropdown_categories()' ); if (!$categories ) $categories = get_categories( array('hide_empty' => 0) ); @@ -147,37 +156,33 @@ function wp_dropdown_cats( $currentcat = 0, $currentparent = 0, $parent = 0, $le * Register a setting and its sanitization callback * * @since 2.7.0 - * @deprecated 3.0.0 - * @deprecated Use register_setting() + * @deprecated 3.0.0 Use register_setting() * @see register_setting() * * @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 ); + _deprecated_function( __FUNCTION__, '3.0.0', 'register_setting()' ); + register_setting( $option_group, $option_name, $sanitize_callback ); } /** * Unregister a setting * * @since 2.7.0 - * @deprecated 3.0.0 - * @deprecated Use unregister_setting() + * @deprecated 3.0.0 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 ); + _deprecated_function( __FUNCTION__, '3.0.0', 'unregister_setting()' ); + unregister_setting( $option_group, $option_name, $sanitize_callback ); } /** @@ -189,39 +194,38 @@ function remove_option_update_handler( $option_group, $option_name, $sanitize_ca * @param string $filename **/ function codepress_get_lang( $filename ) { - _deprecated_function( __FUNCTION__, '3.0' ); - return; + _deprecated_function( __FUNCTION__, '3.0.0' ); } /** - * 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; + _deprecated_function( __FUNCTION__, '3.0.0' ); } /** * 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; + _deprecated_function( __FUNCTION__, '3.0.0' ); } /** - * @deprecated 3.1.0 + * Get all user IDs. + * + * @deprecated 3.1.0 Use get_users() * * @return array List of user IDs. */ function get_author_user_ids() { - _deprecated_function( __FUNCTION__, '3.1', 'get_users()' ); + _deprecated_function( __FUNCTION__, '3.1.0', 'get_users()' ); global $wpdb; if ( !is_multisite() ) @@ -233,13 +237,15 @@ function get_author_user_ids() { } /** - * @deprecated 3.1.0 + * Gets author users who can edit posts. + * + * @deprecated 3.1.0 Use get_users() * * @param int $user_id User ID. * @return array|bool List of editable authors. False if no editable users. */ function get_editable_authors( $user_id ) { - _deprecated_function( __FUNCTION__, '3.1', 'get_users()' ); + _deprecated_function( __FUNCTION__, '3.1.0', 'get_users()' ); global $wpdb; @@ -256,14 +262,16 @@ function get_editable_authors( $user_id ) { } /** - * @deprecated 3.1.0 + * Gets the IDs of any users who can edit posts. * - * @param int $user_id User ID. - * @param bool $exclude_zeros Optional, default is true. Whether to exclude zeros. - * @return unknown + * @deprecated 3.1.0 Use get_users() + * + * @param int $user_id User ID. + * @param bool $exclude_zeros Optional. Whether to exclude zeroes. Default true. + * @return array Array of editable user IDs, empty array otherwise. */ function get_editable_user_ids( $user_id, $exclude_zeros = true, $post_type = 'post' ) { - _deprecated_function( __FUNCTION__, '3.1', 'get_users()' ); + _deprecated_function( __FUNCTION__, '3.1.0', 'get_users()' ); global $wpdb; @@ -291,10 +299,12 @@ function get_editable_user_ids( $user_id, $exclude_zeros = true, $post_type = 'p } /** - * @deprecated 3.1.0 + * Gets all users who are not authors. + * + * @deprecated 3.1.0 Use get_users() */ function get_nonauthor_user_ids() { - _deprecated_function( __FUNCTION__, '3.1', 'get_users()' ); + _deprecated_function( __FUNCTION__, '3.1.0', 'get_users()' ); global $wpdb; @@ -306,12 +316,12 @@ function get_nonauthor_user_ids() { return $wpdb->get_col( $wpdb->prepare("SELECT user_id FROM $wpdb->usermeta WHERE meta_key = %s AND meta_value = '0'", $level_key) ); } -if ( !class_exists('WP_User_Search') ) : +if ( ! class_exists( 'WP_User_Search', false ) ) : /** * WordPress User Search class. * * @since 2.1.0 - * @deprecated 3.1.0 + * @deprecated 3.1.0 Use WP_User_Query */ class WP_User_Search { @@ -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,29 +479,40 @@ class WP_User_Search { * @param string $role Role name. * @return WP_User_Search */ - function WP_User_Search ($search_term = '', $page = '', $role = '') { - _deprecated_function( __FUNCTION__, '3.1', 'WP_User_Query' ); + function __construct( $search_term = '', $page = '', $role = '' ) { + _deprecated_function( __FUNCTION__, '3.1.0', '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(); } /** - * {@internal Missing Short Description}} + * PHP4 Constructor - Sets up the object properties. * - * {@internal Missing Long Description}} + * @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 ); + } + + /** + * Prepares the user search query (legacy). * * @since 2.1.0 * @access public */ - function prepare_query() { + public function prepare_query() { global $wpdb; $this->first_user = ($this->page - 1) * $this->users_per_page; @@ -524,14 +545,12 @@ class WP_User_Search { } /** - * {@internal Missing Short Description}} - * - * {@internal Missing Long Description}} + * Executes the user search query. * * @since 2.1.0 * @access public */ - function query() { + public function query() { global $wpdb; $this->results = $wpdb->get_col("SELECT DISTINCT($wpdb->users.ID)" . $this->query_from . $this->query_where . $this->query_orderby . $this->query_limit); @@ -539,35 +558,29 @@ 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.')); } /** - * {@internal Missing Short Description}} - * - * {@internal Missing Long Description}} + * Prepares variables for use in templates. * * @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}} - * - * {@internal Missing Long Description}} + * Handles paging for the user search query. * * @since 2.1.0 * @access public */ - function do_paging() { + public 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( @@ -589,16 +602,14 @@ class WP_User_Search { } /** - * {@internal Missing Short Description}} - * - * {@internal Missing Long Description}} + * Retrieves the user search query results. * * @since 2.1.0 * @access public * - * @return unknown + * @return array */ - function get_results() { + public function get_results() { return (array) $this->results; } @@ -647,16 +658,19 @@ class WP_User_Search { endif; /** - * Retrieve editable posts from other users. + * Retrieves editable posts from other users. * - * @deprecated 3.1.0 + * @since 2.3.0 + * @deprecated 3.1.0 Use get_posts() + * @see get_posts() * - * @param int $user_id User ID to not retrieve posts from. - * @param string $type Optional, defaults to 'any'. Post type to retrieve, can be 'draft' or 'pending'. + * @param int $user_id User ID to not retrieve posts from. + * @param string $type Optional. Post type to retrieve. Accepts 'draft', 'pending' or 'any' (all). + * Default 'any'. * @return array List of posts from others. */ -function get_others_unpublished_posts($user_id, $type='any') { - _deprecated_function( __FUNCTION__, '3.1' ); +function get_others_unpublished_posts( $user_id, $type = 'any' ) { + _deprecated_function( __FUNCTION__, '3.1.0' ); global $wpdb; @@ -682,13 +696,14 @@ function get_others_unpublished_posts($user_id, $type='any') { /** * Retrieve drafts from other users. * - * @deprecated 3.1.0 + * @deprecated 3.1.0 Use get_posts() + * @see get_posts() * * @param int $user_id User ID. * @return array List of drafts from other users. */ function get_others_drafts($user_id) { - _deprecated_function( __FUNCTION__, '3.1' ); + _deprecated_function( __FUNCTION__, '3.1.0' ); return get_others_unpublished_posts($user_id, 'draft'); } @@ -696,13 +711,14 @@ function get_others_drafts($user_id) { /** * Retrieve pending review posts from other users. * - * @deprecated 3.1.0 + * @deprecated 3.1.0 Use get_posts() + * @see get_posts() * * @param int $user_id User ID. * @return array List of posts with pending review post type from other users. */ function get_others_pending($user_id) { - _deprecated_function( __FUNCTION__, '3.1' ); + _deprecated_function( __FUNCTION__, '3.1.0' ); return get_others_unpublished_posts($user_id, 'pending'); } @@ -711,27 +727,29 @@ function get_others_pending($user_id) { * Output the QuickPress dashboard widget. * * @since 3.0.0 - * @deprecated 3.2.0 - * @deprecated Use wp_dashboard_quick_press() + * @deprecated 3.2.0 Use wp_dashboard_quick_press() * @see wp_dashboard_quick_press() */ function wp_dashboard_quick_press_output() { - _deprecated_function( __FUNCTION__, '3.2', 'wp_dashboard_quick_press()' ); + _deprecated_function( __FUNCTION__, '3.2.0', 'wp_dashboard_quick_press()' ); wp_dashboard_quick_press(); } /** + * Outputs the TinyMCE editor. + * * @since 2.7.0 - * @deprecated 3.3 - * @deprecated Use wp_editor() + * @deprecated 3.3.0 Use wp_editor() * @see wp_editor() + * + * @staticvar int $num */ function wp_tiny_mce( $teeny = false, $settings = false ) { - _deprecated_function( __FUNCTION__, '3.3', 'wp_editor()' ); + _deprecated_function( __FUNCTION__, '3.3.0', 'wp_editor()' ); static $num = 1; - if ( ! class_exists('_WP_Editors' ) ) + if ( ! class_exists( '_WP_Editors', false ) ) require_once( ABSPATH . WPINC . '/class-wp-editor.php' ); $editor_id = 'content' . $num++; @@ -747,42 +765,44 @@ function wp_tiny_mce( $teeny = false, $settings = false ) { } /** - * @deprecated 3.3.0 - * @deprecated Use wp_editor() + * Preloads TinyMCE dialogs. + * + * @deprecated 3.3.0 Use wp_editor() * @see wp_editor() */ function wp_preload_dialogs() { - _deprecated_function( __FUNCTION__, '3.3', 'wp_editor()' ); + _deprecated_function( __FUNCTION__, '3.3.0', 'wp_editor()' ); } /** - * @deprecated 3.3.0 - * @deprecated Use wp_editor() + * Prints TinyMCE editor JS. + * + * @deprecated 3.3.0 Use wp_editor() * @see wp_editor() */ function wp_print_editor_js() { - _deprecated_function( __FUNCTION__, '3.3', 'wp_editor()' ); + _deprecated_function( __FUNCTION__, '3.3.0', 'wp_editor()' ); } /** - * @deprecated 3.3.0 - * @deprecated Use wp_editor() + * Handles quicktags. + * + * @deprecated 3.3.0 Use wp_editor() * @see wp_editor() */ function wp_quicktags() { - _deprecated_function( __FUNCTION__, '3.3', 'wp_editor()' ); + _deprecated_function( __FUNCTION__, '3.3.0', 'wp_editor()' ); } /** * Returns the screen layout options. * * @since 2.8.0 - * @deprecated 3.3.0 - * @deprecated Use $current_screen->render_screen_layout() + * @deprecated 3.3.0 WP_Screen::render_screen_layout() * @see WP_Screen::render_screen_layout() */ function screen_layout( $screen ) { - _deprecated_function( __FUNCTION__, '3.3', '$current_screen->render_screen_layout()' ); + _deprecated_function( __FUNCTION__, '3.3.0', '$current_screen->render_screen_layout()' ); $current_screen = get_current_screen(); @@ -798,12 +818,11 @@ function screen_layout( $screen ) { * Returns the screen's per-page options. * * @since 2.8.0 - * @deprecated 3.3.0 - * @deprecated Use $current_screen->render_per_page_options() + * @deprecated 3.3.0 Use WP_Screen::render_per_page_options() * @see WP_Screen::render_per_page_options() */ function screen_options( $screen ) { - _deprecated_function( __FUNCTION__, '3.3', '$current_screen->render_per_page_options()' ); + _deprecated_function( __FUNCTION__, '3.3.0', '$current_screen->render_per_page_options()' ); $current_screen = get_current_screen(); @@ -819,8 +838,7 @@ function screen_options( $screen ) { * Renders the screen's help. * * @since 2.7.0 - * @deprecated 3.3.0 - * @deprecated Use $current_screen->render_screen_meta() + * @deprecated 3.3.0 Use WP_Screen::render_screen_meta() * @see WP_Screen::render_screen_meta() */ function screen_meta( $screen ) { @@ -832,49 +850,114 @@ function screen_meta( $screen ) { * Favorite actions were deprecated in version 3.2. Use the admin bar instead. * * @since 2.7.0 - * @deprecated 3.2.0 + * @deprecated 3.2.0 Use WP_Admin_Bar + * @see WP_Admin_Bar */ function favorite_actions() { - _deprecated_function( __FUNCTION__, '3.2', 'WP_Admin_Bar' ); + _deprecated_function( __FUNCTION__, '3.2.0', 'WP_Admin_Bar' ); } +/** + * Handles uploading an image. + * + * @deprecated 3.3.0 Use wp_media_upload_handler() + * @see wp_media_upload_handler() + * + * @return null|string + */ function media_upload_image() { - __deprecated_function( __FUNCTION__, '3.3', 'wp_media_upload_handler()' ); + _deprecated_function( __FUNCTION__, '3.3.0', 'wp_media_upload_handler()' ); return wp_media_upload_handler(); } +/** + * Handles uploading an audio file. + * + * @deprecated 3.3.0 Use wp_media_upload_handler() + * @see wp_media_upload_handler() + * + * @return null|string + */ function media_upload_audio() { - __deprecated_function( __FUNCTION__, '3.3', 'wp_media_upload_handler()' ); + _deprecated_function( __FUNCTION__, '3.3.0', 'wp_media_upload_handler()' ); return wp_media_upload_handler(); } +/** + * Handles uploading a video file. + * + * @deprecated 3.3.0 Use wp_media_upload_handler() + * @see wp_media_upload_handler() + * + * @return null|string + */ function media_upload_video() { - __deprecated_function( __FUNCTION__, '3.3', 'wp_media_upload_handler()' ); + _deprecated_function( __FUNCTION__, '3.3.0', 'wp_media_upload_handler()' ); return wp_media_upload_handler(); } +/** + * Handles uploading a generic file. + * + * @deprecated 3.3.0 Use wp_media_upload_handler() + * @see wp_media_upload_handler() + * + * @return null|string + */ function media_upload_file() { - __deprecated_function( __FUNCTION__, '3.3', 'wp_media_upload_handler()' ); + _deprecated_function( __FUNCTION__, '3.3.0', 'wp_media_upload_handler()' ); return wp_media_upload_handler(); } +/** + * Handles retrieving the insert-from-URL form for an image. + * + * @deprecated 3.3.0 Use wp_media_insert_url_form() + * @see wp_media_insert_url_form() + * + * @return string + */ function type_url_form_image() { - __deprecated_function( __FUNCTION__, '3.3', "wp_media_insert_url_form('image')" ); + _deprecated_function( __FUNCTION__, '3.3.0', "wp_media_insert_url_form('image')" ); return wp_media_insert_url_form( 'image' ); } +/** + * Handles retrieving the insert-from-URL form for an audio file. + * + * @deprecated 3.3.0 Use wp_media_insert_url_form() + * @see wp_media_insert_url_form() + * + * @return string + */ function type_url_form_audio() { - __deprecated_function( __FUNCTION__, '3.3', "wp_media_insert_url_form('audio')" ); + _deprecated_function( __FUNCTION__, '3.3.0', "wp_media_insert_url_form('audio')" ); return wp_media_insert_url_form( 'audio' ); } +/** + * Handles retrieving the insert-from-URL form for a video file. + * + * @deprecated 3.3.0 Use wp_media_insert_url_form() + * @see wp_media_insert_url_form() + * + * @return string + */ function type_url_form_video() { - __deprecated_function( __FUNCTION__, '3.3', "wp_media_insert_url_form('video')" ); + _deprecated_function( __FUNCTION__, '3.3.0', "wp_media_insert_url_form('video')" ); return wp_media_insert_url_form( 'video' ); } +/** + * Handles retrieving the insert-from-URL form for a generic file. + * + * @deprecated 3.3.0 Use wp_media_insert_url_form() + * @see wp_media_insert_url_form() + * + * @return string + */ function type_url_form_file() { - __deprecated_function( __FUNCTION__, '3.3', "wp_media_insert_url_form('file')" ); + _deprecated_function( __FUNCTION__, '3.3.0', "wp_media_insert_url_form('file')" ); return wp_media_insert_url_form( 'file' ); } @@ -884,15 +967,14 @@ function type_url_form_file() { * Creates an 'Overview' help tab. * * @since 2.7.0 - * @deprecated 3.3.0 - * @deprecated Use get_current_screen()->add_help_tab() - * @see WP_Screen + * @deprecated 3.3.0 Use WP_Screen::add_help_tab() + * @see WP_Screen::add_help_tab() * * @param string $screen The handle for the screen to add help to. This is usually the hook name returned by the add_*_page() functions. * @param string $help The content of an 'Overview' help tab. */ function add_contextual_help( $screen, $help ) { - _deprecated_function( __FUNCTION__, '3.3', 'get_current_screen()->add_help_tab()' ); + _deprecated_function( __FUNCTION__, '3.3.0', 'get_current_screen()->add_help_tab()' ); if ( is_string( $screen ) ) $screen = convert_to_screen( $screen ); @@ -901,17 +983,16 @@ function add_contextual_help( $screen, $help ) { } /** - * Get the allowed themes for the current blog. + * Get the allowed themes for the current site. * * @since 3.0.0 - * @deprecated 3.4.0 - * @deprecated Use wp_get_themes() + * @deprecated 3.4.0 Use wp_get_themes() * @see wp_get_themes() * * @return array $themes Array of allowed themes. */ function get_allowed_themes() { - _deprecated_function( __FUNCTION__, '3.4', "wp_get_themes( array( 'allowed' => true ) )" ); + _deprecated_function( __FUNCTION__, '3.4.0', "wp_get_themes( array( 'allowed' => true ) )" ); $themes = wp_get_themes( array( 'allowed' => true ) ); @@ -924,14 +1005,16 @@ function get_allowed_themes() { } /** - * {@internal Missing Short Description}} + * Retrieves a list of broken themes. * * @since 1.5.0 + * @deprecated 3.4.0 Use wp_get_themes() + * @see wp_get_themes() * - * @return unknown + * @return array */ function get_broken_themes() { - _deprecated_function( __FUNCTION__, '3.4', "wp_get_themes( array( 'errors' => true )" ); + _deprecated_function( __FUNCTION__, '3.4.0', "wp_get_themes( array( 'errors' => true )" ); $themes = wp_get_themes( array( 'errors' => true ) ); $broken = array(); @@ -947,62 +1030,69 @@ function get_broken_themes() { } /** - * {@internal Missing Short Description}} + * Retrieves information on the current active theme. * * @since 2.0.0 + * @deprecated 3.4.0 Use wp_get_theme() + * @see wp_get_theme() * - * @return unknown + * @return WP_Theme */ function current_theme_info() { - _deprecated_function( __FUNCTION__, '3.4', 'wp_get_theme()' ); + _deprecated_function( __FUNCTION__, '3.4.0', 'wp_get_theme()' ); return wp_get_theme(); } /** - * This was once used to display an 'Insert into Post' button. Now it is deprecated and stubbed. + * This was once used to display an 'Insert into Post' button. + * + * Now it is deprecated and stubbed. * * @deprecated 3.5.0 */ function _insert_into_post_button( $type ) { - _deprecated_function( __FUNCTION__, '3.5' ); + _deprecated_function( __FUNCTION__, '3.5.0' ); } /** - * This was once used to display a media button. Now it is deprecated and stubbed. + * This was once used to display a media button. + * + * Now it is deprecated and stubbed. * * @deprecated 3.5.0 */ function _media_button($title, $icon, $type, $id) { - _deprecated_function( __FUNCTION__, '3.5' ); + _deprecated_function( __FUNCTION__, '3.5.0' ); } /** - * Get an existing post and format it for editing. + * Gets an existing post and format it for editing. * * @since 2.0.0 - * @deprecated 3.5.0 + * @deprecated 3.5.0 Use get_post() + * @see get_post() * * @param int $id * @return object */ function get_post_to_edit( $id ) { - _deprecated_function( __FUNCTION__, '3.5', 'get_post()' ); + _deprecated_function( __FUNCTION__, '3.5.0', 'get_post()' ); return get_post( $id, OBJECT, 'edit' ); } /** - * Get the default page information to use. + * Gets the default page information to use. * * @since 2.5.0 - * @deprecated 3.5.0 - * @deprecated Use get_default_post_to_edit() + * @deprecated 3.5.0 Use get_default_post_to_edit() + * @see get_default_post_to_edit() * * @return WP_Post Post object containing all the default post data as attributes */ function get_default_page_to_edit() { - _deprecated_function( __FUNCTION__, '3.5', "get_default_post_to_edit( 'page' )" ); + _deprecated_function( __FUNCTION__, '3.5.0', "get_default_post_to_edit( 'page' )" ); $page = get_default_post_to_edit(); $page->post_type = 'page'; @@ -1013,9 +1103,8 @@ function get_default_page_to_edit() { * This was once used to create a thumbnail from an Image given a maximum side size. * * @since 1.2.0 - * @deprecated 3.5.0 - * @deprecated Use image_resize() - * @see image_resize() + * @deprecated 3.5.0 Use 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 +1112,287 @@ 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.0', 'image_resize()' ); return apply_filters( 'wp_create_thumbnail', image_resize( $file, $max_side, $max_side ) ); } + +/** + * This was once used to display a meta box 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.0' ); +} + +/** + * 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 Use Core_Upgrader + * @see Core_Upgrader + */ +function wp_update_core($current, $feedback = '') { + _deprecated_function( __FUNCTION__, '3.7.0', '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 Use Plugin_Upgrader + * @see Plugin_Upgrader + */ +function wp_update_plugin($plugin, $feedback = '') { + _deprecated_function( __FUNCTION__, '3.7.0', '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 instantiating a Theme_Upgrader instance directly, + * and calling the 'upgrade' method. + * Unused since 2.8.0. + * + * @since 2.7.0 + * @deprecated 3.7.0 Use Theme_Upgrader + * @see Theme_Upgrader + */ +function wp_update_theme($theme, $feedback = '') { + _deprecated_function( __FUNCTION__, '3.7.0', '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. + * + * @since 2.0.0 + * @deprecated 3.7.0 + * + * @param int|bool $id + */ +function the_attachment_links( $id = false ) { + _deprecated_function( __FUNCTION__, '3.7.0' ); +} + +/** + * 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 Use get_screen_icon() + * @see get_screen_icon() + */ +function screen_icon() { + echo get_screen_icon(); +} + +/** + * Retrieves the screen icon (no longer used in 3.8+). + * + * @deprecated 3.8.0 + * + * @return string + */ +function get_screen_icon() { + return ''; +} + +/** + * Deprecated dashboard widget controls. + * + * @since 2.5.0 + * @deprecated 3.8.0 + */ +function wp_dashboard_incoming_links_output() {} + +/** + * Deprecated dashboard secondary output. + * + * @deprecated 3.8.0 + */ +function wp_dashboard_secondary_output() {} + +/** + * Deprecated dashboard widget controls. + * + * @since 2.7.0 + * @deprecated 3.8.0 + */ +function wp_dashboard_incoming_links() {} + +/** + * Deprecated dashboard incoming links control. + * + * @deprecated 3.8.0 + */ +function wp_dashboard_incoming_links_control() {} + +/** + * Deprecated dashboard plugins control. + * + * @deprecated 3.8.0 + */ +function wp_dashboard_plugins() {} + +/** + * Deprecated dashboard primary control. + * + * @deprecated 3.8.0 + */ +function wp_dashboard_primary_control() {} + +/** + * Deprecated dashboard recent comments control. + * + * @deprecated 3.8.0 + */ +function wp_dashboard_recent_comments_control() {} + +/** + * Deprecated dashboard secondary section. + * + * @deprecated 3.8.0 + */ +function wp_dashboard_secondary() {} + +/** + * Deprecated dashboard secondary control. + * + * @deprecated 3.8.0 + */ +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.0' ); +} + +/** + * Add a top-level menu page in the 'objects' section. + * + * This function takes a capability which will be used to determine whether + * or not a page is included in the menu. + * + * The function which is hooked in to handle the output of the page must check + * that the user has the required capability as well. + * + * @since 2.7.0 + * + * @deprecated 4.5.0 Use add_menu_page() + * @see add_menu_page() + * @global int $_wp_last_object_menu + * + * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected. + * @param string $menu_title The text to be used for the menu. + * @param string $capability The capability required for this menu to be displayed to the user. + * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu). + * @param callable $function The function to be called to output the content for this page. + * @param string $icon_url The url to the icon to be used for this menu. + * @return string The resulting page's hook_suffix. + */ +function add_object_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '') { + _deprecated_function( __FUNCTION__, '4.5.0', 'add_menu_page()' ); + + global $_wp_last_object_menu; + + $_wp_last_object_menu++; + + return add_menu_page($page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $_wp_last_object_menu); +} + +/** + * Add a top-level menu page in the 'utility' section. + * + * This function takes a capability which will be used to determine whether + * or not a page is included in the menu. + * + * The function which is hooked in to handle the output of the page must check + * that the user has the required capability as well. + * + * @since 2.7.0 + * + * @deprecated 4.5.0 Use add_menu_page() + * @see add_menu_page() + * @global int $_wp_last_utility_menu + * + * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected. + * @param string $menu_title The text to be used for the menu. + * @param string $capability The capability required for this menu to be displayed to the user. + * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu). + * @param callable $function The function to be called to output the content for this page. + * @param string $icon_url The url to the icon to be used for this menu. + * @return string The resulting page's hook_suffix. + */ +function add_utility_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '') { + _deprecated_function( __FUNCTION__, '4.5.0', 'add_menu_page()' ); + + global $_wp_last_utility_menu; + + $_wp_last_utility_menu++; + + return add_menu_page($page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $_wp_last_utility_menu); +} + +/** + * Disables autocomplete on the 'post' form (Add/Edit Post screens) for WebKit browsers, + * as they disregard the autocomplete setting on the editor textarea. That can break the editor + * when the user navigates to it with the browser's Back button. See #28037 + * + * Replaced with wp_page_reload_on_back_button_js() that also fixes this problem. + * + * @since 4.0.0 + * $deprecated 4.6.0 + * + * @global bool $is_safari + * @global bool $is_chrome + */ +function post_form_autocomplete_off() { + global $is_safari, $is_chrome; + + _deprecated_function( __FUNCTION__, '4.6.0' ); + + if ( $is_safari || $is_chrome ) { + echo ' autocomplete="off"'; + } +}