Summery Summery
Generic Skin for the WordPress Upgrader classes. This skin is designed to be extended for specific purposes.
Syntax Syntax
Source Source
File: wp-admin/includes/class-wp-upgrader-skin.php
class WP_Upgrader_Skin { /** * Holds the upgrader data. * * @since 2.8.0 * * @var object */ public $upgrader; /** * Whether header is done. * * @since 2.8.0 * * @var bool */ public $done_header = false; /** * Whether footer is done. * * @since 2.8.0 * * @var bool */ public $done_footer = false; /** * Holds the result of an upgrade. * * @since 2.8.0 * * @var string|bool|WP_Error */ public $result = false; /** * Holds the options of an upgrade. * * @since 2.8.0 * * @var array */ public $options = array(); /** * Constructor. * * Sets up the generic skin for the WordPress Upgrader classes. * * @since 2.8.0 * * @param array $args Optional. The WordPress upgrader skin arguments to * override default options. Default empty array. */ public function __construct( $args = array() ) { $defaults = array( 'url' => '', 'nonce' => '', 'title' => '', 'context' => false, ); $this->options = wp_parse_args( $args, $defaults ); } /** * @param WP_Upgrader $upgrader */ public function set_upgrader( &$upgrader ) { if ( is_object( $upgrader ) ) { $this->upgrader =& $upgrader; } $this->add_strings(); } /** */ public function add_strings() { } /** * Sets the result of an upgrade. * * @since 2.8.0 * * @param string|bool|WP_Error $result The result of an upgrade. */ public function set_result( $result ) { $this->result = $result; } /** * Displays a form to the user to request for their FTP/SSH details in order * to connect to the filesystem. * * @since 2.8.0 * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string. * * @see request_filesystem_credentials() * * @param bool|WP_Error $error Optional. Whether the current request has failed to connect, * or an error object. Default false. * @param string $context Optional. Full path to the directory that is tested * for being writable. Default empty. * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false. * @return bool True on success, false on failure. */ public function request_filesystem_credentials( $error = false, $context = '', $allow_relaxed_file_ownership = false ) { $url = $this->options['url']; if ( ! $context ) { $context = $this->options['context']; } if ( ! empty( $this->options['nonce'] ) ) { $url = wp_nonce_url( $url, $this->options['nonce'] ); } $extra_fields = array(); return request_filesystem_credentials( $url, '', $error, $context, $extra_fields, $allow_relaxed_file_ownership ); } /** */ public function header() { if ( $this->done_header ) { return; } $this->done_header = true; echo '<div class="wrap">'; echo '<h1>' . $this->options['title'] . '</h1>'; } /** */ public function footer() { if ( $this->done_footer ) { return; } $this->done_footer = true; echo '</div>'; } /** * @param string|WP_Error $errors */ public function error( $errors ) { if ( ! $this->done_header ) { $this->header(); } if ( is_string( $errors ) ) { $this->feedback( $errors ); } elseif ( is_wp_error( $errors ) && $errors->has_errors() ) { foreach ( $errors->get_error_messages() as $message ) { if ( $errors->get_error_data() && is_string( $errors->get_error_data() ) ) { $this->feedback( $message . ' ' . esc_html( strip_tags( $errors->get_error_data() ) ) ); } else { $this->feedback( $message ); } } } } /** * @param string $string * @param mixed ...$args Optional text replacements. */ public function feedback( $string, ...$args ) { if ( isset( $this->upgrader->strings[ $string ] ) ) { $string = $this->upgrader->strings[ $string ]; } if ( strpos( $string, '%' ) !== false ) { if ( $args ) { $args = array_map( 'strip_tags', $args ); $args = array_map( 'esc_html', $args ); $string = vsprintf( $string, $args ); } } if ( empty( $string ) ) { return; } show_message( $string ); } /** * Action to perform before an update. * * @since 2.8.0 */ public function before() {} /**
Advertisement
Changelog Changelog
Version | Description |
---|---|
4.6.0 | Moved to its own file from wp-admin/includes/class-wp-upgrader-skins.php. |
2.8.0 | Introduced. |