WP_Http_Encoding::accept_encoding() WordPress Method

The Wordpress WP_Http_Encoding::accept_encoding() method is used to get the list of encodings that the current user agent accepts.

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

What encoding types to accept and their priority values.


Parameters

$url

(string)(Required)

$args

(array)(Required)


Top ↑

Return

(string) Types of encoding to accept.


Top ↑

Source

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

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


Top ↑

Changelog

Changelog
VersionDescription
2.8.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.