WP_HTTP_IXR_Client::query( $args ): bool

Compatibility

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

Parameters

$args

Return value

bool

True if the request succeeded, false otherwise.

Performance profile

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

Expensive

Reaches an outbound HTTP request via wp_safe_remote_post().

Scaling

Scales with input

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

Instructions

71–111

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

Plugin surface

1 hook

Third-party callbacks on 'wp_http_ixr_client_headers' run inside this call, and their cost is not bounded by anything here.

Called by

0

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

What it touches

• sqldatabase queryWP_HTTP_IXR_Client::query()this function does it
• hookthird-party callbacksapply_filters()called directly
• httpoutbound HTTP requestwp_safe_remote_post()called directly

What one call costs · 8 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while WP_HTTP_IXR_Client::query() runs, in this order:

1. 1
   apply_filters( wp_http_ixr_client_headers )filterline 81 (+25 into the body)

   Filters the headers collection to be sent to the XML-RPC server.

Uses · 8

• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_safe_remote_post()Retrieves the raw response from a safe HTTP request using the POST method.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_remote_retrieve_response_code()Retrieves only the response code from the raw response.
• wp_remote_retrieve_body()Retrieves only the body from the raw response.
• IXR_Request::__construct()PHP5 constructor.
• IXR_Error::__construct()PHP5 constructor.
• IXR_Message::__construct()PHP5 constructor.

Source code

View on Trac ↗View on GitHub ↗

56	public function query( ...$args ) {57		$method  = array_shift( $args );58		$request = new IXR_Request( $method, $args );59		$xml     = $request->getXml();60 61		$port = $this->port ? ":$this->port" : '';62		$url  = $this->scheme . '://' . $this->server . $port . $this->path;63		$args = array(64			'headers'    => array( 'Content-Type' => 'text/xml' ),65			'user-agent' => $this->useragent,66			'body'       => $xml,67		);68 69		// Merge Custom headers ala #8145.70		foreach ( $this->headers as $header => $value ) {71			$args['headers'][ $header ] = $value;72		}73 74		/**75		 * Filters the headers collection to be sent to the XML-RPC server.76		 *77		 * @since 4.4.078		 *79		 * @param string[] $headers Associative array of headers to be sent.80		 */81		$args['headers'] = apply_filters( 'wp_http_ixr_client_headers', $args['headers'] );82 83		if ( false !== $this->timeout ) {84			$args['timeout'] = $this->timeout;85		}86 87		// Now send the request.88		if ( $this->debug ) {89			echo '<pre class="ixr_request">' . htmlspecialchars( $xml ) . "\n</pre>\n\n";90		}91 92		$response = wp_safe_remote_post( $url, $args );93 94		if ( is_wp_error( $response ) ) {95			$errno       = $response->get_error_code();96			$errorstr    = $response->get_error_message();97			$this->error = new IXR_Error( -32300, "transport error: $errno $errorstr" );98			return false;99		}100 101		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {102			$this->error = new IXR_Error( -32301, 'transport error - HTTP status code was not 200 (' . wp_remote_retrieve_response_code( $response ) . ')' );103			return false;104		}105 106		if ( $this->debug ) {107			echo '<pre class="ixr_response">' . htmlspecialchars( wp_remote_retrieve_body( $response ) ) . "\n</pre>\n\n";108		}109 110		// Now parse what we've got back.111		$this->message = new IXR_Message( wp_remote_retrieve_body( $response ) );112		if ( ! $this->message->parse() ) {113			// XML error.114			$this->error = new IXR_Error( -32700, 'parse error. not well formed' );115			return false;116		}117 118		// Is the message a fault?119		if ( 'fault' === $this->message->messageType ) {120			$this->error = new IXR_Error( $this->message->faultCode, $this->message->faultString );121			return false;122		}123 124		// Message must be OK.125		return true;126	}

Changelog

Introduced in 3.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 7.0.4 tag, from src/wp-includes/class-wp-http-ixr-client.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.