How to use refresh_blog_details action in WordPress

refresh_blog_details action

Fires after the blog details cache is cleared.

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

Parameters

Below is the 1 parameter required to use this hook.

• $blog_id : (int) Blog ID.

Live Examples

Example 1: Basic Hook Usage

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

  function weplugins_execute_on_refresh_blog_details_event($blog_id) {
    // You can write code here to be executed when this action occurs in WordPress.
    // Use the parameters received in the function arguments and implement the required
    // additional custom functionality according to your website requirements.
  }
  // Add the action
  add_action("refresh_blog_details", "weplugins_execute_on_refresh_blog_details_event", 10, 1);
  

Example 2: Removing the Hook

To remove a hook callback, use the example below.

  remove_action("refresh_blog_details", "weplugins_execute_on_refresh_blog_details_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 Blog Details Refresh

This example adds some custom functionality to be executed when the blog details are refreshed.

  function weplugins_custom_function_on_blog_details_refresh($blog_id) {
    // Custom functionality code here
    error_log("Blog details for blog ID {$blog_id} have been refreshed.");
  }
  // Add the action
  add_action("refresh_blog_details", "weplugins_custom_function_on_blog_details_refresh", 10, 1);
  

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.