Title: WP_Upgrader_Skin Published: April 25, 2014 Last modified: April 28, 2025 --- # class WP_Upgrader_Skin {} ## In this article * [Methods](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/?output_format=md#methods) * [Source](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/?output_format=md#source) * [Related](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/?output_format=md#related) * [Changelog](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/?output_format=md#changelog) [ Back to top](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/?output_format=md#wp--skip-link--target) Generic Skin for the WordPress Upgrader classes. This skin is designed to be extended for specific purposes. ## 󠀁[Methods](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/?output_format=md#methods)󠁿 | Name | Description | | [WP_Upgrader_Skin::__construct](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/__construct/) | Constructor. | | [WP_Upgrader_Skin::add_strings](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/add_strings/) | Sets up the strings used in the update process. | | [WP_Upgrader_Skin::after](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/after/) | Performs an action following an update. | | [WP_Upgrader_Skin::before](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/before/) | Performs an action before an update. | | [WP_Upgrader_Skin::bulk_footer](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/bulk_footer/) | Displays the footer following the bulk update process. | | [WP_Upgrader_Skin::bulk_header](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/bulk_header/) | Displays the header before the bulk update process. | | [WP_Upgrader_Skin::decrement_update_count](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/decrement_update_count/) | Outputs JavaScript that calls function to decrement the update counts. | | [WP_Upgrader_Skin::error](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/error/) | Displays an error message about the update. | | [WP_Upgrader_Skin::feedback](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/feedback/) | Displays a message about the update. | | [WP_Upgrader_Skin::footer](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/footer/) | Displays the footer following the update process. | | [WP_Upgrader_Skin::header](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/header/) | Displays the header before the update process. | | [WP_Upgrader_Skin::hide_process_failed](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/hide_process_failed/) | Hides the `process_failed` error message when updating by uploading a zip file. | | [WP_Upgrader_Skin::request_filesystem_credentials](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/request_filesystem_credentials/) | Displays a form to the user to request for their FTP/SSH details in order to connect to the filesystem. | | [WP_Upgrader_Skin::set_result](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/set_result/) | Sets the result of an upgrade. | | [WP_Upgrader_Skin::set_upgrader](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/set_upgrader/) | Sets the relationship between the skin being used and the upgrader. | ## 󠀁[Source](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/?output_format=md#source)󠁿 ```php class WP_Upgrader_Skin { /** * Holds the upgrader data. * * @since 2.8.0 * @var WP_Upgrader */ 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 ); } /** * Sets the relationship between the skin being used and the upgrader. * * @since 2.8.0 * * @param WP_Upgrader $upgrader */ public function set_upgrader( &$upgrader ) { if ( is_object( $upgrader ) ) { $this->upgrader =& $upgrader; } $this->add_strings(); } /** * Sets up the strings used in the update process. * * @since 3.0.0 */ 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 ); } /** * Displays the header before the update process. * * @since 2.8.0 */ public function header() { if ( $this->done_header ) { return; } $this->done_header = true; echo '
'; echo '

' . $this->options['title'] . '

'; } /** * Displays the footer following the update process. * * @since 2.8.0 */ public function footer() { if ( $this->done_footer ) { return; } $this->done_footer = true; echo '
'; } /** * Displays an error message about the update. * * @since 2.8.0 * * @param string|WP_Error $errors 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 ); } } } } /** * Displays a message about the update. * * @since 2.8.0 * @since 5.9.0 Renamed `$string` (a PHP reserved keyword) to `$feedback` for PHP 8 named parameter support. * * @param string $feedback Message data. * @param mixed ...$args Optional text replacements. */ public function feedback( $feedback, ...$args ) { if ( isset( $this->upgrader->strings[ $feedback ] ) ) { $feedback = $this->upgrader->strings[ $feedback ]; } if ( str_contains( $feedback, '%' ) ) { if ( $args ) { $args = array_map( 'strip_tags', $args ); $args = array_map( 'esc_html', $args ); $feedback = vsprintf( $feedback, $args ); } } if ( empty( $feedback ) ) { return; } show_message( $feedback ); } /** * Performs an action before an update. * * @since 2.8.0 */ public function before() {} /** * Performs an action following an update. * * @since 2.8.0 */ public function after() {} /** * Outputs JavaScript that calls function to decrement the update counts. * * @since 3.9.0 * * @param string $type Type of update count to decrement. Likely values include 'plugin', * 'theme', 'translation', etc. */ protected function decrement_update_count( $type ) { if ( ! $this->result || is_wp_error( $this->result ) || 'up_to_date' === $this->result ) { return; } if ( defined( 'IFRAME_REQUEST' ) ) { echo ''; } else { echo ''; } } /** * Displays the header before the bulk update process. * * @since 3.0.0 */ public function bulk_header() {} /** * Displays the footer following the bulk update process. * * @since 3.0.0 */ public function bulk_footer() {} /** * Hides the `process_failed` error message when updating by uploading a zip file. * * @since 5.5.0 * * @param WP_Error $wp_error WP_Error object. * @return bool True if the error should be hidden, false otherwise. */ public function hide_process_failed( $wp_error ) { return false; } } ``` [View all references](https://developer.wordpress.org/reference/files/wp-admin/includes/class-wp-upgrader-skin.php/) [View on Trac](https://core.trac.wordpress.org/browser/tags/6.9.4/src/wp-admin/includes/class-wp-upgrader-skin.php#L17) [View on GitHub](https://github.com/WordPress/wordpress-develop/blob/6.9.4/src/wp-admin/includes/class-wp-upgrader-skin.php#L17-L296) ## 󠀁[Related](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/?output_format=md#related)󠁿 | Used by | Description | | [Language_Pack_Upgrader_Skin](https://developer.wordpress.org/reference/classes/language_pack_upgrader_skin/)`wp-admin/includes/class-language-pack-upgrader-skin.php` | Translation Upgrader Skin for WordPress Translation Upgrades. | | [Automatic_Upgrader_Skin](https://developer.wordpress.org/reference/classes/automatic_upgrader_skin/)`wp-admin/includes/class-automatic-upgrader-skin.php` | Upgrader Skin for Automatic WordPress Upgrades. | | [Theme_Upgrader_Skin](https://developer.wordpress.org/reference/classes/theme_upgrader_skin/)`wp-admin/includes/class-theme-upgrader-skin.php` | Theme Upgrader Skin for WordPress Theme Upgrades. | | [Plugin_Installer_Skin](https://developer.wordpress.org/reference/classes/plugin_installer_skin/)`wp-admin/includes/class-plugin-installer-skin.php` | Plugin Installer Skin for WordPress Plugin Installer. | | [Theme_Installer_Skin](https://developer.wordpress.org/reference/classes/theme_installer_skin/)`wp-admin/includes/class-theme-installer-skin.php` | Theme Installer Skin for the WordPress Theme Installer. | | [Plugin_Upgrader_Skin](https://developer.wordpress.org/reference/classes/plugin_upgrader_skin/)`wp-admin/includes/class-plugin-upgrader-skin.php` | Plugin Upgrader Skin for WordPress Plugin Upgrades. | | [Bulk_Upgrader_Skin](https://developer.wordpress.org/reference/classes/bulk_upgrader_skin/)`wp-admin/includes/class-bulk-upgrader-skin.php` | Generic Bulk Upgrader Skin for WordPress Upgrades. | [Show 2 more](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/?output_format=md#) [Show less](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/?output_format=md#) ## 󠀁[Changelog](https://developer.wordpress.org/reference/classes/wp_upgrader_skin/?output_format=md#changelog)󠁿 | Version | Description | | [4.6.0](https://developer.wordpress.org/reference/since/4.6.0/) | Moved to its own file from wp-admin/includes/class-wp-upgrader-skins.php. | | [2.8.0](https://developer.wordpress.org/reference/since/2.8.0/) | Introduced. | ## User Contributed Notes You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwp_upgrader_skin%2F) before being able to contribute a note or feedback.