How to use get_space_allowed filter in WordPress

get_space_allowed filter

Filters the upload quota for the current site.

To use the get_space_allowed filter, first you have to register it using add_filter. You can write this code into 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_get_space_allowed_defaults which takes 1 parameter and we registered using add_filter. The first parameter get_space_allowed is the name of the hook, the second parameter weplugins_modify_get_space_allowed_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 get_space_allowed filter.

Parameters

Below the 1 parameter is required to use this hook.

• $space_allowed : (int) Upload quota in megabytes for the current blog.

Live Example 1: Basic Usage

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

    function weplugins_modify_get_space_allowed_defaults($space_allowed) { 
        // Update the $space_allowed variable according to your website requirements and return this variable. You can modify the $space_allowed variable conditionally too if you want.
        return $space_allowed; 
    }
    // add the filter
    add_filter( "get_space_allowed", "weplugins_modify_get_space_allowed_defaults", 10, 1 );

Live Example 2: Conditional Modification

Here’s how you can conditionally modify the upload quota.

    function weplugins_conditional_modify_get_space_allowed($space_allowed) { 
        if ( current_user_can( 'administrator' ) ) {
            $space_allowed = 1000; // Set the limit to 1000MB for admins
        }
        return $space_allowed; 
    }
    // add the filter
    add_filter( "get_space_allowed", "weplugins_conditional_modify_get_space_allowed", 10, 1 );

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter( "get_space_allowed", "weplugins_modify_get_space_allowed_defaults", 10, 1 );

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

Contact Us

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.