mirror of
https://github.com/WordPress/WordPress.git
synced 2024-08-27 16:19:38 +02:00
In the parent class, renames the parameter `$string` to `$feedback`. Why? `string` is a PHP reserved keyword. In each child class: renames the parameter to match the parent's method signature. Why? PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match. Changes for readability: - `@since` clearly specifies the original parameter name and its new name as well as why the change happened. Follow-up to [11005], [25228], [30680], [32655], [38199], [49596]. Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion. See #51553. Built from https://develop.svn.wordpress.org/trunk@51781 git-svn-id: http://core.svn.wordpress.org/trunk@51388 1a063a9b-81f0-0310-95a4-ce76da25c4cd
139 lines
3.5 KiB
PHP
139 lines
3.5 KiB
PHP
<?php
|
|
/**
|
|
* Upgrader API: WP_Ajax_Upgrader_Skin class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Upgrader
|
|
* @since 4.6.0
|
|
*/
|
|
|
|
/**
|
|
* Upgrader Skin for Ajax WordPress upgrades.
|
|
*
|
|
* This skin is designed to be used for Ajax updates.
|
|
*
|
|
* @since 4.6.0
|
|
*
|
|
* @see Automatic_Upgrader_Skin
|
|
*/
|
|
class WP_Ajax_Upgrader_Skin extends Automatic_Upgrader_Skin {
|
|
|
|
/**
|
|
* Holds the WP_Error object.
|
|
*
|
|
* @since 4.6.0
|
|
*
|
|
* @var null|WP_Error
|
|
*/
|
|
protected $errors = null;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* Sets up the WordPress Ajax upgrader skin.
|
|
*
|
|
* @since 4.6.0
|
|
*
|
|
* @see WP_Upgrader_Skin::__construct()
|
|
*
|
|
* @param array $args Optional. The WordPress Ajax upgrader skin arguments to
|
|
* override default options. See WP_Upgrader_Skin::__construct().
|
|
* Default empty array.
|
|
*/
|
|
public function __construct( $args = array() ) {
|
|
parent::__construct( $args );
|
|
|
|
$this->errors = new WP_Error();
|
|
}
|
|
|
|
/**
|
|
* Retrieves the list of errors.
|
|
*
|
|
* @since 4.6.0
|
|
*
|
|
* @return WP_Error Errors during an upgrade.
|
|
*/
|
|
public function get_errors() {
|
|
return $this->errors;
|
|
}
|
|
|
|
/**
|
|
* Retrieves a string for error messages.
|
|
*
|
|
* @since 4.6.0
|
|
*
|
|
* @return string Error messages during an upgrade.
|
|
*/
|
|
public function get_error_messages() {
|
|
$messages = array();
|
|
|
|
foreach ( $this->errors->get_error_codes() as $error_code ) {
|
|
$error_data = $this->errors->get_error_data( $error_code );
|
|
|
|
if ( $error_data && is_string( $error_data ) ) {
|
|
$messages[] = $this->errors->get_error_message( $error_code ) . ' ' . esc_html( strip_tags( $error_data ) );
|
|
} else {
|
|
$messages[] = $this->errors->get_error_message( $error_code );
|
|
}
|
|
}
|
|
|
|
return implode( ', ', $messages );
|
|
}
|
|
|
|
/**
|
|
* Stores an error message about the upgrade.
|
|
*
|
|
* @since 4.6.0
|
|
* @since 5.3.0 Formalized the existing `...$args` parameter by adding it
|
|
* to the function signature.
|
|
*
|
|
* @param string|WP_Error $errors Errors.
|
|
* @param mixed ...$args Optional text replacements.
|
|
*/
|
|
public function error( $errors, ...$args ) {
|
|
if ( is_string( $errors ) ) {
|
|
$string = $errors;
|
|
if ( ! empty( $this->upgrader->strings[ $string ] ) ) {
|
|
$string = $this->upgrader->strings[ $string ];
|
|
}
|
|
|
|
if ( false !== strpos( $string, '%' ) ) {
|
|
if ( ! empty( $args ) ) {
|
|
$string = vsprintf( $string, $args );
|
|
}
|
|
}
|
|
|
|
// Count existing errors to generate a unique error code.
|
|
$errors_count = count( $this->errors->get_error_codes() );
|
|
$this->errors->add( 'unknown_upgrade_error_' . ( $errors_count + 1 ), $string );
|
|
} elseif ( is_wp_error( $errors ) ) {
|
|
foreach ( $errors->get_error_codes() as $error_code ) {
|
|
$this->errors->add( $error_code, $errors->get_error_message( $error_code ), $errors->get_error_data( $error_code ) );
|
|
}
|
|
}
|
|
|
|
parent::error( $errors, ...$args );
|
|
}
|
|
|
|
/**
|
|
* Stores a message about the upgrade.
|
|
*
|
|
* @since 4.6.0
|
|
* @since 5.3.0 Formalized the existing `...$args` parameter by adding it
|
|
* to the function signature.
|
|
* @since 5.9.0 Renamed `$data` to `$feedback` for PHP 8 named parameter support.
|
|
*
|
|
* @param string|array|WP_Error $feedback Message data.
|
|
* @param mixed ...$args Optional text replacements.
|
|
*/
|
|
public function feedback( $feedback, ...$args ) {
|
|
if ( is_wp_error( $feedback ) ) {
|
|
foreach ( $feedback->get_error_codes() as $error_code ) {
|
|
$this->errors->add( $error_code, $feedback->get_error_message( $error_code ), $feedback->get_error_data( $error_code ) );
|
|
}
|
|
}
|
|
|
|
parent::feedback( $feedback, ...$args );
|
|
}
|
|
}
|