wppaste
WordPress

_wp_get_allowed_postdata( array|WP_Error|null $post_data = null ): array|WP_Error

Since
5.0.1
Source
wp-admin/includes/post.php:230
Returns only allowed post data fields.

Compatibility

WordPress
since 5.0.1
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.

Parameters

$post_dataarray|WP_Error|nulloptional
The array of post data to process, or an error object.
Defaults to the $_POST superglobal.Default: null

Return value

array|WP_Error
Array of post data on success, WP_Error on failure.

Performance profile

How much work a call to _wp_get_allowed_postdata() 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
8–14

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
5

5 places in core call this, so the cost is paid more often than your own code shows.

What it touches

  • hookthird-party callbacksdo_action()one call below _wp_get_allowed_postdata()

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 _wp_get_allowed_postdata() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
is_wp_error()8–10is_wp_error()
!is_wp_error()12–14is_wp_error(), array_diff_key()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 15 instructions, 8–14 executed per call, 2 branches. 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 · 1

  • is_wp_error()Checks whether the given variable is a WordPress Error.

Used by · 5

Source code

View on Trac View on GitHub 

function _wp_get_allowed_postdata( $post_data = null ) {	if ( empty( $post_data ) ) {		$post_data = $_POST;	} 	// Pass through errors.	if ( is_wp_error( $post_data ) ) {		return $post_data;	} 	return array_diff_key( $post_data, array_flip( array( 'meta_input', 'file', 'guid' ) ) );}

Changelog

Introduced in 5.0.1. 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 6.8.8 tag, from src/wp-admin/includes/post.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.