WP_REST_Response::as_error(): WP_Error|null
- Since
- 4.4.0
- Source
wp-includes/rest-api/class-wp-rest-response.php:225
Retrieves a WP_Error object from the response.
Return
WP_Error|null- WP_Error or null on not an errored response.
Uses · 4
- WP_REST_Response::is_error()Checks if the response is an error, i.e. >= 400 response code.
- WP_Error::__construct()Initializes the error.
- WP_REST_Response::get_data()
- WP_REST_Response::get_status()
Source
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; }History
Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/rest-api/class-wp-rest-response.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.