Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Upgrader API: WP_Upgrader_Skin class

[2] Fix | Delete

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage Upgrader

[5] Fix | Delete

* @since 4.6.0

[6] Fix | Delete

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

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

[10] Fix | Delete

[11] Fix | Delete

* @since 2.8.0

[12] Fix | Delete

* @since 4.6.0 Moved to its own file from wp-admin/includes/class-wp-upgrader-skins.php.

[13] Fix | Delete

[14] Fix | Delete

#[AllowDynamicProperties]

[15] Fix | Delete

class WP_Upgrader_Skin {

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* Holds the upgrader data.

[19] Fix | Delete

[20] Fix | Delete

* @since 2.8.0

[21] Fix | Delete

* @var WP_Upgrader

[22] Fix | Delete

[23] Fix | Delete

public $upgrader;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Whether header is done.

[27] Fix | Delete

[28] Fix | Delete

* @since 2.8.0

[29] Fix | Delete

* @var bool

[30] Fix | Delete

[31] Fix | Delete

public $done_header = false;

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* Whether footer is done.

[35] Fix | Delete

[36] Fix | Delete

* @since 2.8.0

[37] Fix | Delete

* @var bool

[38] Fix | Delete

[39] Fix | Delete

public $done_footer = false;

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* Holds the result of an upgrade.

[43] Fix | Delete

[44] Fix | Delete

* @since 2.8.0

[45] Fix | Delete

* @var string|bool|WP_Error

[46] Fix | Delete

[47] Fix | Delete

public $result = false;

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* Holds the options of an upgrade.

[51] Fix | Delete

[52] Fix | Delete

* @since 2.8.0

[53] Fix | Delete

* @var array

[54] Fix | Delete

[55] Fix | Delete

public $options = array();

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Constructor.

[59] Fix | Delete

[60] Fix | Delete

* Sets up the generic skin for the WordPress Upgrader classes.

[61] Fix | Delete

[62] Fix | Delete

* @since 2.8.0

[63] Fix | Delete

[64] Fix | Delete

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

[65] Fix | Delete

* override default options. Default empty array.

[66] Fix | Delete

[67] Fix | Delete

public function __construct( $args = array() ) {

[68] Fix | Delete

$defaults = array(

[69] Fix | Delete

'url' => '',

[70] Fix | Delete

'nonce' => '',

[71] Fix | Delete

'title' => '',

[72] Fix | Delete

'context' => false,

[73] Fix | Delete

);

[74] Fix | Delete

$this->options = wp_parse_args( $args, $defaults );

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

/**

[78] Fix | Delete

* Sets the relationship between the skin being used and the upgrader.

[79] Fix | Delete

[80] Fix | Delete

* @since 2.8.0

[81] Fix | Delete

[82] Fix | Delete

* @param WP_Upgrader $upgrader

[83] Fix | Delete

[84] Fix | Delete

public function set_upgrader( &$upgrader ) {

[85] Fix | Delete

if ( is_object( $upgrader ) ) {

[86] Fix | Delete

$this->upgrader =& $upgrader;

[87] Fix | Delete

}

[88] Fix | Delete

$this->add_strings();

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

/**

[92] Fix | Delete

* Sets up the strings used in the update process.

[93] Fix | Delete

[94] Fix | Delete

* @since 3.0.0

[95] Fix | Delete

[96] Fix | Delete

public function add_strings() {

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

/**

[100] Fix | Delete

* Sets the result of an upgrade.

[101] Fix | Delete

[102] Fix | Delete

* @since 2.8.0

[103] Fix | Delete

[104] Fix | Delete

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

[105] Fix | Delete

[106] Fix | Delete

public function set_result( $result ) {

[107] Fix | Delete

$this->result = $result;

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

/**

[111] Fix | Delete

* Displays a form to the user to request for their FTP/SSH details in order

[112] Fix | Delete

* to connect to the filesystem.

[113] Fix | Delete

[114] Fix | Delete

* @since 2.8.0

[115] Fix | Delete

* @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.

[116] Fix | Delete

[117] Fix | Delete

* @see request_filesystem_credentials()

[118] Fix | Delete

[119] Fix | Delete

* @param bool|WP_Error $error Optional. Whether the current request has failed to connect,

[120] Fix | Delete

* or an error object. Default false.

[121] Fix | Delete

* @param string $context Optional. Full path to the directory that is tested

[122] Fix | Delete

* for being writable. Default empty.

[123] Fix | Delete

* @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.

[124] Fix | Delete

* @return bool True on success, false on failure.

[125] Fix | Delete

[126] Fix | Delete

public function request_filesystem_credentials( $error = false, $context = '', $allow_relaxed_file_ownership = false ) {

[127] Fix | Delete

$url = $this->options['url'];

[128] Fix | Delete

if ( ! $context ) {

[129] Fix | Delete

$context = $this->options['context'];

[130] Fix | Delete

}

[131] Fix | Delete

if ( ! empty( $this->options['nonce'] ) ) {

[132] Fix | Delete

$url = wp_nonce_url( $url, $this->options['nonce'] );

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

$extra_fields = array();

[136] Fix | Delete

[137] Fix | Delete

return request_filesystem_credentials( $url, '', $error, $context, $extra_fields, $allow_relaxed_file_ownership );

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

/**

[141] Fix | Delete

* Displays the header before the update process.

[142] Fix | Delete

[143] Fix | Delete

* @since 2.8.0

[144] Fix | Delete

[145] Fix | Delete

public function header() {

[146] Fix | Delete

if ( $this->done_header ) {

[147] Fix | Delete

return;

[148] Fix | Delete

}

[149] Fix | Delete

$this->done_header = true;

[150] Fix | Delete

echo '<div class="wrap">';

[151] Fix | Delete

echo '<h1>' . $this->options['title'] . '</h1>';

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

/**

[155] Fix | Delete

* Displays the footer following the update process.

[156] Fix | Delete

[157] Fix | Delete

* @since 2.8.0

[158] Fix | Delete

[159] Fix | Delete

public function footer() {

[160] Fix | Delete

if ( $this->done_footer ) {

[161] Fix | Delete

return;

[162] Fix | Delete

}

[163] Fix | Delete

$this->done_footer = true;

[164] Fix | Delete

echo '</div>';

[165] Fix | Delete

}

[166] Fix | Delete

[167] Fix | Delete

/**

[168] Fix | Delete

* Displays an error message about the update.

[169] Fix | Delete

[170] Fix | Delete

* @since 2.8.0

[171] Fix | Delete

[172] Fix | Delete

* @param string|WP_Error $errors Errors.

[173] Fix | Delete

[174] Fix | Delete

public function error( $errors ) {

[175] Fix | Delete

if ( ! $this->done_header ) {

[176] Fix | Delete

$this->header();

[177] Fix | Delete

}

[178] Fix | Delete

if ( is_string( $errors ) ) {

[179] Fix | Delete

$this->feedback( $errors );

[180] Fix | Delete

} elseif ( is_wp_error( $errors ) && $errors->has_errors() ) {

[181] Fix | Delete

foreach ( $errors->get_error_messages() as $message ) {

[182] Fix | Delete

if ( $errors->get_error_data() && is_string( $errors->get_error_data() ) ) {

[183] Fix | Delete

$this->feedback( $message . ' ' . esc_html( strip_tags( $errors->get_error_data() ) ) );

[184] Fix | Delete

} else {

[185] Fix | Delete

$this->feedback( $message );

[186] Fix | Delete

}

[187] Fix | Delete

}

[188] Fix | Delete

}

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

/**

[192] Fix | Delete

* Displays a message about the update.

[193] Fix | Delete

[194] Fix | Delete

* @since 2.8.0

[195] Fix | Delete

* @since 5.9.0 Renamed `$string` (a PHP reserved keyword) to `$feedback` for PHP 8 named parameter support.

[196] Fix | Delete

[197] Fix | Delete

* @param string $feedback Message data.

[198] Fix | Delete

* @param mixed ...$args Optional text replacements.

[199] Fix | Delete

[200] Fix | Delete

public function feedback( $feedback, ...$args ) {

[201] Fix | Delete

if ( isset( $this->upgrader->strings[ $feedback ] ) ) {

[202] Fix | Delete

$feedback = $this->upgrader->strings[ $feedback ];

[203] Fix | Delete

}

[204] Fix | Delete

[205] Fix | Delete

if ( str_contains( $feedback, '%' ) ) {

[206] Fix | Delete

if ( $args ) {

[207] Fix | Delete

$args = array_map( 'strip_tags', $args );

[208] Fix | Delete

$args = array_map( 'esc_html', $args );

[209] Fix | Delete

$feedback = vsprintf( $feedback, $args );

[210] Fix | Delete

}

[211] Fix | Delete

}

[212] Fix | Delete

if ( empty( $feedback ) ) {

[213] Fix | Delete

return;

[214] Fix | Delete

}

[215] Fix | Delete

show_message( $feedback );

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

/**

[219] Fix | Delete

* Performs an action before an update.

[220] Fix | Delete

[221] Fix | Delete

* @since 2.8.0

[222] Fix | Delete

[223] Fix | Delete

public function before() {}

[224] Fix | Delete

[225] Fix | Delete

/**

[226] Fix | Delete

* Performs an action following an update.

[227] Fix | Delete

[228] Fix | Delete

* @since 2.8.0

[229] Fix | Delete

[230] Fix | Delete

public function after() {}

[231] Fix | Delete

[232] Fix | Delete

/**

[233] Fix | Delete

* Outputs JavaScript that calls function to decrement the update counts.

[234] Fix | Delete

[235] Fix | Delete

* @since 3.9.0

[236] Fix | Delete

[237] Fix | Delete

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

[238] Fix | Delete

* 'theme', 'translation', etc.

[239] Fix | Delete

[240] Fix | Delete

protected function decrement_update_count( $type ) {

[241] Fix | Delete

if ( ! $this->result || is_wp_error( $this->result ) || 'up_to_date' === $this->result ) {

[242] Fix | Delete

return;

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

if ( defined( 'IFRAME_REQUEST' ) ) {

[246] Fix | Delete

echo '<script type="text/javascript">

[247] Fix | Delete

if ( window.postMessage && JSON ) {

[248] Fix | Delete

window.parent.postMessage(

[249] Fix | Delete

JSON.stringify( {

[250] Fix | Delete

action: "decrementUpdateCount",

[251] Fix | Delete

upgradeType: "' . $type . '"

[252] Fix | Delete

} ),

[253] Fix | Delete

window.location.protocol + "//" + window.location.hostname

[254] Fix | Delete

+ ( "" !== window.location.port ? ":" + window.location.port : "" )

[255] Fix | Delete

);

[256] Fix | Delete

}

[257] Fix | Delete

</script>';

[258] Fix | Delete

} else {

[259] Fix | Delete

echo '<script type="text/javascript">

[260] Fix | Delete

(function( wp ) {

[261] Fix | Delete

if ( wp && wp.updates && wp.updates.decrementCount ) {

[262] Fix | Delete

wp.updates.decrementCount( "' . $type . '" );

[263] Fix | Delete

}

[264] Fix | Delete

})( window.wp );

[265] Fix | Delete

</script>';

[266] Fix | Delete

}

[267] Fix | Delete

}

[268] Fix | Delete

[269] Fix | Delete

/**

[270] Fix | Delete

* Displays the header before the bulk update process.

[271] Fix | Delete

[272] Fix | Delete

* @since 3.0.0

[273] Fix | Delete

[274] Fix | Delete

public function bulk_header() {}

[275] Fix | Delete

[276] Fix | Delete

/**

[277] Fix | Delete

* Displays the footer following the bulk update process.

[278] Fix | Delete

[279] Fix | Delete

* @since 3.0.0

[280] Fix | Delete

[281] Fix | Delete

public function bulk_footer() {}

[282] Fix | Delete

[283] Fix | Delete

/**

[284] Fix | Delete

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

[285] Fix | Delete

[286] Fix | Delete

* @since 5.5.0

[287] Fix | Delete

[288] Fix | Delete

* @param WP_Error $wp_error WP_Error object.

[289] Fix | Delete

* @return bool True if the error should be hidden, false otherwise.

[290] Fix | Delete

[291] Fix | Delete

public function hide_process_failed( $wp_error ) {

[292] Fix | Delete

return false;

[293] Fix | Delete

}

[294] Fix | Delete

}

[295] Fix | Delete

[296] Fix | Delete