[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

title

Body

[close]

/wp-admin/includes/ -> deprecated.php (summary)

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.

File Size: 1565 lines (41 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 1 file
 wp-admin/includes/class-wp-upgrader.php

Defines 3 classes

WP_User_Search:: (61 methods):
  __construct()
  WP_User_Search()
  prepare_query()
  query()
  prepare_vars_for_template_usage()
  do_paging()
  get_results()
  page_links()
  results_are_paged()
  is_search()
  get_others_unpublished_posts()
  get_others_drafts()
  get_others_pending()
  wp_dashboard_quick_press_output()
  wp_tiny_mce()
  wp_preload_dialogs()
  wp_print_editor_js()
  wp_quicktags()
  screen_layout()
  screen_options()
  screen_meta()
  favorite_actions()
  media_upload_image()
  media_upload_audio()
  media_upload_video()
  media_upload_file()
  type_url_form_image()
  type_url_form_audio()
  type_url_form_video()
  type_url_form_file()
  add_contextual_help()
  get_allowed_themes()
  get_broken_themes()
  current_theme_info()
  _insert_into_post_button()
  _media_button()
  get_post_to_edit()
  get_default_page_to_edit()
  wp_create_thumbnail()
  wp_nav_menu_locations_meta_box()
  wp_update_core()
  wp_update_plugin()
  wp_update_theme()
  the_attachment_links()
  screen_icon()
  get_screen_icon()
  wp_dashboard_incoming_links_output()
  wp_dashboard_secondary_output()
  wp_dashboard_incoming_links()
  wp_dashboard_incoming_links_control()
  wp_dashboard_plugins()
  wp_dashboard_primary_control()
  wp_dashboard_recent_comments_control()
  wp_dashboard_secondary()
  wp_dashboard_secondary_control()
  wp_dashboard_plugins_output()
  _relocate_children()
  add_object_page()
  add_utility_page()
  post_form_autocomplete_off()
  options_permalink_add_js()

WP_Privacy_Data_Export_Requests_Table:: (1 method):
  __construct()

WP_Privacy_Data_Removal_Requests_Table:: (2 methods):
  __construct()
  _wp_privacy_requests_screen_options()

Defines 2 functions

  tinymce_include()
  documentation_link()
  wp_shrink_dimensions()
  get_udims()
  dropdown_categories()
  dropdown_link_categories()
  get_real_file_to_edit()
  wp_dropdown_cats()
  add_option_update_handler()
  remove_option_update_handler()
  codepress_get_lang()
  codepress_footer_js()
  use_codepress()
  get_author_user_ids()
  get_editable_authors()
  get_editable_user_ids()
  get_nonauthor_user_ids()

Class: WP_User_Search  - X-Ref

WordPress User Search class.

__construct( $search_term = '', $page = '', $role = '' )   X-Ref
PHP5 Constructor - Sets up the object properties.

param: string $search_term Search terms string.
param: int $page Optional. Page ID.
param: string $role Role name.
return: WP_User_Search

WP_User_Search( $search_term = '', $page = '', $role = '' )   X-Ref
PHP4 Constructor - Sets up the object properties.

param: string $search_term Search terms string.
param: int $page Optional. Page ID.
param: string $role Role name.
return: WP_User_Search

prepare_query()   X-Ref
Prepares the user search query (legacy).


query()   X-Ref
Executes the user search query.


prepare_vars_for_template_usage()   X-Ref
Prepares variables for use in templates.


do_paging()   X-Ref
Handles paging for the user search query.


get_results()   X-Ref
Retrieves the user search query results.

return: array

page_links()   X-Ref
Displaying paging text.


results_are_paged()   X-Ref
Whether paging is enabled.

return: bool

is_search()   X-Ref
Whether there are search terms.

return: bool

get_others_unpublished_posts( $user_id, $type = 'any' )   X-Ref
Retrieves editable posts from other users.

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).
return: array List of posts from others.

get_others_drafts($user_id)   X-Ref
Retrieve drafts from other users.

param: int $user_id User ID.
return: array List of drafts from other users.

get_others_pending($user_id)   X-Ref
Retrieve pending review posts from other users.

param: int $user_id User ID.
return: array List of posts with pending review post type from other users.

wp_dashboard_quick_press_output()   X-Ref
Output the QuickPress dashboard widget.


wp_tiny_mce( $teeny = false, $settings = false )   X-Ref
Outputs the TinyMCE editor.


wp_preload_dialogs()   X-Ref
Preloads TinyMCE dialogs.


wp_print_editor_js()   X-Ref
Prints TinyMCE editor JS.


wp_quicktags()   X-Ref
Handles quicktags.


screen_layout( $screen )   X-Ref
Returns the screen layout options.


screen_options( $screen )   X-Ref
Returns the screen's per-page options.


screen_meta( $screen )   X-Ref
Renders the screen's help.


favorite_actions()   X-Ref
Favorite actions were deprecated in version 3.2. Use the admin bar instead.


media_upload_image()   X-Ref
Handles uploading an image.

return: null|string

media_upload_audio()   X-Ref
Handles uploading an audio file.

return: null|string

media_upload_video()   X-Ref
Handles uploading a video file.

return: null|string

media_upload_file()   X-Ref
Handles uploading a generic file.

return: null|string

type_url_form_image()   X-Ref
Handles retrieving the insert-from-URL form for an image.

return: string

type_url_form_audio()   X-Ref
Handles retrieving the insert-from-URL form for an audio file.

return: string

type_url_form_video()   X-Ref
Handles retrieving the insert-from-URL form for a video file.

return: string

type_url_form_file()   X-Ref
Handles retrieving the insert-from-URL form for a generic file.

return: string

add_contextual_help( $screen, $help )   X-Ref
Add contextual help text for a page.

Creates an 'Overview' 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.

get_allowed_themes()   X-Ref
Get the allowed themes for the current site.

return: array $themes Array of allowed themes.

get_broken_themes()   X-Ref
Retrieves a list of broken themes.

return: array

current_theme_info()   X-Ref
Retrieves information on the current active theme.

return: WP_Theme

_insert_into_post_button( $type )   X-Ref
This was once used to display an 'Insert into Post' button.

Now it is deprecated and stubbed.


_media_button($title, $icon, $type, $id)   X-Ref
This was once used to display a media button.

Now it is deprecated and stubbed.


get_post_to_edit( $id )   X-Ref
Gets an existing post and format it for editing.

param: int $id
return: object

get_default_page_to_edit()   X-Ref
Gets the default page information to use.

return: WP_Post Post object containing all the default post data as attributes

wp_create_thumbnail( $file, $max_side, $deprecated = '' )   X-Ref
This was once used to create a thumbnail from an Image given a maximum side size.

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.

wp_nav_menu_locations_meta_box()   X-Ref
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.


wp_update_core($current, $feedback = '')   X-Ref
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.


wp_update_plugin($plugin, $feedback = '')   X-Ref
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.


wp_update_theme($theme, $feedback = '')   X-Ref
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.


the_attachment_links( $id = false )   X-Ref
This was once used to display attachment links. Now it is deprecated and stubbed.

param: int|bool $id

screen_icon()   X-Ref
Displays a screen icon.


get_screen_icon()   X-Ref
Retrieves the screen icon (no longer used in 3.8+).

return: string An HTML comment explaining that icons are no longer used.

wp_dashboard_incoming_links_output()   X-Ref
Deprecated dashboard widget controls.


wp_dashboard_secondary_output()   X-Ref
Deprecated dashboard secondary output.


wp_dashboard_incoming_links()   X-Ref
Deprecated dashboard widget controls.


wp_dashboard_incoming_links_control()   X-Ref
Deprecated dashboard incoming links control.


wp_dashboard_plugins()   X-Ref
Deprecated dashboard plugins control.


wp_dashboard_primary_control()   X-Ref
Deprecated dashboard primary control.


wp_dashboard_recent_comments_control()   X-Ref
Deprecated dashboard recent comments control.


wp_dashboard_secondary()   X-Ref
Deprecated dashboard secondary section.


wp_dashboard_secondary_control()   X-Ref
Deprecated dashboard secondary control.


wp_dashboard_plugins_output( $rss, $args = array()   X-Ref
Display plugins text for the WordPress news widget.

param: string $rss  The RSS feed URL.
param: array  $args Array of arguments for this RSS feed.

_relocate_children( $old_ID, $new_ID )   X-Ref
This was once used to move child posts to a new parent.

param: int $old_ID
param: int $new_ID

add_object_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '')   X-Ref
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.

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.

add_utility_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '')   X-Ref
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.

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.

post_form_autocomplete_off()   X-Ref
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.


options_permalink_add_js()   X-Ref
Display JavaScript on the page.


Class: WP_Privacy_Data_Export_Requests_Table  - X-Ref

Previous class for list table for privacy data export requests.

__construct( $args )   X-Ref
No description

Class: WP_Privacy_Data_Removal_Requests_Table  - X-Ref

Previous class for list table for privacy data erasure requests.

__construct( $args )   X-Ref
No description

_wp_privacy_requests_screen_options()   X-Ref
Was used to add options for the privacy requests screens before they were separate files.


Functions
Functions that are not part of a class:

tinymce_include()   X-Ref


documentation_link()   X-Ref
Unused Admin function.


wp_shrink_dimensions( $width, $height, $wmax = 128, $hmax = 96 )   X-Ref
Calculates the new dimensions for a downsampled image.

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).

get_udims( $width, $height )   X-Ref
Calculated the new dimensions for a downsampled image.

param: int $width Current width of the image
param: int $height Current height of the image
return: array Shrunk dimensions (width, height).

dropdown_categories( $default = 0, $parent = 0, $popular_ids = array()   X-Ref
Legacy function used to generate the categories checklist control.

param: int $default       Unused.
param: int $parent        Unused.
param: array $popular_ids Unused.

dropdown_link_categories( $default = 0 )   X-Ref
Legacy function used to generate a link categories checklist control.

param: int $default Unused.

get_real_file_to_edit( $file )   X-Ref
Get the real filesystem path to a file to edit within the admin.

param: string $file Filesystem path relative to the wp-content directory.
return: string Full filesystem path to edit.

wp_dropdown_cats( $currentcat = 0, $currentparent = 0, $parent = 0, $level = 0, $categories = 0 )   X-Ref
Legacy function used for generating a categories drop-down control.

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.

add_option_update_handler( $option_group, $option_name, $sanitize_callback = '' )   X-Ref
Register a setting and its sanitization callback

param: string $option_group A settings group name. Should correspond to a whitelisted option key name.
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.

remove_option_update_handler( $option_group, $option_name, $sanitize_callback = '' )   X-Ref
Unregister a setting

param: string $option_group
param: string $option_name
param: callable $sanitize_callback

codepress_get_lang( $filename )   X-Ref
Determines the language to use for CodePress syntax highlighting.

param: string $filename

codepress_footer_js()   X-Ref
Adds JavaScript required to make CodePress work on the theme/plugin editors.


use_codepress()   X-Ref
Determine whether to use CodePress.


get_author_user_ids()   X-Ref
Get all user IDs.

return: array List of user IDs.

get_editable_authors( $user_id )   X-Ref
Gets author users who can edit posts.

param: int $user_id User ID.
return: array|bool List of editable authors. False if no editable users.

get_editable_user_ids( $user_id, $exclude_zeros = true, $post_type = 'post' )   X-Ref
Gets the IDs of any users who can edit posts.

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.

get_nonauthor_user_ids()   X-Ref
Gets all users who are not authors.




Generated: Sun Oct 13 08:20:02 2019 Cross-referenced by PHPXref 0.7