How to use metadata_lazyloader_queued_objects action in WordPress

metadata_lazyloader_queued_objects action

Fires after objects are added to the metadata lazy-load queue.

To use metadata_lazyloader_queued_objects action, first you have to register it using add_action. 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_execute_on_metadata_lazyloader_queued_objects_event which takes 3 parameters and we registered using add_action. The first parameter metadata_lazyloader_queued_objects is the name of the hook, the second parameter weplugins_execute_on_metadata_lazyloader_queued_objects_event 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_action to remove metadata_lazyloader_queued_objects action.

Parameters

Below are the 3 parameters required to use this hook:

• $object_ids: (array) Array of object IDs.
• $object_type: (string) Type of object being queued.
• $lazyloader: (WP_Metadata_Lazyloader) The lazy-loader object.

Live Example 1: Registering the Hook

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

    function weplugins_execute_on_metadata_lazyloader_queued_objects_event($object_ids, $object_type, $lazyloader){
        // You can write code here to be executed when this action occurs in WordPress.
        // Use the parameters received in the function arguments & implement the required additional custom functionality according to your website requirements.
    }
    // add the action
    add_action("metadata_lazyloader_queued_objects", "weplugins_execute_on_metadata_lazyloader_queued_objects_event", 10, 3);
    

Live Example 2: Removing the Hook

To remove a hook callback, use the example below:

    remove_action("metadata_lazyloader_queued_objects", "weplugins_execute_on_metadata_lazyloader_queued_objects_event", 10, 3);
    

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

Live Example 3: Modifying the Hook Function

Here is an example of modifying the function to add custom logic:

    function weplugins_custom_logic_on_metadata_lazyloader($object_ids, $object_type, $lazyloader){
        // Custom logic based on $object_type
        if ($object_type == 'custom_type') {
            // Perform custom actions for 'custom_type'
        }
    }
    // add the action
    add_action("metadata_lazyloader_queued_objects", "weplugins_custom_logic_on_metadata_lazyloader", 10, 3);
    

Contact Us

If you need any customization or assistance with using this hook, feel free to contact us.