Exciting News! Flipper Code is now WePlugins! Same commitment to excellence, brand new identity.

How to use block_editor_rest_api_preload_paths filter in WordPress

Sandeep Kumar Mishra
Sandeep Kumar Mishra
July 12, 2022
5 minutes read
Share Via:

block_editor_rest_api_preload_paths filter

Filters the array of REST API paths that will be used to preloaded common data for the block editor.

To use block_editor_rest_api_preload_paths 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 Flipper Code, 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_block_editor_rest_api_preload_paths_defaults which takes 2 parameters and we registered using add_filter. The first parameter block_editor_rest_api_preload_paths is name of the hook, The second parameter modify_block_editor_rest_api_preload_paths_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometime, you have to remove a registered hook so you can use remove_filter to remove block_editor_rest_api_preload_paths filter.

Parameters

    Below are the 2 parameters are required to use this hook.

  • $preload_paths : (string[]) Array of paths to preload.
  • $block_editor_context : (WP_Block_Editor_Context) The current block editor context.

Live Example

apply_filters( 'block_editor_rest_api_preload_paths', string[] $preload_paths, WP_Block_Editor_Context $block_editor_context )

Below is an example how you can use this hook.

                        function modify_block_editor_rest_api_preload_paths_defaults($preload_paths, $block_editor_context) { 
   
                            // Update the $preload_paths variable according to your website requirements and return this variable. You can modify the $preload_paths variable conditionally too if you want.

                            return $preload_paths; 
                        }
                        // add the filter
                        add_filter( "block_editor_rest_api_preload_paths", "modify_block_editor_rest_api_preload_paths_defaults", 10, 2 );

To remove a hook callback, use the example below.

remove_filter( "block_editor_rest_api_preload_paths", "modify_block_editor_rest_api_preload_paths_defaults", 10, 2 );

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

Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.

Explore the latest in WordPress

Trying to stay on top of it all? Get the best tools, resources and inspiration sent to your inbox every Wednesday.