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

Compatibility

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

Parameters

$urlstring

Remote file URL.

$timeoutintoptional

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

$redirectsintoptional

The number of allowed redirects. Default 5.Default: 5

$headersstring|arrayoptional

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

$useragentstringoptional

User-agent value sent. Default null.Default: null

$force_fsockopenbooloptional

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

Performance profile

How much work a call to WP_SimplePie_File::__construct() 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_request().

Scaling

Scales with input

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

Instructions

26–76

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

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

What it touches

• httpoutbound HTTP requestwp_safe_remote_request()called directly
• hookthird-party callbacksdo_action()one call below WP_SimplePie_File::__construct()

What one call costs · 4 distinct outcomes

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

Uses · 6

• wp_safe_remote_request()Retrieves the raw response from a safe HTTP request.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_remote_retrieve_headers()Retrieves only the headers from the raw response.
• wp_remote_retrieve_body()Retrieves only the body from the raw response.
• wp_remote_retrieve_response_code()Retrieves only the response code from the raw response.
• \SimplePie\Misc::get_default_useragent()

Source code

View on Trac ↗View on GitHub ↗

46	public function __construct( $url, $timeout = 10, $redirects = 5, $headers = null, $useragent = null, $force_fsockopen = false ) {47		$this->url       = $url;48		$this->timeout   = $timeout;49		$this->redirects = $redirects;50		$this->headers   = $headers;51		$this->useragent = $useragent;52 53		$this->method = SimplePie\SimplePie::FILE_SOURCE_REMOTE;54 55		if ( preg_match( '/^http(s)?:\/\//i', $url ) ) {56			$args = array(57				'timeout'     => $this->timeout,58				'redirection' => $this->redirects,59			);60 61			if ( ! empty( $this->headers ) ) {62				$args['headers'] = $this->headers;63			}64 65			if ( SimplePie\Misc::get_default_useragent() !== $this->useragent ) { // Use default WP user agent unless custom has been specified.66				$args['user-agent'] = $this->useragent;67			}68 69			$res = wp_safe_remote_request( $url, $args );70 71			if ( is_wp_error( $res ) ) {72				$this->error   = 'WP HTTP Error: ' . $res->get_error_message();73				$this->success = false;74 75			} else {76				$this->headers = wp_remote_retrieve_headers( $res );77 78				if ( $this->headers instanceof \WpOrg\Requests\Utility\CaseInsensitiveDictionary ) {79					$this->headers = $this->headers->getAll();80				}81 82				/*83				 * SimplePie expects multiple headers to be stored as a comma-separated string,84				 * but `wp_remote_retrieve_headers()` returns them as an array, so they need85				 * to be converted.86				 *87				 * The only exception to that is the `content-type` header, which should ignore88				 * any previous values and only use the last one.89				 *90				 * @see SimplePie\HTTP\Parser::new_line().91				 */92				foreach ( $this->headers as $name => $value ) {93					if ( ! is_array( $value ) ) {94						continue;95					}96 97					if ( 'content-type' === $name ) {98						$this->headers[ $name ] = array_pop( $value );99					} else {100						$this->headers[ $name ] = implode( ', ', $value );101					}102				}103 104				$this->body        = wp_remote_retrieve_body( $res );105				$this->status_code = wp_remote_retrieve_response_code( $res );106			}107		} else {108			$this->error   = '';109			$this->success = false;110		}111	}

Changelog

Introduced in 2.8.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.1.0 tag, from src/wp-includes/class-wp-simplepie-file.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.