WP_Http_Encoding::accept_encoding( string $url, array $args ): string

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

$argsarray

Return value

string

Types of encoding to accept.

Performance profile

How much work a call to WP_Http_Encoding::accept_encoding() 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

20–24

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

Plugin surface

1 hook

Third-party callbacks on 'wp_http_accept_encoding' 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_Encoding::accept_encoding() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while WP_Http_Encoding::accept_encoding() runs, in this order:

1. 1
   apply_filters( wp_http_accept_encoding )filterline 184 (+35 into the body)

   Filters the allowed encoding types.

Uses · 2

• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Http_Encoding::is_available()Whether decompression and compression are supported by the PHP version.

Source code

View on Trac ↗View on GitHub ↗

149	public static function accept_encoding( $url, $args ) {150		$type                = array();151		$compression_enabled = self::is_available();152 153		if ( ! $args['decompress'] ) { // Decompression specifically disabled.154			$compression_enabled = false;155		} elseif ( $args['stream'] ) { // Disable when streaming to file.156			$compression_enabled = false;157		} elseif ( isset( $args['limit_response_size'] ) ) { // If only partial content is being requested, we won't be able to decompress it.158			$compression_enabled = false;159		}160 161		if ( $compression_enabled ) {162			if ( function_exists( 'gzinflate' ) ) {163				$type[] = 'deflate;q=1.0';164			}165 166			if ( function_exists( 'gzuncompress' ) ) {167				$type[] = 'compress;q=0.5';168			}169 170			if ( function_exists( 'gzdecode' ) ) {171				$type[] = 'gzip;q=0.5';172			}173		}174 175		/**176		 * Filters the allowed encoding types.177		 *178		 * @since 3.6.0179		 *180		 * @param string[] $type Array of what encoding types to accept and their priority values.181		 * @param string   $url  URL of the HTTP request.182		 * @param array    $args HTTP request arguments.183		 */184		$type = apply_filters( 'wp_http_accept_encoding', $type, $url, $args );185 186		return implode( ', ', $type );187	}

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 6.9.7 tag, from src/wp-includes/class-wp-http-encoding.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.