wppaste
WordPress

rest_api_default_filters()

Since
4.4.0
Source
wp-includes/rest-api.php:240
Registers the default REST API filters.

Description

Attached to the 'rest_api_init' action to make testing and disabling these filters easier.

Compatibility

WordPress
since 4.4.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Performance profile

How much work a call to rest_api_default_filters() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
30–60

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 60.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost rest_api_default_filters() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
!wp_is_serving_rest_request()30wp_is_serving_rest_request(), add_filter(), add_filter(), add_filter(), add_filter(), add_filter()
wp_is_serving_rest_request()60wp_is_serving_rest_request(), add_action(), add_filter(), add_action(), add_filter(), add_action(), add_filter(), add_filter(), add_filter(), add_filter(), add_filter(), add_filter()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 60 instructions, 30–60 executed per call, 1 branch. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 3

Source code

function rest_api_default_filters() {	if ( wp_is_serving_rest_request() ) {		// Deprecated reporting.		add_action( 'deprecated_function_run', 'rest_handle_deprecated_function', 10, 3 );		add_filter( 'deprecated_function_trigger_error', '__return_false' );		add_action( 'deprecated_argument_run', 'rest_handle_deprecated_argument', 10, 3 );		add_filter( 'deprecated_argument_trigger_error', '__return_false' );		add_action( 'doing_it_wrong_run', 'rest_handle_doing_it_wrong', 10, 3 );		add_filter( 'doing_it_wrong_trigger_error', '__return_false' );	} 	// Default serving.	add_filter( 'rest_pre_serve_request', 'rest_send_cors_headers' );	add_filter( 'rest_post_dispatch', 'rest_send_allow_header', 10, 3 );	add_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10, 3 ); 	add_filter( 'rest_pre_dispatch', 'rest_handle_options_request', 10, 3 );	add_filter( 'rest_index', 'rest_add_application_passwords_to_index' );}

Changelog

Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/rest-api.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.