How to use pre_user_search action in WordPress

pre_user_search action

To use the pre_user_search action, first you have to register it using add_action. You can write this code into the functions.php of your activated theme or in a custom WordPress Plugin. At WePlugins, we 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_pre_user_search_event and we registered it using add_action. The first parameter pre_user_search is the name of the hook, the second parameter weplugins_execute_on_pre_user_search_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 pre_user_search action.

Example 1: Registering the Hook

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

    function weplugins_execute_on_pre_user_search_event() {
        // You can write code here to be executed when this action occurs in WordPress website according to your requirements.
    }
    // add the action
    add_action("pre_user_search", "weplugins_execute_on_pre_user_search_event");
    

Example 2: Removing the Hook

To remove a hook callback, use the example below.

    remove_action("pre_user_search", "weplugins_execute_on_pre_user_search_event");
    

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

Example 3: Customizing the Hook

You may want to customize what happens when the pre_user_search hook is triggered. Here’s a simple example of how you can modify the user search query.

    function weplugins_custom_pre_user_search($query) {
        // Modify the query as per your need.
        $query->set('meta_key', 'custom_field');
    }
    add_action("pre_user_search", "weplugins_custom_pre_user_search");
    

Contact Us

If you’re having any trouble using this hook or need customization, please Contact Us and we’d be happy to assist you.