<?php
/**
* Deprecated admin functions from past WordPress versions. You shouldn't use these
* functions and look for the alternatives instead. The functions will be removed
* in a later version.
*
* @package WordPress
* @subpackage Deprecated
*/
/*
* Deprecated functions come here to die.
*/
/**
* @since 2.1.0
* @deprecated 2.1.0 Use wp_editor()
* @see wp_editor()
*/
function tinymce_include() {
_deprecated_function( __FUNCTION__, '2.1.0', 'wp_editor()' );
wp_tiny_mce();
}
/**
* Unused Admin function.
*
* @since 2.0.0
* @deprecated 2.5.0
*
*/
function documentation_link() {
_deprecated_function( __FUNCTION__, '2.5.0' );
}
/**
* Calculates the new dimensions for a downsampled image.
*
* @since 2.0.0
* @deprecated 3.0.0 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.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 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.0', 'wp_constrain_dimensions()' );
return wp_constrain_dimensions( $width, $height, 128, 96 );
}
/**
* Legacy function used to generate the categories checklist control.
*
* @since 0.71
* @deprecated 2.6.0 Use wp_category_checklist()
* @see wp_category_checklist()
*
* @global int $post_ID
*
* @param int $default_category Unused.
* @param int $category_parent Unused.
* @param array $popular_ids Unused.
*/
function dropdown_categories( $default_category = 0, $category_parent = 0, $popular_ids = array() ) {
_deprecated_function( __FUNCTION__, '2.6.0', 'wp_category_checklist()' );
global $post_ID;
wp_category_checklist( $post_ID );
}
/**
* Legacy function used to generate a link categories checklist control.
*
* @since 2.1.0
* @deprecated 2.6.0 Use wp_link_category_checklist()
* @see wp_link_category_checklist()
*
* @global int $link_id
*
* @param int $default_link_category Unused.
*/
function dropdown_link_categories( $default_link_category = 0 ) {
_deprecated_function( __FUNCTION__, '2.6.0', 'wp_link_category_checklist()' );
global $link_id;
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.0' );
return WP_CONTENT_DIR . $file;
}
/**
* Legacy function used for generating a categories drop-down control.
*
* @since 1.2.0
* @deprecated 3.0.0 Use wp_dropdown_categories()
* @see wp_dropdown_categories()
*
* @param int $current_cat Optional. ID of the current category. Default 0.
* @param int $current_parent Optional. Current parent category ID. Default 0.
* @param int $category_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 void|false Void on success, false if no categories were found.
*/
function wp_dropdown_cats( $current_cat = 0, $current_parent = 0, $category_parent = 0, $level = 0, $categories = 0 ) {
_deprecated_function( __FUNCTION__, '3.0.0', 'wp_dropdown_categories()' );
if (!$categories )
$categories = get_categories( array('hide_empty' => 0) );
if ( $categories ) {
foreach ( $categories as $category ) {
if ( $current_cat != $category->term_id && $category_parent == $category->parent) {
$pad = str_repeat( '– ', $level );
$category->name = esc_html( $category->name );
echo "\n\t<option value='$category->term_id'";
if ( $current_parent == $category->term_id )
echo " selected='selected'";
echo ">$pad$category->name</option>";
wp_dropdown_cats( $current_cat, $current_parent, $category->term_id, $level +1, $categories );
}
}
} else {
return false;
}
}
/**
* Register a setting and its sanitization callback
*
* @since 2.7.0
* @deprecated 3.0.0 Use register_setting()
* @see register_setting()
*
* @param string $option_group A settings group name. Should correspond to an allowed option key name.
* Default allowed option key names include 'general', 'discussion', 'media',
* 'reading', 'writing', and 'options'.
* @param string $option_name The name of an option to sanitize and save.
* @param callable $sanitize_callback Optional. 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.0', 'register_setting()' );
register_setting( $option_group, $option_name, $sanitize_callback );
}
/**
* Unregister a setting
*
* @since 2.7.0
* @deprecated 3.0.0 Use unregister_setting()
* @see unregister_setting()
*
* @param string $option_group The settings group name used during registration.
* @param string $option_name The name of the option to unregister.
* @param callable $sanitize_callback Optional. Deprecated.
*/
function remove_option_update_handler( $option_group, $option_name, $sanitize_callback = '' ) {
_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.
*
* @since 2.8.0
* @deprecated 3.0.0
*
* @param string $filename
**/
function codepress_get_lang( $filename ) {
_deprecated_function( __FUNCTION__, '3.0.0' );
}
/**
* Adds JavaScript required to make CodePress work on the theme/plugin file editors.
*
* @since 2.8.0
* @deprecated 3.0.0
**/
function codepress_footer_js() {
_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.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.0', 'get_users()' );
global $wpdb;
if ( !is_multisite() )
$level_key = $wpdb->get_blog_prefix() . 'user_level';
else
$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) );
}
/**
* 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|false List of editable authors. False if no editable users.
*/
function get_editable_authors( $user_id ) {
_deprecated_function( __FUNCTION__, '3.1.0', 'get_users()' );
global $wpdb;
$editable = get_editable_user_ids( $user_id );
if ( !$editable ) {
return false;
} else {
$editable = join(',', $editable);
$authors = $wpdb->get_results( "SELECT * FROM $wpdb->users WHERE ID IN ($editable) ORDER BY display_name" );
}
return apply_filters('get_editable_authors', $authors);
}
/**
* Gets the IDs of any 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.
* @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.0', 'get_users()' );
global $wpdb;
if ( ! $user = get_userdata( $user_id ) )
return array();
$post_type_obj = get_post_type_object($post_type);
if ( ! $user->has_cap($post_type_obj->cap->edit_others_posts) ) {
if ( $user->has_cap($post_type_obj->cap->edit_posts) || ! $exclude_zeros )
return array($user->ID);
else
return array();
}
if ( !is_multisite() )
$level_key = $wpdb->get_blog_prefix() . 'user_level';
else
$level_key = $wpdb->get_blog_prefix() . 'capabilities'; // WPMU site admins don't have user_levels.
$query = $wpdb->prepare("SELECT user_id FROM $wpdb->usermeta WHERE meta_key = %s", $level_key);
if ( $exclude_zeros )
$query .= " AND meta_value != '0'";
return $wpdb->get_col( $query );
}
/**
* 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.0', 'get_users()' );
global $wpdb;
if ( !is_multisite() )
$level_key = $wpdb->get_blog_prefix() . 'user_level';
else
$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', false ) ) :
/**
* WordPress User Search class.
*
* @since 2.1.0
* @deprecated 3.1.0 Use WP_User_Query
*/
class WP_User_Search {
/**
* {@internal Missing Description}}
*
* @since 2.1.0
* @access private
* @var mixed
*/
var $results;
/**
* {@internal Missing Description}}
*
* @since 2.1.0
* @access private
* @var string
*/
var $search_term;
/**
* Page number.
*
* @since 2.1.0
* @access private
* @var int
*/
var $page;
/**
* Role name that users have.
*
* @since 2.5.0
* @access private
* @var string
*/
var $role;
/**
* Raw page number.
*
* @since 2.1.0
* @access private
* @var int|bool
*/
var $raw_page;
/**
* Amount of users to display per page.
*
* @since 2.1.0
* @access public
* @var int
*/
var $users_per_page = 50;
/**
* {@internal Missing Description}}
*
* @since 2.1.0
* @access private
* @var int
*/
var $first_user;
/**
* {@internal Missing Description}}
*
* @since 2.1.0
* @access private
* @var int
*/
var $last_user;
/**
* {@internal Missing Description}}
*
* @since 2.1.0
* @access private
* @var string
*/
var $query_limit;
/**
* {@internal Missing Description}}
*
* @since 3.0.0
* @access private
* @var string
*/
var $query_orderby;
/**
* {@internal Missing Description}}
*
* @since 3.0.0
* @access private
* @var string
*/
var $query_from;
/**
* {@internal Missing Description}}
*
* @since 3.0.0
* @access private
* @var string
*/
var $query_where;
/**
* {@internal Missing Description}}
*
* @since 2.1.0
* @access private
* @var int
*/
var $total_users_for_query = 0;
/**
* {@internal Missing Description}}
*
* @since 2.1.0
* @access private
* @var bool
*/
var $too_many_total_users = false;
/**
* {@internal Missing Description}}
*
* @since 2.1.0
* @access private
* @var WP_Error
*/
var $search_errors;
/**
* {@internal Missing Description}}
*
* @since 2.7.0
* @access private
* @var string
*/
var $paging_text;
/**
* 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 __construct( $search_term = '', $page = '', $role = '' ) {
_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 = ( '' == $page ) ? 1 : (int) $page;
$this->role = $role;
$this->prepare_query();
$this->query();
$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 );
}
/**
* Prepares the user search query (legacy).
*
* @since 2.1.0
* @access public
*/
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';
$search_sql = '';
if ( $this->search_term ) {
$searches = array();
$search_sql = 'AND (';
foreach ( array('user_login', 'user_nicename', 'user_email', 'user_url', 'display_name') as $col )
$searches[] = $wpdb->prepare( $col . ' LIKE %s', '%' . like_escape($this->search_term) . '%' );
$search_sql .= implode(' OR ', $searches);
$search_sql .= ')';
}
$this->query_from = " FROM $wpdb->users";
$this->query_where = " WHERE 1=1 $search_sql";
if ( $this->role ) {
$this->query_from .= " INNER JOIN $wpdb->usermeta ON $wpdb->users.ID = $wpdb->usermeta.user_id";
$this->query_where .= $wpdb->prepare(" AND $wpdb->usermeta.meta_key = '{$wpdb->prefix}capabilities' AND $wpdb->usermeta.meta_value LIKE %s", '%' . $this->role . '%');
} elseif ( is_multisite() ) {
$level_key = $wpdb->prefix . 'capabilities'; // WPMU site admins don't have user_levels.
$this->query_from .= ", $wpdb->usermeta";
$this->query_where .= " AND $wpdb->users.ID = $wpdb->usermeta.user_id AND meta_key = '{$level_key}'";
}
do_action_ref_array( 'pre_user_search', array( &$this ) );
}
/**
* Executes the user search query.
*
* @since 2.1.0
* @access public
*/
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 )
$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 users found.'));
}
/**
* Prepares variables for use in templates.
*
* @since 2.1.0
* @access public
*/
function prepare_vars_for_template_usage() {}
/**
* Handles paging for the user search query.
*
* @since 2.1.0
* @access public
*/
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) )
$args['usersearch'] = urlencode($this->search_term);
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,
'base' => 'users.php?%_%',
'format' => 'userspage=%#%',
'add_args' => $args
) );
if ( $this->paging_text ) {
$this->paging_text = sprintf(
/* translators: 1: Starting number of users on the current page, 2: Ending number of users, 3: Total number of users. */
'<span class="displaying-num">' . __( 'Displaying %1$s–%2$s of %3$s' ) . '</span>%s',
number_format_i18n( ( $this->page - 1 ) * $this->users_per_page + 1 ),
number_format_i18n( min( $this->page * $this->users_per_page, $this->total_users_for_query ) ),
number_format_i18n( $this->total_users_for_query ),
$this->paging_text
);
}
}
}
/**
* Retrieves the user search query results.
*
* @since 2.1.0
* @access public
*
* @return array
*/
public function get_results() {
return (array) $this->results;
}
/**
* Displaying paging text.
*
* @see do_paging() Builds paging text.
*
* @since 2.1.0
* @access public
*/
function page_links() {
echo $this->paging_text;
}
/**
* Whether paging is enabled.
*
* @see do_paging() Builds paging text.
*
* @since 2.1.0
* @access public
*
* @return bool
*/
function results_are_paged() {
if ( $this->paging_text )
return true;
return false;
}
/**
* Whether there are search terms.
*
* @since 2.1.0
* @access public
*
* @return bool
*/
function is_search() {
if ( $this->search_term )
return true;
return false;
}
}
endif;
/**
* Retrieves editable posts from other users.
*
* @since 2.3.0
* @deprecated 3.1.0 Use get_posts()
* @see get_posts()
*
* @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' ) {
_deprecated_function( __FUNCTION__, '3.1.0' );
global $wpdb;
$editable = get_editable_user_ids( $user_id );
if ( in_array($type, array('draft', 'pending')) )
$type_sql = " post_status = '$type' ";
else
$type_sql = " ( post_status = 'draft' OR post_status = 'pending' ) ";
$dir = ( 'pending' == $type ) ? 'ASC' : 'DESC';
if ( !$editable ) {
$other_unpubs = '';
} else {
$editable = join(',', $editable);
$other_unpubs = $wpdb->get_results( $wpdb->prepare("SELECT ID, post_title, post_author FROM $wpdb->posts WHERE post_type = 'post' AND $type_sql AND post_author IN ($editable) AND post_author != %d ORDER BY post_modified $dir", $user_id) );
}
return apply_filters('get_others_drafts', $other_unpubs);
}
/**
* Retrieve drafts from other users.
*
* @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.0' );
return get_others_unpublished_posts($user_id, 'draft');
}
/**
* Retrieve pending review posts from other users.
*
* @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.0' );
return get_others_unpublished_posts($user_id, 'pending');
}
/**
* Output the QuickPress dashboard widget.
*
* @since 3.0.0
* @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.0', 'wp_dashboard_quick_press()' );
wp_dashboard_quick_press();
}
/**
* Outputs the TinyMCE editor.
*
* @since 2.7.0
* @deprecated 3.3.0 Use wp_editor()
* @see wp_editor()
*/
function wp_tiny_mce( $teeny = false, $settings = false ) {
_deprecated_function( __FUNCTION__, '3.3.0', 'wp_editor()' );
static $num = 1;
if ( ! class_exists( '_WP_Editors', false ) )
require_once ABSPATH . WPINC . '/class-wp-editor.php';
$editor_id = 'content' . $num++;
$set = array(
'teeny' => $teeny,
'tinymce' => $settings ? $settings : true,
'quicktags' => false
);
$set = _WP_Editors::parse_settings($editor_id, $set);
_WP_Editors::editor_settings($editor_id, $set);
}
/**
* Preloads TinyMCE dialogs.
*
* @deprecated 3.3.0 Use wp_editor()
* @see wp_editor()
*/
function wp_preload_dialogs() {
_deprecated_function( __FUNCTION__, '3.3.0', '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.0', 'wp_editor()' );
}
/**
* Handles quicktags.
*
* @deprecated 3.3.0 Use wp_editor()
* @see wp_editor()
*/
function wp_quicktags() {
_deprecated_function( __FUNCTION__, '3.3.0', 'wp_editor()' );
}
/**
* Returns the screen layout options.
*
* @since 2.8.0
* @deprecated 3.3.0 WP_Screen::render_screen_layout()
* @see WP_Screen::render_screen_layout()
*/
function screen_layout( $screen ) {
_deprecated_function( __FUNCTION__, '3.3.0', '$current_screen->render_screen_layout()' );
$current_screen = get_current_screen();
if ( ! $current_screen )
return '';
ob_start();
$current_screen->render_screen_layout();
return ob_get_clean();
}
/**
* Returns the screen's per-page options.
*
* @since 2.8.0
* @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.0', '$current_screen->render_per_page_options()' );
$current_screen = get_current_screen();
if ( ! $current_screen )
return '';
ob_start();
$current_screen->render_per_page_options();
return ob_get_clean();
}
/**
* Renders the screen's help.
*
* @since 2.7.0
* @deprecated 3.3.0 Use WP_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 Use WP_Admin_Bar
* @see WP_Admin_Bar
*/
function favorite_actions() {
_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.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.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.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.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.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.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.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.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 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.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 site.
*
* @since 3.0.0
* @deprecated 3.4.0 Use wp_get_themes()
* @see wp_get_themes()
*
* @return WP_Theme[] Array of WP_Theme objects keyed by their name.
*/
function get_allowed_themes() {
_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 ) {
$wp_themes[ $theme->get('Name') ] = $theme;
}
return $wp_themes;
}
/**
* Retrieves a list of broken themes.
*
* @since 1.5.0
* @deprecated 3.4.0 Use wp_get_themes()
* @see wp_get_themes()
*
* @return array
*/
function get_broken_themes() {
_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');
$broken[ $name ] = array(
'Name' => $name,
'Title' => $name,
'Description' => $theme->errors()->get_error_message(),
);
}
return $broken;
}
/**
* Retrieves information on the current active theme.
*
* @since 2.0.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.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.
*
* @deprecated 3.5.0
*/
function _insert_into_post_button( $type ) {
_deprecated_function( __FUNCTION__, '3.5.0' );
}
/**
* 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.0' );
}
/**
* Gets an existing post and format it for editing.
*
* @since 2.0.0
* @deprecated 3.5.0 Use get_post()
* @see get_post()
*
* @param int $id
* @return WP_Post
*/
function get_post_to_edit( $id ) {
_deprecated_function( __FUNCTION__, '3.5.0', 'get_post()' );
return get_post( $id, OBJECT, 'edit' );
}
/**
* Gets the default page information to use.
*
* @since 2.5.0
* @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.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 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.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);
require 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);
require 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);
require 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
* @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) . '&TB_iframe=true&width=600&height=800';
echo '<li class="dashboard-news-plugin"><span>' . __( 'Popular Plugin' ) . ':</span> ' . esc_html( $raw_title ) .
' <a href="' . $ilink . '" class="thickbox open-plugin-details-modal" aria-label="' .
/* translators: %s: Plugin name. */
esc_attr( sprintf( _x( 'Install %s', 'plugin' ), $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
* @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 $callback Optional. The function to be called to output the content for this page.
* @param string $icon_url Optional. 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, $callback = '', $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, $callback, $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 $callback Optional. The function to be called to output the content for this page.
* @param string $icon_url Optional. 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, $callback = '', $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, $callback, $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( 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
}
/**
* Previous class for list table for privacy data export requests.
*
* @since 4.9.6
* @deprecated 5.3.0
*/
class WP_Privacy_Data_Export_Requests_Table extends WP_Privacy_Data_Export_Requests_List_Table {
function __construct( $args ) {
_deprecated_function( __CLASS__, '5.3.0', 'WP_Privacy_Data_Export_Requests_List_Table' );
if ( ! isset( $args['screen'] ) || $args['screen'] === 'export_personal_data' ) {
$args['screen'] = 'export-personal-data';
}
parent::__construct( $args );
}
}
/**
* Previous class for list table for privacy data erasure requests.
*
* @since 4.9.6
* @deprecated 5.3.0
*/
class WP_Privacy_Data_Removal_Requests_Table extends WP_Privacy_Data_Removal_Requests_List_Table {
function __construct( $args ) {
_deprecated_function( __CLASS__, '5.3.0', 'WP_Privacy_Data_Removal_Requests_List_Table' );
if ( ! isset( $args['screen'] ) || $args['screen'] === 'remove_personal_data' ) {
$args['screen'] = 'erase-personal-data';
}
parent::__construct( $args );
}
}
/**
* Was used to add options for the privacy requests screens before they were separate files.
*
* @since 4.9.8
* @access private
* @deprecated 5.3.0
*/
function _wp_privacy_requests_screen_options() {
_deprecated_function( __FUNCTION__, '5.3.0' );
}
/**
* Was used to filter input from media_upload_form_handler() and to assign a default
* post_title from the file name if none supplied.
*
* @since 2.5.0
* @deprecated 6.0.0
*
* @param array $post The WP_Post attachment object converted to an array.
* @param array $attachment An array of attachment metadata.
* @return array Attachment post object converted to an array.
*/
function image_attachment_fields_to_save( $post, $attachment ) {
_deprecated_function( __FUNCTION__, '6.0.0' );
return $post;
}