How to use loop_end action in WordPress

loop_end action

Fires once the loop has ended.

To use loop_end 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.

WePlugins always prefers 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_loop_end_event which takes 1 parameter and we registered it using add_action. The first parameter loop_end is the name of the hook, the second parameter weplugins_execute_on_loop_end_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 loop_end action.

Parameters

Below the 1 parameter is required to use this hook.

• $query : (WP_Query) The WP_Query instance (passed by reference).

Live Example

Example 1: Basic Hook Usage

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

  function weplugins_execute_on_loop_end_event($query){
     // Code to be executed when this action occurs in WordPress.
  }
  // Add the action
  add_action( "loop_end", "weplugins_execute_on_loop_end_event" , 10, 1);
  

Example 2: Removing a Hook

To remove a hook callback, use the example below.

  remove_action( "loop_end", "weplugins_execute_on_loop_end_event", 10, 1 );
  

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

Example 3: Custom Functionality on Loop End

In this example, we add custom functionality to be executed when the loop ends.

  function weplugins_custom_loop_end_function($query){
     // Add your custom code here
     if($query->is_main_query()){
        // Perform some custom action
     }
  }
  add_action( "loop_end", "weplugins_custom_loop_end_function" , 10, 1);
  

Contact Us

If you need any customization or have trouble using this hook, please contact us.