This website uses cookies so that we can provide you with the best user experience possible. Cookie information is stored in your browser and performs functions such as recognising you when you return to our website and helping our team to understand which sections of the website you find most interesting and useful.
Let’s dive into the world of WordPress hooks with the add_site_option_option action. This hook is super handy when you want to execute some custom functionality whenever a site option is added in a multisite network. The dynamic portion of the hook name, $option, refers to the option name. To use this hook, first register it using add_action
. You can write this code into the functions.php of your activated theme or in a custom WordPress Plugin. WePlugins recommends creating a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.
In the examples below, we’ve defined a function weplugins_execute_on_add_site_option_option_event
which takes 3 parameters, and we registered it using add_action
. The first parameter add_site_option_option is the name of the hook, the second parameter weplugins_execute_on_add_site_option_option_event is the name of the function that 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 add_site_option_option action.
Example 1: Basic Hook Registration
Here’s how you can register a hook using add_site_option_option
.
function weplugins_execute_on_add_site_option_option_event($option, $value, $network_id){ // Code to execute when this action occurs } // Add the action add_action( "add_site_option_option", "weplugins_execute_on_add_site_option_option_event", 10, 3);
Example 2: Removing a Hook Callback
To remove a hook callback, use the example below.
remove_action( "add_site_option_option", "weplugins_execute_on_add_site_option_option_event", 10, 3 );
Make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.
Example 3: Dynamic Hook Usage
This example shows how you can use the dynamic aspect of the hook name.
do_action( "add_site_option_{$option}", string $option, mixed $value, int $network_id );
Below is an example of how you can use this hook.
function weplugins_dynamic_execute_on_add_site_option($option, $value, $network_id){ // Custom functionality based on dynamic option } add_action( "add_site_option_{$option}", "weplugins_dynamic_execute_on_add_site_option", 10, 3 );
Contact Us
If you’re having any trouble using this hook or need customization, feel free to Contact Us. We’re here to help you out with any WordPress development needs!
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.