WP_SimplePie_File::__construct() │ public │ WP 2.8.0

Constructor.

Method of the class: WP_SimplePie_File{}

No Hooks.

Return

null. Nothing (null).

Usage

$WP_SimplePie_File = new WP_SimplePie_File();
$WP_SimplePie_File->__construct( $url, $timeout, $redirects, $headers, $useragent, $force_fsockopen );

$url(string) (required)

Remote file URL.

$timeout(int)

How long the connection should stay open in seconds.
Default: 10

$redirects(int)

The number of allowed redirects.
Default: 5

$headers(string|array)

Array or string of headers to send with the request.
Default: null

$useragent(string)

User-agent value sent.
Default: null

$force_fsockopen(true|false)

Whether to force opening internet or unix domain socket connection or not.
Default: false

Changelog

WP_SimplePie_File::__construct() WP SimplePie File:: construct code ^{WP 6.5.2}

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

			/*
			 * SimplePie expects multiple headers to be stored as a comma-separated string,
			 * but `wp_remote_retrieve_headers()` returns them as an array, so they need
			 * to be converted.
			 *
			 * The only exception to that is the `content-type` header, which should ignore
			 * any previous values and only use the last one.
			 *
			 * @see SimplePie_HTTP_Parser::new_line().
			 */
			foreach ( $this->headers as $name => $value ) {
				if ( ! is_array( $value ) ) {
					continue;
				}

				if ( 'content-type' === $name ) {
					$this->headers[ $name ] = array_pop( $value );
				} else {
					$this->headers[ $name ] = implode( ', ', $value );
				}
			}

			$this->body        = wp_remote_retrieve_body( $res );
			$this->status_code = wp_remote_retrieve_response_code( $res );
		}
	} else {
		$this->error   = '';
		$this->success = false;
	}
}