How to use admin_viewport_meta filter in WordPress

admin_viewport_meta Filter

Filters the viewport meta in the admin.

To use the admin_viewport_meta 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_admin_viewport_meta_defaults which takes 1 parameter and we registered using add_filter. The first parameter admin_viewport_meta is the name of the hook, the second parameter weplugins_modify_admin_viewport_meta_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 admin_viewport_meta filter.

Parameters

Below the 1 parameter is required to use this hook.

• $viewport_meta : (string) The viewport meta.

Live Example

apply_filters( ‘admin_viewport_meta’, string $viewport_meta )

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

Example 1: Modifying the Viewport Meta

In this example, we modify the viewport meta for the admin.

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

Example 2: Removing the Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "admin_viewport_meta", "weplugins_modify_admin_viewport_meta_defaults", 10, 1 );
    

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

Example 3: Conditional Modification of Viewport Meta

In this example, we modify the viewport meta conditionally based on some criteria.

    function weplugins_conditional_modify_admin_viewport_meta($viewport_meta) { 
        // Check some condition
        if ( some_condition() ) {
            // Modify $viewport_meta if condition is met
            $viewport_meta = 'new_value';
        }
        return $viewport_meta; 
    }
    // add the filter
    add_filter( "admin_viewport_meta", "weplugins_conditional_modify_admin_viewport_meta", 10, 1 );