enmi-conf.org: comparison wp/wp-admin/includes/deprecated.php

equal deleted inserted replaced

-:490d5cc509ed
+:cf61fcea0001
 * Deprecated functions come here to die.
 */
 /**
 * @since 2.1.0
-* @deprecated 2.1.0
+* @deprecated 2.1.0 Use wp_editor()
-* @deprecated 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();
 }
 /**
 * @since 2.0.0
 * @deprecated 2.5.0
 *
 */
 function documentation_link() {
-	_deprecated_function( __FUNCTION__, '2.5' );
+	_deprecated_function( __FUNCTION__, '2.5.0' );
 }
 /**
 * Calculates the new dimensions for a downsampled image.
 *
 * @since 2.0.0
-* @deprecated 3.0.0
+* @deprecated 3.0.0 Use wp_constrain_dimensions()
-* @deprecated Use wp_constrain_dimensions()
 * @see wp_constrain_dimensions()
 *
 * @param int $width Current width of the image
 * @param int $height Current height of the image
 * @param int $wmax Maximum wanted width
 * @param int $hmax Maximum wanted height
 * @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 );
 }
 /**
 * Calculated the new dimensions for a downsampled image.
 *
 * @since 2.0.0
-* @deprecated 3.5.0
+* @deprecated 3.5.0 Use wp_constrain_dimensions()
-* @deprecated Use wp_constrain_dimensions()
 * @see wp_constrain_dimensions()
 *
 * @param int $width Current width of the image
 * @param int $height Current height of the image
 * @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 2.6.0 Use wp_category_checklist()
-* @deprecated Use wp_category_checklist()
 * @see wp_category_checklist()
 *
-* @param int $default
+* @param int $default       Unused.
-* @param int $parent
+* @param int $parent        Unused.
-* @param array $popular_ids
+* @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 2.6.0 Use wp_link_category_checklist()
-* @deprecated Use wp_link_category_checklist()
 * @see wp_link_category_checklist()
 *
-* @param int $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 );
 }
 /**
 *
 * @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' );
+	_deprecated_function( __FUNCTION__, '2.9.0' );
 	return WP_CONTENT_DIR . $file;
 }
 /**
-* {@internal Missing Short Description}}
+* Legacy function used for generating a categories drop-down control.
 *
 * @since 1.2.0
-* @deprecated 3.0.0
+* @deprecated 3.0.0 Use wp_dropdown_categories()
-* @deprecated Use wp_dropdown_categories()
 * @see wp_dropdown_categories()
 *
-* @param int $currentcat
+* @param int $currentcat    Optional. ID of the current category. Default 0.
-* @param int $currentparent
+* @param int $currentparent Optional. Current parent category ID. Default 0.
-* @param int $parent
+* @param int $parent        Optional. Parent ID to retrieve categories for. Default 0.
-* @param int $level
+* @param int $level         Optional. Number of levels deep to display. Default 0.
-* @param array $categories
+* @param array $categories  Optional. Categories to include in the control. Default 0.
-* @return bool|null
+* @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) );
 	if ( $categories ) {
 		foreach ( $categories as $category ) {
 /**
 * Register a setting and its sanitization callback
 *
 * @since 2.7.0
-* @deprecated 3.0.0
+* @deprecated 3.0.0 Use register_setting()
-* @deprecated 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 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()' );
+	_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 3.0.0 Use unregister_setting()
-* @deprecated Use unregister_setting()
 * @see unregister_setting()
 *
 * @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()' );
+	_deprecated_function( __FUNCTION__, '3.0.0', 'unregister_setting()' );
 	unregister_setting( $option_group, $option_name, $sanitize_callback );
 }
 /**
 * Determines the language to use for CodePress syntax highlighting.
 * @deprecated 3.0.0
 *
 * @param string $filename
 **/
 function codepress_get_lang( $filename ) {
-	_deprecated_function( __FUNCTION__, '3.0' );
+	_deprecated_function( __FUNCTION__, '3.0.0' );
 }
 /**
 * 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' );
+	_deprecated_function( __FUNCTION__, '3.0.0' );
 }
 /**
 * Determine whether to use CodePress.
 *
 * @since 2.8.0
 * @deprecated 3.0.0
 **/
 function use_codepress() {
-	_deprecated_function( __FUNCTION__, '3.0' );
+	_deprecated_function( __FUNCTION__, '3.0.0' );
 }
 /**
-* @deprecated 3.1.0
+* Get all user IDs.
+*
+* @deprecated 3.1.0 Use get_users()
+*
+* @global wpdb $wpdb WordPress database abstraction object.
 *
 * @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() )
 		$level_key = $wpdb->get_blog_prefix() . 'user_level';
 	else
 	return $wpdb->get_col( $wpdb->prepare("SELECT user_id FROM $wpdb->usermeta WHERE meta_key = %s AND meta_value != '0'", $level_key) );
 }
 /**
-* @deprecated 3.1.0
+* Gets author users who can edit posts.
+*
+* @deprecated 3.1.0 Use get_users()
+*
+* @global wpdb $wpdb WordPress database abstraction object.
 *
 * @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;
 	$editable = get_editable_user_ids( $user_id );
 	return apply_filters('get_editable_authors', $authors);
 }
 /**
-* @deprecated 3.1.0
+* Gets the IDs of any users who can edit posts.
 *
-* @param int $user_id User ID.
+* @deprecated 3.1.0 Use get_users()
-* @param bool $exclude_zeros Optional, default is true. Whether to exclude zeros.
+*
-* @return mixed
+* @global wpdb $wpdb WordPress database abstraction object.
+*
+* @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;
 	if ( ! $user = get_userdata( $user_id ) )
 		return array();
 	return $wpdb->get_col( $query );
 }
 /**
-* @deprecated 3.1.0
+* Gets all users who are not authors.
+*
+* @deprecated 3.1.0 Use get_users()
+*
+* @global wpdb $wpdb WordPress database abstraction object.
 */
 function get_nonauthor_user_ids() {
-	_deprecated_function( __FUNCTION__, '3.1', 'get_users()' );
+	_deprecated_function( __FUNCTION__, '3.1.0', 'get_users()' );
 	global $wpdb;
 	if ( !is_multisite() )
 		$level_key = $wpdb->get_blog_prefix() . 'user_level';
 		$level_key = $wpdb->get_blog_prefix() . 'capabilities'; // wpmu site admins don't have user_levels
 	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 {
 	/**
 	 * {@internal Missing Description}}
 	 * @var string
 	 */
 	var $paging_text;
 	/**
-	 * PHP4 Constructor - Sets up the object properties.
+	 * PHP5 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
 	 */
-	function WP_User_Search ($search_term = '', $page = '', $role = '') {
+	function __construct( $search_term = '', $page = '', $role = '' ) {
-		_deprecated_function( __FUNCTION__, '3.1', 'WP_User_Query' );
+		_deprecated_function( __FUNCTION__, '3.1.0', 'WP_User_Query' );
 		$this->search_term = wp_unslash( $search_term );
 		$this->raw_page = ( '' == $page ) ? false : (int) $page;
 		$this->page = (int) ( '' == $page ) ? 1 : $page;
 		$this->role = $role;
 		$this->query();
 		$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;
 		$this->query_limit = $wpdb->prepare(" LIMIT %d, %d", $this->first_user, $this->users_per_page);
 		$this->query_orderby = ' ORDER BY user_login';
 		do_action_ref_array( 'pre_user_search', array( &$this ) );
 	}
 	/**
-	 * {@internal Missing Short Description}}
+	 * Executes the user search query.
-	 *
-	 * {@internal Missing Long Description}}
 	 *
 	 * @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);
 		if ( $this->results )
 		else
 			$this->search_errors = new WP_Error('no_matching_users_found', __('No users found.'));
 	}
 	/**
-	 * {@internal Missing Short Description}}
+	 * Prepares variables for use in templates.
-	 *
-	 * {@internal Missing Long Description}}
 	 *
 	 * @since 2.1.0
 	 * @access public
 	 */
 	function prepare_vars_for_template_usage() {}
 	/**
-	 * {@internal Missing Short Description}}
+	 * Handles paging for the user search query.
-	 *
-	 * {@internal Missing Long Description}}
 	 *
 	 * @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(
 				'total' => ceil($this->total_users_for_query / $this->users_per_page),
 				'current' => $this->page,
 			}
 		}
 	}
 	/**
-	 * {@internal Missing Short Description}}
+	 * Retrieves the user search query results.
-	 *
-	 * {@internal Missing Long Description}}
 	 *
 	 * @since 2.1.0
 	 * @access public
 	 *
 	 * @return array
 	 */
-	function get_results() {
+	public function get_results() {
 		return (array) $this->results;
 	}
 	/**
 	 * Displaying paging text.
 	}
 }
 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()
-* @param int $user_id User ID to not retrieve posts from.
+* @see get_posts()
-* @param string $type Optional, defaults to 'any'. Post type to retrieve, can be 'draft' or 'pending'.
+*
+* @global wpdb $wpdb WordPress database abstraction object.
+*
+* @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') {
+function get_others_unpublished_posts( $user_id, $type = 'any' ) {
-	_deprecated_function( __FUNCTION__, '3.1' );
+	_deprecated_function( __FUNCTION__, '3.1.0' );
 	global $wpdb;
 	$editable = get_editable_user_ids( $user_id );
 }
 /**
 * 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');
 }
 /**
 * 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');
 }
 /**
 * Output the QuickPress dashboard widget.
 *
 * @since 3.0.0
-* @deprecated 3.2.0
+* @deprecated 3.2.0 Use wp_dashboard_quick_press()
-* @deprecated 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.0
+* @deprecated 3.3.0 Use wp_editor()
-* @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()' );
+	_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++;
 	$set = array(
 	$set = _WP_Editors::parse_settings($editor_id, $set);
 	_WP_Editors::editor_settings($editor_id, $set);
 }
 /**
-* @deprecated 3.3.0
+* Preloads TinyMCE dialogs.
-* @deprecated Use wp_editor()
+*
+* @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
+* Prints TinyMCE editor JS.
-* @deprecated Use wp_editor()
+*
+* @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
+* Handles quicktags.
-* @deprecated Use wp_editor()
+*
+* @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 3.3.0 WP_Screen::render_screen_layout()
-* @deprecated Use $current_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();
 	if ( ! $current_screen )
 		return '';
 /**
 * Returns the screen's per-page options.
 *
 * @since 2.8.0
-* @deprecated 3.3.0
+* @deprecated 3.3.0 Use WP_Screen::render_per_page_options()
-* @deprecated Use $current_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();
 	if ( ! $current_screen )
 		return '';
 /**
 * Renders the screen's help.
 *
 * @since 2.7.0
-* @deprecated 3.3.0
+* @deprecated 3.3.0 Use WP_Screen::render_screen_meta()
-* @deprecated Use $current_screen->render_screen_meta()
 * @see WP_Screen::render_screen_meta()
 */
 function screen_meta( $screen ) {
 	$current_screen = get_current_screen();
 	$current_screen->render_screen_meta();
 /**
 * 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' );
 }
 /**
 * Add contextual help text for a page.
 *
 * Creates an 'Overview' help tab.
 *
 * @since 2.7.0
-* @deprecated 3.3.0
+* @deprecated 3.3.0 Use WP_Screen::add_help_tab()
-* @deprecated Use get_current_screen()->add_help_tab()
+* @see WP_Screen::add_help_tab()
-* @see WP_Screen
 *
 * @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 );
 	WP_Screen::add_old_compat_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 3.4.0 Use wp_get_themes()
-* @deprecated 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 ) );
 	$wp_themes = array();
 	foreach ( $themes as $theme ) {
 	return $wp_themes;
 }
 /**
-* {@internal Missing Short Description}}
+* Retrieves a list of broken themes.
 *
 * @since 1.5.0
-* @deprecated 3.4.0
+* @deprecated 3.4.0 Use wp_get_themes()
+* @see wp_get_themes()
 *
 * @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();
 	foreach ( $themes as $theme ) {
 		$name = $theme->get('Name');
 	}
 	return $broken;
 }
 /**
-* {@internal Missing Short Description}}
+* Retrieves information on the current active theme.
 *
 * @since 2.0.0
-* @deprecated 3.4.0
+* @deprecated 3.4.0 Use wp_get_theme()
+* @see wp_get_theme()
 *
 * @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 3.5.0 Use get_default_post_to_edit()
-* @deprecated 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';
 	return $page;
 }
 /**
 * 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 3.5.0 Use image_resize()
-* @deprecated 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.
 * @param mixed $deprecated Never used.
 * @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 metabox for the nav menu theme locations.
+* 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' );
+	_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
+* @deprecated 3.7.0 Use Core_Upgrader
 * @see Core_Upgrader
 */
 function wp_update_core($current, $feedback = '') {
-	_deprecated_function( __FUNCTION__, '3.7', 'new Core_Upgrader();' );
+	_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' );
 * 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
+* @deprecated 3.7.0 Use Plugin_Upgrader
 * @see Plugin_Upgrader
 */
 function wp_update_plugin($plugin, $feedback = '') {
-	_deprecated_function( __FUNCTION__, '3.7', 'new Plugin_Upgrader();' );
+	_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' );
 }
 /**
 * This was once used to kick-off the Theme Updater.
 *
-* Deprecated in favor of instantating a Theme_Upgrader instance directly,
+* 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
+* @deprecated 3.7.0 Use Theme_Upgrader
 * @see Theme_Upgrader
 */
 function wp_update_theme($theme, $feedback = '') {
-	_deprecated_function( __FUNCTION__, '3.7', 'new Theme_Upgrader();' );
+	_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' );
 }
 /**
 * 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' );
+	_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
 */
 function screen_icon() {
+	_deprecated_function( __FUNCTION__, '3.8.0' );
 	echo get_screen_icon();
 }
+/**
+* Retrieves the screen icon (no longer used in 3.8+).
+*
+* @since 3.2.0
+* @deprecated 3.8.0
+*
+* @return string An HTML comment explaining that icons are no longer used.
+*/
 function get_screen_icon() {
+	_deprecated_function( __FUNCTION__, '3.8.0' );
 	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() {}
+/**
+* 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() {}
-/**#@-*/
+/**
+* Display plugins text for the WordPress news widget.
+*
+* @since 2.5.0
+* @deprecated 4.8.0
+*
+* @param string $rss  The RSS feed URL.
+* @param array  $args Array of arguments for this RSS feed.
+*/
+function wp_dashboard_plugins_output( $rss, $args = array() ) {
+	_deprecated_function( __FUNCTION__, '4.8.0' );
+	// Plugin feeds plus link to install them
+	$popular = fetch_feed( $args['url']['popular'] );
+	if ( false === $plugin_slugs = get_transient( 'plugin_slugs' ) ) {
+		$plugin_slugs = array_keys( get_plugins() );
+		set_transient( 'plugin_slugs', $plugin_slugs, DAY_IN_SECONDS );
+	}
+	echo '<ul>';
+	foreach ( array( $popular ) as $feed ) {
+		if ( is_wp_error( $feed ) || ! $feed->get_item_quantity() )
+			continue;
+		$items = $feed->get_items(0, 5);
+		// Pick a random, non-installed plugin
+		while ( true ) {
+			// Abort this foreach loop iteration if there's no plugins left of this type
+			if ( 0 == count($items) )
+				continue 2;
+			$item_key = array_rand($items);
+			$item = $items[$item_key];
+			list($link, $frag) = explode( '#', $item->get_link() );
+			$link = esc_url($link);
+			if ( preg_match( '|/([^/]+?)/?$|', $link, $matches ) )
+				$slug = $matches[1];
+			else {
+				unset( $items[$item_key] );
+				continue;
+			}
+			// Is this random plugin's slug already installed? If so, try again.
+			reset( $plugin_slugs );
+			foreach ( $plugin_slugs as $plugin_slug ) {
+				if ( $slug == substr( $plugin_slug, 0, strlen( $slug ) ) ) {
+					unset( $items[$item_key] );
+					continue 2;
+				}
+			}
+			// If we get to this point, then the random plugin isn't installed and we can stop the while().
+			break;
+		}
+		// Eliminate some common badly formed plugin descriptions
+		while ( ( null !== $item_key = array_rand($items) ) && false !== strpos( $items[$item_key]->get_description(), 'Plugin Name:' ) )
+			unset($items[$item_key]);
+		if ( !isset($items[$item_key]) )
+			continue;
+		$raw_title = $item->get_title();
+		$ilink = wp_nonce_url('plugin-install.php?tab=plugin-information&plugin=' . $slug, 'install-plugin_' . $slug) . '&amp;TB_iframe=true&amp;width=600&amp;height=800';
+		echo '<li class="dashboard-news-plugin"><span>' . __( 'Popular Plugin' ) . ':</span> ' . esc_html( $raw_title ) .
+			'&nbsp;<a href="' . $ilink . '" class="thickbox open-plugin-details-modal" aria-label="' .
+			/* translators: %s: plugin name */
+			esc_attr( sprintf( __( 'Install %s' ), $raw_title ) ) . '">(' . __( 'Install' ) . ')</a></li>';
+		$feed->__destruct();
+		unset( $feed );
+	}
+	echo '</ul>';
+}
 /**
 * This was once used to move child posts to a new parent.
 *
 * @since 2.3.0
 *
 * @param int $old_ID
 * @param int $new_ID
 */
 function _relocate_children( $old_ID, $new_ID ) {
-	_deprecated_function( __FUNCTION__, '3.9' );
+	_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
+*
+* @link https://core.trac.wordpress.org/ticket/35852
+*
+* @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"';
+	}
+}
+/**
+* Display JavaScript on the page.
+*
+* @since 3.5.0
+* @deprecated 4.9.0
+*/
+function options_permalink_add_js() {
+	?>
+	<script type="text/javascript">
+		jQuery(document).ready(function() {
+			jQuery('.permalink-structure input:radio').change(function() {
+				if ( 'custom' == this.value )
+					return;
+				jQuery('#permalink_structure').val( this.value );
+			});
+			jQuery( '#permalink_structure' ).on( 'click input', function() {
+				jQuery( '#custom_selection' ).prop( 'checked', true );
+			});
+		});
+	</script>
+	<?php
+}

changeset 7	cf61fcea0001
parent 5	5e2f62d02dcd
child 16	a86126ab1dd4