WP_Ajax_Response::add( string|array $args = '' ): string

Description

<response action='{$action}_$id'>
 <$what id='$id' position='$position'>
 <response_data><![CDATA[$data]]></response_data>
 </$what>
</response>

Compatibility

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

Parameters

$argsstring|arrayoptional

An array or string of XML response arguments.Default: ''

• $whatstringdefault: 'object' (<object>)

  XML-RPC response type. Used as a child element of <response>.

• $actionstring|falsedefault: false

  Value to use for the action attribute in <response>. Will be appended with _$id on output. If false, $action will default to the value of $_POST['action'].

• $idint|WP_Errordefault: 0

  The response ID, used as the response type id attribute. Also accepts a WP_Error object if the ID does not exist.

• $old_idint|falsedefault: false

  The previous response ID. Used as the value for the response type old_id attribute. False hides the attribute.

• $positionstringdefault: 1 (bottom)

  Value of the response type position attribute. Accepts 1 (bottom), -1 (top), HTML ID (after), or -HTML ID (before).

• $datastring|WP_Errordefault: empty

  The response content/message. Also accepts a WP_Error object if the ID does not exist.

• $supplementalarraydefault: empty array

  An array of extra strings that will be output within a <supplemental> element as CDATA.

Return value

string

XML response.

Performance profile

How much work a call to WP_Ajax_Response::add() 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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

67–83

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place 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_Ajax_Response::add()

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

Uses · 2

• wp_parse_args()Merges user defined arguments into defaults array.
• is_wp_error()Checks whether the given variable is a WordPress Error.

Used by · 1

• WP_Ajax_Response::__construct()Constructor - Passes args to WP_Ajax_Response::add().

Source code

View on Trac ↗View on GitHub ↗

67	public function add( $args = '' ) {68		$defaults = array(69			'what'         => 'object',70			'action'       => false,71			'id'           => '0',72			'old_id'       => false,73			'position'     => 1,74			'data'         => '',75			'supplemental' => array(),76		);77 78		$parsed_args = wp_parse_args( $args, $defaults );79 80		$position = preg_replace( '/[^a-z0-9:_-]/i', '', $parsed_args['position'] );81		$id       = $parsed_args['id'];82		$what     = $parsed_args['what'];83		$action   = $parsed_args['action'];84		$old_id   = $parsed_args['old_id'];85		$data     = $parsed_args['data'];86 87		if ( is_wp_error( $id ) ) {88			$data = $id;89			$id   = 0;90		}91 92		$response = '';93		if ( is_wp_error( $data ) ) {94			foreach ( (array) $data->get_error_codes() as $code ) {95				$response  .= "<wp_error code='$code'><![CDATA[" . $data->get_error_message( $code ) . ']]></wp_error>';96				$error_data = $data->get_error_data( $code );97				if ( ! $error_data ) {98					continue;99				}100				$class = '';101				if ( is_object( $error_data ) ) {102					$class      = ' class="' . get_class( $error_data ) . '"';103					$error_data = get_object_vars( $error_data );104				}105 106				$response .= "<wp_error_data code='$code'$class>";107 108				if ( is_scalar( $error_data ) ) {109					$response .= "<![CDATA[$error_data]]>";110				} elseif ( is_array( $error_data ) ) {111					foreach ( $error_data as $k => $v ) {112						$response .= "<$k><![CDATA[$v]]></$k>";113					}114				}115 116				$response .= '</wp_error_data>';117			}118		} else {119			$response = "<response_data><![CDATA[$data]]></response_data>";120		}121 122		$s = '';123		if ( is_array( $parsed_args['supplemental'] ) ) {124			foreach ( $parsed_args['supplemental'] as $k => $v ) {125				$s .= "<$k><![CDATA[$v]]></$k>";126			}127			$s = "<supplemental>$s</supplemental>";128		}129 130		if ( false === $action ) {131			$action = $_POST['action'];132		}133		$x  = '';134		$x .= "<response action='{$action}_$id'>"; // The action attribute in the xml output is formatted like a nonce action.135		$x .= "<$what id='$id' " . ( false === $old_id ? '' : "old_id='$old_id' " ) . "position='$position'>";136		$x .= $response;137		$x .= $s;138		$x .= "</$what>";139		$x .= '</response>';140 141		$this->responses[] = $x;142		return $x;143	}

Changelog

Introduced in 2.1.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 6.8.8 tag, from src/wp-includes/class-wp-ajax-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.