How to use pre_get_search_form action in WordPress

pre_get_search_form action

Fires before the search form is retrieved, at the start of get_search_form().

To use the pre_get_search_form 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.

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_get_search_form_event which takes 1 parameter and we registered using add_action. The first parameter pre_get_search_form is the name of the hook, the second parameter weplugins_execute_on_pre_get_search_form_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 pre_get_search_form action.

Parameters

Below the 1 parameter is required to use this hook.

• $args : (array) The array of arguments for building the search form. See get_search_form() for information on accepted arguments.

Live Examples

Example 1: Basic Usage

Below is an example of how you can use this hook to add custom functionality before the search form is retrieved.

	function weplugins_execute_on_pre_get_search_form_event($args){
	   // You can write code here 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( "pre_get_search_form", "weplugins_execute_on_pre_get_search_form_event" , 10, 1);
	

Example 2: Modifying Search Form Arguments

This example demonstrates how to modify the search form arguments before the form is displayed.

	function weplugins_modify_search_form_args($args) {
	    $args['aria_label'] = 'Custom Search';
	    return $args;
	}
	// Add the action
	add_action( "pre_get_search_form", "weplugins_modify_search_form_args", 10, 1);
	

Example 3: Removing the Hook Callback

To remove a hook callback, use the example below.

	remove_action( "pre_get_search_form", "weplugins_execute_on_pre_get_search_form_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 need any customization or have any questions, please don’t hesitate to contact us.