How to use page_attributes_meta_box_template action in WordPress

page_attributes_meta_box_template action

Fires immediately after the label inside the ‘Template’ section of the ‘Page Attributes’ meta box.
To use `page_attributes_meta_box_template` 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 `execute_on_page_attributes_meta_box_template_event` which takes 2 parameters and we registered using `add_action`. The first parameter `page_attributes_meta_box_template` is the name of the hook, The second parameter `execute_on_page_attributes_meta_box_template_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 `page_attributes_meta_box_template` action.

Parameters

Below are the 2 parameters required to use this hook.

• $template : (string|false) The template used for the current post.
• $post : (WP_Post) The current post.

Live Example 1

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

	function weplugins_execute_on_page_attributes_meta_box_template_event($template, $post){
	   //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( "page_attributes_meta_box_template", "weplugins_execute_on_page_attributes_meta_box_template_event" , 10, 2);
	

Live Example 2

To remove a hook callback, use the example below.

	remove_action( "page_attributes_meta_box_template", "weplugins_execute_on_page_attributes_meta_box_template_event", 10, 2 );
	

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

Live Example 3

Here’s another example demonstrating a different use case.

	function weplugins_custom_template_logic($template, $post){
	    if($post->post_type == 'page' && $template === 'my-custom-template.php'){
	        // Custom logic for specific template
	    }
	}
	add_action("page_attributes_meta_box_template", "weplugins_custom_template_logic", 10, 2);
	

Contact Us

If you need any customization or are facing issues, feel free to Contact Us.