WP_Error{} │ WP 2.1.0

// Пряме використання
return new WP_Error( $code, $message, $data );

// додавання кількох помилок
$errors = новий WP_Error;
$errors->add( $code, $message, $data );
$errors->add( $code, $message, $data );

$error = new WP_Error( 'error_key', 'Повідомлення помилки...', 404);

if( is_wp_error( $error ) ){
	echo $error->get_error_code(); //> error_key
	echo $error->get_error_message(); //> Повідомлення помилки...
	echo $error->get_error_data(); //> 404
}

function some_stuff( $some = false ){
	// Змінна $some має бути вказана
	if( ! $some )
		return new WP_Error('fallen', 'Він упав і стати не може');
	else
		return true;
}

// тепер викликаємо функцію, щоб вона повернула помилку
$ return = some_stuff();

// перевіряємо змінну наявність помилки
if( is_wp_error( $return ) ){
	// Виводимо повідомлення помилки
	echo $return->get_error_message(); // виведе 'Він упав і стати не може'
}

// Створюємо екземпляр
global $form_error;
$form_error = новий WP_Error;

// Будь-яка функція, можливо в іншому файлі
function foo(){
	global $form_error;

	// якийсь код.

	// Перевірка поля
	if( empty( $email ) ){
		$form_error->add('no_email', 'Заповніть email');
	}
	elseif( ! is_email( $email ) ){
		$form_error->add('invalid_email', 'Некоректний email');
	}

	// Перевіряємо чи помилка обриваємо роботу функції
	if ( $form_error->get_error_code() )
		return; // виходимо далі роботу функції не продовжуємо через помилку

}

// Інший файл (не той, де функція foo() або той, не важливо) - файл де виводяться
// Повідомлення про помилки якщо такі є.
// Перевіряємо чи є помилка і виводимо всі повідомлення, якщо помилка
if ( $form_error->get_error_code() ) {
	foreach( $form_error->get_error_messages() as $error ){
		echo '<div><strong>Помилка</strong>:'. $error .'</div>';
	}
}

// створюємо екземпляр і відразу додаємо дані - метод add()
$error = new WP_Error( 'fallen', 'Жук упав і стати не може.' );

// додамо ще дані об'єкт
$error->add( 'help', 'Чекає він, хто йому допоможе.' );

/* $error містить
WP_Error Object
(
	[errors] => Array
		(
			[fallen] => Array
				(
					[0] => Жук упав і встати не може.
				)

			[help] => Array
				(
					[0] => Чекає він, хто йому допоможе.
				)

		)

	[error_data] => Array
		(
		)

)
*/

// Додамо ще дані та вкажемо третій параметр
$error->add( 'frost', 'Іній ліг на гілки ялини.', 'error' );
$error->add( 'white', 'Голки за ніч побіліли.', 'message' );

/* тепер $error містить
WP_Error Object
(
	[errors] => Array
		(
			[fallen] => Array
				(
					[0] => Жук упав і встати не може.
				)

			[help] => Array
				(
					[0] => Чекає він, хто йому допоможе.
				)

			[frost] => Array
				(
					[0] => Іній ліг на гілки ялини.
				)

			[white] => Array
				(
					[0] => Голки за ніч побіліли.
				)

		)

	[error_data] => Array
		(
			[frost] => error
			[white] => message
		)

)
*/

$all_data = $error->get_all_error_data( 'white' );
/* $all_data містить:
Array
(
	[0] => message
)
*/

$data = $error->get_error_data( 'white' );
/* $data містить:
message
*/

список змін

Код WP_Error{} WP Error{} ^{WP 6.0.2}

class WP_Error {
	/**
	 * Stores the list of errors.
	 *
	 * @ Since 2.1.0
	 * @var array
	 */
	$errors = array();

	/**
	 * Stores the most recently added data for each error code.
	 *
	 * @ Since 2.1.0
	 * @var array
	 */
	public $error_data = array();

	/**
	 * Stores previously added data added for error codes, oldest-to-newest by code.
	 *
	 * @ Since 5.6.0
	 * @var array[]
	 */
	protected $additional_data = array();

	/**
	 * Initializes the error.
	 *
	 * If `$code` is empty, thether parameters will be ignored.
	 * When `$code` is not empty, `$message` will be used even if
	 * it is empty. The `$data` parameter will be used only if it
	 * is not empty.
	 *
	 * Though the class is constructed with a single error code and
	 * message, multicodes може бути added using the `add()` method.
	 *
	 * @ Since 2.1.0
	 *
	 * @param string|int $code Error code.
	 * @param string $message Error message.
	 * @param mixed $data Optional. Error data.
	 */
	public function __construct( $code = '', $message = '', $data = '' ) {
		if ( empty( $code ) ) {
			return;
		}

		$this->add( $code, $message, $data );
	}

	/**
	 * Retrieves all error codes.
	 *
	 * @ Since 2.1.0
	 *
	 * @return array List of error codes, if available.
	 */
	public function get_error_codes() {
		if ( ! $this->has_errors() ) {
			return array();
		}

		return array_keys( $this->errors );
	}

	/**
	 * Retrieves the first error code available.
	 *
	 * @ Since 2.1.0
	 *
	 * @return string|int Empty string, якщо немає Error Codes.
	 */
	public function get_error_code() {
		$codes = $this->get_error_codes();

		if ( empty( $codes ) ) {
			return '';
		}

		return $codes[0];
	}

	/**
	 * Retrieves all error messages, або error messages for given error code.
	 *
	 * @ Since 2.1.0
	 *
	 * @param string|int $code Optional. Retrieve messages matching code, if exists.
	 * @return string[] Error strings на успіх, або empty array if there are none.
	 */
	public function get_error_messages( $code = '' ) {
		// Return all messages if no code specified.
		if ( empty( $code ) ) {
			$all_messages = array();
			foreach ((array) $this->errors as $code => $messages ) {
				$ all_messages = array_merge ($ all_messages, $ messages);
			}

			return $all_messages;
		}

		if ( isset( $this->errors[ $code ] ) ) {
			return $this->errors[ $code ];
		} else {
			return array();
		}
	}

	/**
	 * Gets a single error message.
	 *
	 * Це буде, щоб отримати перший список доступних для коду. If no code is
	 * given then the first code available will be used.
	 *
	 * @ Since 2.1.0
	 *
	 * @param string|int $code Optional. Error code to retrieve message.
	 * @return string The error message.
	 */
	public function get_error_message( $code = '' ) {
		if ( empty( $code ) ) {
			$code = $this->get_error_code();
		}
		$messages = $this->get_error_messages( $code );
		if ( empty( $messages ) ) {
			return '';
		}
		return $messages[0];
	}

	/**
	 * Retrieves the most recently added error data for an error code.
	 *
	 * @ Since 2.1.0
	 *
	 * @param string|int $code Optional. Error code.
	 * @return mixed Error data, if it exists.
	 */
	public function get_error_data( $code = '' ) {
		if ( empty( $code ) ) {
			$code = $this->get_error_code();
		}

		if ( isset( $this->error_data[ $code ] ) ) {
			return $this->error_data[ $code ];
		}
	}

	/**
	 * Verifies if the instance contains errors.
	 *
	 * @ Since 5.1.0
	 *
	 * @return bool Якщо ви помітили помилки.
	 */
	public function has_errors() {
		if ( ! empty( $this->errors ) ) {
			return true;
		}
		return false;
	}

	/**
	 * Adds error або appends additional message to an existing error.
	 *
	 * @ Since 2.1.0
	 *
	 * @param string|int $code Error code.
	 * @param string $message Error message.
	 * @param mixed $data Optional. Error data.
	 */
	public function add( $code, $message, $data = '' ) {
		$this->errors[ $code ][] = $message;

		if (! empty($data)) {
			$this->add_data( $data, $code );
		}

		/**
		 * Fires when an error is added to a WP_Error object.
		 *
		 * @ Since 5.6.0
		 *
		 * @param string|int $code Error code.
		 * @param string $message Error message.
		 * @param mixed $data Error data. Might be empty.
		 * @param WP_Error $wp_error WP_Error object.
		 */
		do_action( 'wp_error_added', $code, $message, $data, $this );
	}

	/**
	 * Adds data to an error with the given code.
	 *
	 * @ Since 2.1.0
	 * @since 5.6.0 Errors can now contain more than one item of error data. {@see WP_Error::$additional_data}.
	 *
	 * @param mixed $data Error data.
	 * @param string|int $code Error code.
	 */
	public function add_data( $data, $code = '' ) {
		if ( empty( $code ) ) {
			$code = $this->get_error_code();
		}

		if ( isset( $this->error_data[ $code ] ) ) {
			$this->additional_data[ $code ][] = $this->error_data[ $code ];
		}

		$this->error_data[ $code ] = $data;
	}

	/**
	 * Retrieves all error data for error code in the order in which the data був added.
	 *
	 * @ Since 5.6.0
	 *
	 * @param string|int $code Error code.
	 * @return mixed[] Array of error data, if it exists.
	 */
	public function get_all_error_data( $code = '' ) {
		if ( empty( $code ) ) {
			$code = $this->get_error_code();
		}

		$ data = array ();

		if ( isset( $this->additional_data[ $code ] ) ) {
			$data = $this->additional_data[ $code ];
		}

		if ( isset( $this->error_data[ $code ] ) ) {
			$data[] = $this->error_data[ $code ];
		}

		return $data;
	}

	/**
	 * Removes the specified error.
	 *
	 * Ця функція повертає всі error messages поєднана з конкретним
	 * error code, тривалий час з будь-яким error data для цього коду.
	 *
	 * @ Since 4.1.0
	 *
	 * @param string|int $code Error code.
	 */
	public function remove( $code ) {
		unset( $this->errors[ $code ] );
		unset( $this->error_data[ $code ] );
		unset( $this->additional_data[ $code ] );
	}

	/**
	 * Merges the errors in given error error object in this one.
	 *
	 * @ Since 5.6.0
	 *
	 * @param WP_Error $error Error object to merge.
	 */
	public function merge_from( WP_Error $error ) {
		static::copy_errors( $error, $this );
	}

	/**
	 * Exports the errors в цей об'єкт в given one.
	 *
	 * @ Since 5.6.0
	 *
	 * @param WP_Error $error Error object to export into.
	 */
	public function export_to( WP_Error $error ) {
		static::copy_errors( $this, $error );
	}

	/**
	 * Copies errors з одного WP_Error instance to another.
	 *
	 * @ Since 5.6.0
	 *
	 * @param WP_Error $from WP_Error для копіювання.
	 * @param WP_Error $to The WP_Error to copy to.
	 */
	protected static function copy_errors( WP_Error $from, WP_Error $to ) {
		foreach ( $from->get_error_codes() as $code ) {
			foreach ( $from->get_error_messages( $code ) as $error_message ) {
				$to->add($code, $error_message);
			}

			foreach ( $from->get_all_error_data( $code ) as $data ) {
				$ to -> add_data ($ data, $ code);
			}
		}
	}
}

Зв’язані функції

Класи