[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-admin/includes/ -> class-wp-upgrader-skin.php (summary)

Upgrader API: WP_Upgrader_Skin class

File Size: 296 lines (7 kb)
Included or required: 2 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

WP_Upgrader_Skin:: (15 methods):
  __construct()
  set_upgrader()
  add_strings()
  set_result()
  request_filesystem_credentials()
  header()
  footer()
  error()
  feedback()
  before()
  after()
  decrement_update_count()
  bulk_header()
  bulk_footer()
  hide_process_failed()


Class: WP_Upgrader_Skin  - X-Ref

Generic Skin for the WordPress Upgrader classes. This skin is designed to be extended for specific purposes.

__construct( $args = array()   X-Ref
Constructor.

Sets up the generic skin for the WordPress Upgrader classes.

param: array $args Optional. The WordPress upgrader skin arguments to

set_upgrader( &$upgrader )   X-Ref
Sets the relationship between the skin being used and the upgrader.

param: WP_Upgrader $upgrader

add_strings()   X-Ref
Sets up the strings used in the update process.


set_result( $result )   X-Ref
Sets the result of an upgrade.

param: string|bool|WP_Error $result The result of an upgrade.

request_filesystem_credentials( $error = false, $context = '', $allow_relaxed_file_ownership = false )   X-Ref
Displays a form to the user to request for their FTP/SSH details in order
to connect to the filesystem.

return: bool True on success, false on failure.
param: bool|WP_Error $error                        Optional. Whether the current request has failed to connect,
param: string        $context                      Optional. Full path to the directory that is tested
param: bool          $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.

header()   X-Ref
Displays the header before the update process.


footer()   X-Ref
Displays the footer following the update process.


error( $errors )   X-Ref
Displays an error message about the update.

param: string|WP_Error $errors Errors.

feedback( $feedback, ...$args )   X-Ref
Displays a message about the update.

param: string $feedback Message data.
param: mixed  ...$args  Optional text replacements.

before()   X-Ref
Performs an action before an update.


after()   X-Ref
Performs an action following an update.


decrement_update_count( $type )   X-Ref
Outputs JavaScript that calls function to decrement the update counts.

param: string $type Type of update count to decrement. Likely values include 'plugin',

bulk_header()   X-Ref
Displays the header before the bulk update process.


bulk_footer()   X-Ref
Displays the footer following the bulk update process.


hide_process_failed( $wp_error )   X-Ref
Hides the `process_failed` error message when updating by uploading a zip file.

return: bool True if the error should be hidden, false otherwise.
param: WP_Error $wp_error WP_Error object.



Generated : Sat Dec 21 08:20:01 2024 Cross-referenced by PHPXref