How to use register_post_type_post_type_args filter in WordPress

register_post_type_post_type_args filter

The dynamic portion of the filter name, $post_type, refers to the post type key.

To use register_post_type_post_type_args filter, first you have to register it using add_filter. 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 modify_register_post_type_post_type_args_defaults which takes 2 parameters and we registered using add_filter. The first parameter register_post_type_post_type_args is the name of the hook, The second parameter modify_register_post_type_post_type_args_defaults 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_filter to remove register_post_type_post_type_args filter.

Parameters

Below are the 2 parameters required to use this hook.

• $args: (array) Array of arguments for registering a post type. See the register_post_type() function for accepted arguments.
• $post_type: (string) Post type key.

Live Example 1: Basic Usage

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

function weplugins_modify_register_post_type_post_type_args_defaults($args, $post_type) { 

    // Update the $args variable according to your website requirements and return this variable. You can modify the $args variable conditionally too if you want.

    return $args; 
}
// Add the filter
add_filter( "register_post_type_post_type_args", "weplugins_modify_register_post_type_post_type_args_defaults", 10, 2 );

Live Example 2: Conditional Modification

In this example, we modify the arguments based on the post type.

function weplugins_modify_register_post_type_post_type_args_defaults($args, $post_type) { 
    if ( 'book' === $post_type ) {
        // Modify the args for 'book' post type
        $args['public'] = true;
    }
    return $args; 
}
// Add the filter
add_filter( "register_post_type_post_type_args", "weplugins_modify_register_post_type_post_type_args_defaults", 10, 2 );

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

remove_filter( "register_post_type_post_type_args", "weplugins_modify_register_post_type_post_type_args_defaults", 10, 2 );

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

Contact Us

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