WP_REST_Response::as_error() WordPress Method

The WP_REST_Response::as_error() method is used to indicate that the requested resource could not be found. This is typically used in the context of a 404 Not Found error.

WP_REST_Response::as_error() #

Retrieves a WP_Error object from the response.

Contents

Return

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

Top ↑

Source

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

225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
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;
}

Expand full source codeCollapse full source codeView on TracView on GitHub

Top ↑

Top ↑

Changelog

Changelog
VersionDescription
4.4.0Introduced.
Download the latest version of WordPress from https://wordpress.org/

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by the Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.