How to use http_api_transports filter in WordPress

http_api_transports filter

Filters which HTTP transports are available and in what order.

To use the http_api_transports filter, first you have to register it using add_filter. You can write this code into the functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function weplugins_modify_http_api_transports_defaults which takes 3 parameters and we registered using add_filter. The first parameter http_api_transports is the name of the hook, The second parameter weplugins_modify_http_api_transports_defaults is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_filter to remove the http_api_transports filter.

Parameters

Below are the 3 parameters required to use this hook.

• $transports : (string[]) Array of HTTP transports to check. Default array contains ‘curl’ and ‘streams’, in that order.
• $args : (array) HTTP request arguments.
• $url : (string) The URL to request.

Live Example

apply_filters( 'http_api_transports', string[] $transports, array $args, string $url )

Below is an example of how you can use this hook.

Example 1: Modify HTTP Transports

This example shows how to modify the default HTTP transports array.

    function weplugins_modify_http_api_transports_defaults($transports, $args, $url) { 
        // Update the $transports variable according to your website requirements and return this variable. You can modify the $transports variable conditionally too if you want.
        return $transports; 
    }
    // add the filter
    add_filter( "http_api_transports", "weplugins_modify_http_api_transports_defaults", 10, 3 );
    

Example 2: Conditional Transport Modification

This example demonstrates how to conditionally modify the HTTP transports based on the request URL.

    function weplugins_conditional_http_api_transports($transports, $args, $url) { 
        if (strpos($url, 'example.com') !== false) {
            $transports = array('curl');
        }
        return $transports; 
    }
    // add the filter
    add_filter( "http_api_transports", "weplugins_conditional_http_api_transports", 10, 3 );
    

Example 3: Remove a Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "http_api_transports", "weplugins_modify_http_api_transports_defaults", 10, 3 );
    

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Contact Us

If you need customization or are having any trouble using this hook, please contact us and we’d be happy to assist you.