- Timestamp:
- 10/12/2023 02:50:31 PM (2 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
branches/4.8/src/wp-includes/rest-api/class-wp-rest-server.php
r41093 r56864 244 244 245 245 /** 246 * Send nocache headers on authenticated requests.246 * Filters whether the REST API is enabled. 247 247 * 248 248 * @since 4.4.0 249 * @deprecated 4.7.0 Use the rest_authentication_errors filter to restrict access to the API 250 * 251 * @param bool $rest_enabled Whether the REST API is enabled. Default true. 252 */ 253 apply_filters_deprecated( 'rest_enabled', array( true ), '4.7.0', 'rest_authentication_errors', 254 __( 'The REST API can no longer be completely disabled, the rest_authentication_errors filter can be used to restrict access to the API, instead.' ) 255 ); 256 257 /** 258 * Filters whether jsonp is enabled. 259 * 260 * @since 4.4.0 261 * 262 * @param bool $jsonp_enabled Whether jsonp is enabled. Default true. 263 */ 264 $jsonp_enabled = apply_filters( 'rest_jsonp_enabled', true ); 265 266 $jsonp_callback = null; 267 268 if ( isset( $_GET['_jsonp'] ) ) { 269 if ( ! $jsonp_enabled ) { 270 echo $this->json_error( 'rest_callback_disabled', __( 'JSONP support is disabled on this site.' ), 400 ); 271 return false; 272 } 273 274 $jsonp_callback = $_GET['_jsonp']; 275 if ( ! wp_check_jsonp_callback( $jsonp_callback ) ) { 276 echo $this->json_error( 'rest_callback_invalid', __( 'Invalid JSONP callback function.' ), 400 ); 277 return false; 278 } 279 } 280 281 if ( empty( $path ) ) { 282 if ( isset( $_SERVER['PATH_INFO'] ) ) { 283 $path = $_SERVER['PATH_INFO']; 284 } else { 285 $path = '/'; 286 } 287 } 288 289 $request = new WP_REST_Request( $_SERVER['REQUEST_METHOD'], $path ); 290 291 $request->set_query_params( wp_unslash( $_GET ) ); 292 $request->set_body_params( wp_unslash( $_POST ) ); 293 $request->set_file_params( $_FILES ); 294 $request->set_headers( $this->get_headers( wp_unslash( $_SERVER ) ) ); 295 $request->set_body( $this->get_raw_data() ); 296 297 /* 298 * HTTP method override for clients that can't use PUT/PATCH/DELETE. First, we check 299 * $_GET['_method']. If that is not set, we check for the HTTP_X_HTTP_METHOD_OVERRIDE 300 * header. 301 */ 302 $method_overridden = false; 303 if ( isset( $_GET['_method'] ) ) { 304 $request->set_method( $_GET['_method'] ); 305 } elseif ( isset( $_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'] ) ) { 306 $request->set_method( $_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'] ); 307 $method_overridden = true; 308 } 309 310 $result = $this->check_authentication(); 311 312 if ( ! is_wp_error( $result ) ) { 313 $result = $this->dispatch( $request ); 314 } 315 316 // Normalize to either WP_Error or WP_REST_Response... 317 $result = rest_ensure_response( $result ); 318 319 // ...then convert WP_Error across. 320 if ( is_wp_error( $result ) ) { 321 $result = $this->error_to_response( $result ); 322 } 323 324 /** 325 * Filters the API response. 326 * 327 * Allows modification of the response before returning. 328 * 329 * @since 4.4.0 330 * @since 4.5.0 Applied to embedded responses. 331 * 332 * @param WP_HTTP_Response $result Result to send to the client. Usually a WP_REST_Response. 333 * @param WP_REST_Server $this Server instance. 334 * @param WP_REST_Request $request Request used to generate the response. 335 */ 336 $result = apply_filters( 'rest_post_dispatch', rest_ensure_response( $result ), $this, $request ); 337 338 // Wrap the response in an envelope if asked for. 339 if ( isset( $_GET['_envelope'] ) ) { 340 $result = $this->envelope_response( $result, isset( $_GET['_embed'] ) ); 341 } 342 343 // Send extra data from response objects. 344 $headers = $result->get_headers(); 345 $this->send_headers( $headers ); 346 347 $code = $result->get_status(); 348 $this->set_status( $code ); 349 350 /** 351 * Filters whether the request has already been served. 352 * 353 * Allow sending the request manually - by returning true, the API result 354 * will not be sent to the client. 355 * 356 * @since 4.4.0 357 * 358 * @param bool $served Whether the request has already been served. 359 * Default false. 360 * @param WP_HTTP_Response $result Result to send to the client. Usually a WP_REST_Response. 361 * @param WP_REST_Request $request Request used to generate the response. 362 * @param WP_REST_Server $this Server instance. 363 */ 364 $served = apply_filters( 'rest_pre_serve_request', false, $result, $request, $this ); 365 366 /** 367 * Filters whether to send nocache headers on a REST API request. 368 * 369 * @since 4.4.0 370 * @since 6.x.x Moved the block to catch the filter added on rest_cookie_check_errors() from rest-api.php 249 371 * 250 372 * @param bool $rest_send_nocache_headers Whether to send no-cache headers. 251 373 */ 252 374 $send_no_cache_headers = apply_filters( 'rest_send_nocache_headers', is_user_logged_in() ); 253 if ( $send_no_cache_headers ) { 375 376 // send no cache headers if the $send_no_cache_headers is true 377 // OR if the HTTP_X_HTTP_METHOD_OVERRIDE is used but resulted a 4xx response code. 378 if ( $send_no_cache_headers || ( true === $method_overridden && strpos( $code, '4' ) === 0 ) ) { 254 379 foreach ( wp_get_nocache_headers() as $header => $header_value ) { 255 380 if ( empty( $header_value ) ) { … … 260 385 } 261 386 } 262 263 /**264 * Filters whether the REST API is enabled.265 *266 * @since 4.4.0267 * @deprecated 4.7.0 Use the rest_authentication_errors filter to restrict access to the API268 *269 * @param bool $rest_enabled Whether the REST API is enabled. Default true.270 */271 apply_filters_deprecated( 'rest_enabled', array( true ), '4.7.0', 'rest_authentication_errors',272 __( 'The REST API can no longer be completely disabled, the rest_authentication_errors filter can be used to restrict access to the API, instead.' )273 );274 275 /**276 * Filters whether jsonp is enabled.277 *278 * @since 4.4.0279 *280 * @param bool $jsonp_enabled Whether jsonp is enabled. Default true.281 */282 $jsonp_enabled = apply_filters( 'rest_jsonp_enabled', true );283 284 $jsonp_callback = null;285 286 if ( isset( $_GET['_jsonp'] ) ) {287 if ( ! $jsonp_enabled ) {288 echo $this->json_error( 'rest_callback_disabled', __( 'JSONP support is disabled on this site.' ), 400 );289 return false;290 }291 292 $jsonp_callback = $_GET['_jsonp'];293 if ( ! wp_check_jsonp_callback( $jsonp_callback ) ) {294 echo $this->json_error( 'rest_callback_invalid', __( 'Invalid JSONP callback function.' ), 400 );295 return false;296 }297 }298 299 if ( empty( $path ) ) {300 if ( isset( $_SERVER['PATH_INFO'] ) ) {301 $path = $_SERVER['PATH_INFO'];302 } else {303 $path = '/';304 }305 }306 307 $request = new WP_REST_Request( $_SERVER['REQUEST_METHOD'], $path );308 309 $request->set_query_params( wp_unslash( $_GET ) );310 $request->set_body_params( wp_unslash( $_POST ) );311 $request->set_file_params( $_FILES );312 $request->set_headers( $this->get_headers( wp_unslash( $_SERVER ) ) );313 $request->set_body( $this->get_raw_data() );314 315 /*316 * HTTP method override for clients that can't use PUT/PATCH/DELETE. First, we check317 * $_GET['_method']. If that is not set, we check for the HTTP_X_HTTP_METHOD_OVERRIDE318 * header.319 */320 if ( isset( $_GET['_method'] ) ) {321 $request->set_method( $_GET['_method'] );322 } elseif ( isset( $_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'] ) ) {323 $request->set_method( $_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'] );324 }325 326 $result = $this->check_authentication();327 328 if ( ! is_wp_error( $result ) ) {329 $result = $this->dispatch( $request );330 }331 332 // Normalize to either WP_Error or WP_REST_Response...333 $result = rest_ensure_response( $result );334 335 // ...then convert WP_Error across.336 if ( is_wp_error( $result ) ) {337 $result = $this->error_to_response( $result );338 }339 340 /**341 * Filters the API response.342 *343 * Allows modification of the response before returning.344 *345 * @since 4.4.0346 * @since 4.5.0 Applied to embedded responses.347 *348 * @param WP_HTTP_Response $result Result to send to the client. Usually a WP_REST_Response.349 * @param WP_REST_Server $this Server instance.350 * @param WP_REST_Request $request Request used to generate the response.351 */352 $result = apply_filters( 'rest_post_dispatch', rest_ensure_response( $result ), $this, $request );353 354 // Wrap the response in an envelope if asked for.355 if ( isset( $_GET['_envelope'] ) ) {356 $result = $this->envelope_response( $result, isset( $_GET['_embed'] ) );357 }358 359 // Send extra data from response objects.360 $headers = $result->get_headers();361 $this->send_headers( $headers );362 363 $code = $result->get_status();364 $this->set_status( $code );365 366 /**367 * Filters whether the request has already been served.368 *369 * Allow sending the request manually - by returning true, the API result370 * will not be sent to the client.371 *372 * @since 4.4.0373 *374 * @param bool $served Whether the request has already been served.375 * Default false.376 * @param WP_HTTP_Response $result Result to send to the client. Usually a WP_REST_Response.377 * @param WP_REST_Request $request Request used to generate the response.378 * @param WP_REST_Server $this Server instance.379 */380 $served = apply_filters( 'rest_pre_serve_request', false, $result, $request, $this );381 387 382 388 if ( ! $served ) {
Note: See TracChangeset
for help on using the changeset viewer.