How to use block_editor_meta_box_hidden_fields action in WordPress

block_editor_meta_box_hidden_fields action

Hook into this action to print fields, which will be POSTed back to the server when meta boxes are saved.

To use the block_editor_meta_box_hidden_fields action, first, you have to register it using add_action. 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_execute_on_block_editor_meta_box_hidden_fields_event which takes 1 parameter and we registered it using add_action. The first parameter block_editor_meta_box_hidden_fields is the name of the hook, the second parameter weplugins_execute_on_block_editor_meta_box_hidden_fields_event is the name of the function that 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_action to remove the block_editor_meta_box_hidden_fields action.

Parameters

Below the 1 parameter is required to use this hook.

• $post: (WP_Post) The post that is being edited.

Live Example 1

Below is a simple example of how you can use this hook to add hidden fields.

    add_action( 'block_editor_meta_box_hidden_fields', 'weplugins_add_gutenberg_hidden_fields', 10, 1 );
    function weplugins_add_gutenberg_hidden_fields( $post ) {
         echo '<input type="hidden" name="your-field" value="some-value">';
         echo '<input type="hidden" name="is_gutenberg_post" value="1">';
    }
    

Live Example 2

You can also create a custom function to execute specific code when this action occurs.

    function weplugins_execute_on_block_editor_meta_box_hidden_fields_event($post){
       // Write your custom code here that you want to execute when the action occurs.
    }
    // add the action
    add_action( "block_editor_meta_box_hidden_fields", "weplugins_execute_on_block_editor_meta_box_hidden_fields_event" , 10, 1);
    

Live Example 3

To remove a hook callback, use the example below.

    remove_action( "block_editor_meta_box_hidden_fields", "weplugins_execute_on_block_editor_meta_box_hidden_fields_event", 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.