WP_Ajax_Upgrader_Skin::error( string|WP_Error $errors, mixed $args )

Stores an error message about the upgrade.


Parameters

$errors string|WP_Error Required
Errors.
$args mixed Optional
text replacements.

Top ↑

Source

File: wp-admin/includes/class-wp-ajax-upgrader-skin.php. View all references

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 );
}


Top ↑

Changelog

Changelog
Version Description
5.3.0 Formalized the existing ...$args parameter by adding it to the function signature.
4.6.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.