How to use get_template_part action in WordPress

get_template_part action

Fires before an attempt is made to locate and load a template part.

To use get_template_part 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_get_template_part_event which takes 4 parameters and we registered using add_action. The first parameter get_template_part is the name of the hook, The second parameter weplugins_execute_on_get_template_part_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 get_template_part action.

Parameters

Below are the 4 parameters required to use this hook.

• $slug : (string) The slug name for the generic template.
• $name : (string) The name of the specialized template.
• $templates : (string[]) Array of template files to search for, in order.
• $args : (array) Additional arguments passed to the template.

Live Examples

Example 1: Basic Usage

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

    function weplugins_execute_on_get_template_part_event($slug, $name, $templates, $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( "get_template_part", "weplugins_execute_on_get_template_part_event" , 10, 4);
    

Example 2: Removing the Hook

To remove a hook callback, use the example below.

    remove_action( "get_template_part", "weplugins_execute_on_get_template_part_event", 10, 4 );
    

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

Example 3: Custom Functionality

Here’s an example where we log the template part details for debugging purposes.

    function weplugins_log_template_part($slug, $name, $templates, $args){
        error_log("Template Part Loaded: Slug = $slug, Name = $name");
    }
    // add the action
    add_action( "get_template_part", "weplugins_log_template_part" , 10, 4);
    

Contact Us

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