PHPXRef 0.7.1 : WordPress : Detail view of class-wp-upgrader-skin.php

Upgrader API: WP_Upgrader_Skin class

File Size:	277 lines (6 kb)
Included or required:	0 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
since: 2.8.0

set_upgrader( &$upgrader ) X-Ref

param: WP_Upgrader $upgrader
since: 2.8.0

add_strings() X-Ref

since: 3.0.0

set_result( $result ) X-Ref

Sets the result of an upgrade.

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

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.

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.
return: bool True on success, false on failure.
since: 2.8.0
since: 4.6.0 The `$context` parameter default changed from `false` to an empty string.

header() X-Ref

since: 2.8.0

footer() X-Ref

since: 2.8.0

error( $errors ) X-Ref

param: string|WP_Error $errors Errors.
since: 2.8.0

feedback( $feedback, ...$args ) X-Ref

param: string $feedback Message data.
param: mixed ...$args Optional text replacements.
since: 2.8.0
since: 5.9.0 Renamed `$string` (a PHP reserved keyword) to `$feedback` for PHP 8 named parameter support.

before() X-Ref

Action to perform before an update.

since: 2.8.0

after() X-Ref

Action to perform following an update.

since: 2.8.0

decrement_update_count( $type ) X-Ref

Output JavaScript that calls function to decrement the update counts.

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

bulk_header() X-Ref

since: 3.0.0

bulk_footer() X-Ref

since: 3.0.0

hide_process_failed( $wp_error ) X-Ref

Hides the `process_failed` error message when updating by uploading a zip file.

param: WP_Error $wp_error WP_Error object.
return: bool
since: 5.5.0

PHP Cross Reference of WordPress

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

Defines 1 class