W3cubDocs

/WordPress

WP_SimplePie_File::__construct( string $url, integer $timeout = 10, integer $redirects = 5, string|array $headers = null, string $useragent = null, boolean $force_fsockopen = false )

Constructor.

Parameters

$url

(string) (Required) Remote file URL.

$timeout

(integer) (Optional) How long the connection should stay open in seconds.

Default value: 10

$redirects

(integer) (Optional) The number of allowed redirects.

Default value: 5

$headers

(string|array) (Optional) Array or string of headers to send with the request.

Default value: null

$useragent

(string) (Optional) User-agent value sent.

Default value: null

$force_fsockopen

(boolean) (Optional) Whether to force opening internet or unix domain socket connection or not.

Default value: false

Source

File: wp-includes/class-wp-simplepie-file.php

public function __construct( $url, $timeout = 10, $redirects = 5, $headers = null, $useragent = null, $force_fsockopen = false ) {
		$this->url       = $url;
		$this->timeout   = $timeout;
		$this->redirects = $redirects;
		$this->headers   = $headers;
		$this->useragent = $useragent;

		$this->method = SIMPLEPIE_FILE_SOURCE_REMOTE;

		if ( preg_match( '/^http(s)?:\/\//i', $url ) ) {
			$args = array(
				'timeout'     => $this->timeout,
				'redirection' => $this->redirects,
			);

			if ( ! empty( $this->headers ) ) {
				$args['headers'] = $this->headers;
			}

			if ( SIMPLEPIE_USERAGENT != $this->useragent ) { // Use default WP user agent unless custom has been specified.
				$args['user-agent'] = $this->useragent;
			}

			$res = wp_safe_remote_request( $url, $args );

			if ( is_wp_error( $res ) ) {
				$this->error   = 'WP HTTP Error: ' . $res->get_error_message();
				$this->success = false;
			} else {
				$this->headers     = wp_remote_retrieve_headers( $res );
				$this->body        = wp_remote_retrieve_body( $res );
				$this->status_code = wp_remote_retrieve_response_code( $res );
			}
		} else {
			$this->error   = '';
			$this->success = false;
		}
	}

Changelog

Version Description
3.2.0 Updated to use a PHP5 constructor.
2.8.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_simplepie_file/__construct