WP_REST_Response::as_error

Advertisement

Summery Summery

Retrieves a WP_Error object from the response.

Syntax Syntax

WP_REST_Response::as_error()

Return Return

(WP_Error|null) WP_Error or null on not an errored response.

Source Source

File: wp-includes/rest-api/class-wp-rest-response.php

	public function as_error() {
		if ( ! $this->is_error() ) {
			return null;
		}

		$error = new WP_Error;

		if ( is_array( $this->get_data() ) ) {
			$data = $this->get_data();
			$error->add( $data['code'], $data['message'], $data['data'] );

			if ( ! empty( $data['additional_errors'] ) ) {
				foreach ( $data['additional_errors'] as $err ) {
					$error->add( $err['code'], $err['message'], $err['data'] );
				}
			}
		} else {
			$error->add( $this->get_status(), '', array( 'status' => $this->get_status() ) );
		}

		return $error;
	}

Advertisement

Changelog Changelog

Changelog
Version Description
4.4.0 Introduced.

Advertisement

Leave a Reply