How to use default_hidden_meta_boxes filter in WordPress

default_hidden_meta_boxes filter

Filters the default list of hidden meta boxes.

To use default_hidden_meta_boxes 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 modify_default_hidden_meta_boxes_defaults which takes 2 parameters and we registered using add_filter. The first parameter default_hidden_meta_boxes is the name of the hook, the second parameter modify_default_hidden_meta_boxes_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 default_hidden_meta_boxes filter.

Parameters

Below are the 2 parameters required to use this hook.

• $hidden: (string[]) An array of IDs of meta boxes hidden by default.
• $screen: (WP_Screen) WP_Screen object of the current screen.

Live Example 1: Hide Meta Boxes

In this example, we are hiding several meta boxes for a custom post type.

    add_filter('default_hidden_meta_boxes','weplugins_hide_meta_box',10,2);
    function weplugins_hide_meta_box($hidden, $screen) {
        //make sure we are dealing with the correct screen
        if ( ('post' == $screen->base) && ('my-custom-post_type' == $screen->id) ){
            //lets hide everything
            $hidden = array('postexcerpt','slugdiv','postcustom','trackbacksdiv', 'commentstatusdiv', 'commentsdiv', 'authordiv', 'revisionsdiv');
            $hidden[] ='my_custom_meta_box'; //for custom meta box, enter the id used in the add_meta_box() function.
        }
        return $hidden;
    }
    

Live Example 2: Modify Hidden Meta Boxes

Below is an example of how you can use this hook to modify the hidden meta boxes.

    function weplugins_modify_default_hidden_meta_boxes_defaults($hidden, $screen) { 
        // Update the $hidden variable according to your website requirements and return this variable. You can modify the $hidden variable conditionally too if you want.
        return $hidden; 
    }
    // add the filter
    add_filter( "default_hidden_meta_boxes", "weplugins_modify_default_hidden_meta_boxes_defaults", 10, 2 );
    

Live Example 3: Remove Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "default_hidden_meta_boxes", "weplugins_modify_default_hidden_meta_boxes_defaults", 10, 2 );
    

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 or need customization, please Contact Us.