WP_Http_Streams::test() WordPress Method

The WP_Http_Streams::test() method is used to test whether a stream is available.

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

Determines whether this class can be used for retrieving a URL.


Parameters

$args

(array)(Optional) Array of request arguments.

Default value: array()


Top ↑

Return

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


Top ↑

Source

File: wp-includes/class-wp-http-streams.php

	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 );
	}


Top ↑

Changelog

Changelog
VersionDescription
3.7.0Combined with the fsockopen transport and switched to stream_socket_client().
2.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.