WP_Error::add( string|int $code, string $message, mixed $data = '' )

Adds an error or appends an additional message to an existing error.


Parameters Parameters

$code

(string|int) (Required) Error code.

$message

(string) (Required) Error message.

$data

(mixed) (Optional) Error data.

Default value: ''


Top ↑

Source Source

File: wp-includes/class-wp-error.php

	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 The WP_Error object.
		 */
		do_action( 'wp_error_added', $code, $message, $data, $this );
	}


Top ↑

Changelog Changelog

Changelog
Version Description
2.1.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

Top ↑

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