How to use automatic_updates_complete action in WordPress

automatic_updates_complete action

Fires after all automatic updates have run.

To use the automatic_updates_complete 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 execute_on_automatic_updates_complete_event which takes 1 parameter and we registered it using add_action. The first parameter automatic_updates_complete is the name of the hook, the second parameter execute_on_automatic_updates_complete_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 the automatic_updates_complete action.

Parameters

Below the 1 parameter is required to use this hook.

• $update_results : (array) The results of all attempted updates.

Live Example

Example 1: Registering the Hook

This example demonstrates how to register the automatic_updates_complete action.

  /**
   * Fires after all automatic updates have run.
   * Completes the update scheduled in background.
   *
   * @param  array  $update_results  The results of all attempted updates.
   *
   * @since  3.8.0
   */
  add_action( 'automatic_updates_complete', 'weplugins_auto_update_complete' ); 
  

Example 2: Executing Custom Function on Hook

Below is an example of how you can use this hook to execute a custom function.

  function weplugins_execute_on_automatic_updates_complete_event($update_results){
     // Code 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( "automatic_updates_complete", "weplugins_execute_on_automatic_updates_complete_event" , 10, 1);
  

Example 3: Removing the Hook

To remove a hook callback, use the example below.

  remove_action( "automatic_updates_complete", "weplugins_execute_on_automatic_updates_complete_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 or need customization, please contact our WordPress Development Team and we’d be happy to assist you.