wppaste
WordPress

WP_Http_Streams::test( array $args = array() ): bool

Since
2.7.0, 3.7.0
Source
wp-includes/class-wp-http-streams.php:495
Determines whether this class can be used for retrieving a URL.

Compatibility

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

Parameters

$argsarrayoptional
Array of request arguments. Default empty array.Default: array()

Return value

bool
False means this class can not be used, true means it can.

Performance profile

How much work a call to WP_Http_Streams::test() 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
9–11

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

Plugin surface
1 hook

Third-party callbacks on 'use_streams_transport' 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

  • hookthird-party callbacksapply_filters()called directly

What one call costs · 1 distinct outcome

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

WhenInstructionsCalls it makes
always9–11apply_filters()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 11 instructions, 9–11 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.

Hooks and filters fired · 1

One hook fires while WP_Http_Streams::test() runs, in this order:

  1. apply_filters( use_streams_transport )filterline 519 (+24 into the body)

    Filters whether streams can be used as a transport for retrieving a URL.

Uses · 1

  • apply_filters()Calls the callback functions that have been added to a filter hook.

Source code

	public static function test( $args = array() ) {		if ( ! function_exists( 'stream_socket_client' ) ) {			return false;		} 		$is_ssl = isset( $args['ssl'] ) && $args['ssl']; 		if ( $is_ssl ) {			if ( ! extension_loaded( 'openssl' ) ) {				return false;			}			if ( ! function_exists( 'openssl_x509_parse' ) ) {				return false;			}		} 		/**		 * Filters whether streams can be used as a transport for retrieving a URL.		 *		 * @since 2.7.0		 *		 * @param bool  $use_class Whether the class can be used. Default true.		 * @param array $args      Request arguments.		 */		return apply_filters( 'use_streams_transport', true, $args );	}

Changelog

Introduced in 2.7.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.

3.7.0
Combined with the fsockopen transport and switched to stream_socket_client().from the docblock
2.7.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/class-wp-http-streams.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.