How to use edit_tag_form_fields action in WordPress

edit_tag_form_fields action

Fires after the Edit Tag form fields are displayed.

To use edit_tag_form_fields 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_edit_tag_form_fields_event which takes 1 parameter and we registered using add_action. The first parameter edit_tag_form_fields is the name of the hook, The second parameter weplugins_execute_on_edit_tag_form_fields_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 edit_tag_form_fields action.

Parameters

Below the 1 parameter is required to use this hook.

• $tag: (WP_Term) Current tag term object.

Live Example 1: Adding Custom Field

Below is an example of how you can use this hook to add a custom field.

function weplugins_execute_on_edit_tag_form_fields_event($tag){
    ?>
    <tr class="form-field">
        <th scope="row" valign="top"><label for="custom_field"><?php _e('Custom Field'); ?></label></th>
        <td>
            <input type="text" name="custom_field" id="custom_field" value="<?php echo esc_attr( get_term_meta($tag->term_id, 'custom_field', true) ); ?>" />
        </td>
    </tr>
    <?php
}
// add the action
add_action( "edit_tag_form_fields", "weplugins_execute_on_edit_tag_form_fields_event" , 10, 1);
&#91;/php&#93;

<h2>Live Example 2: Removing a Hook</h2>
<p>To remove a hook callback, use the example below.</p>

function weplugins_remove_custom_hook(){
    remove_action( "edit_tag_form_fields", "weplugins_execute_on_edit_tag_form_fields_event", 10, 1 );
}
add_action( 'admin_init', 'weplugins_remove_custom_hook' );

Live Example 3: Modifying Default Behavior

This example demonstrates modifying the default behavior of the tag form.

function weplugins_modify_tag_form_fields($tag){
    // Modify default behavior
    echo '<p>Modifying default behavior for tag: ' . $tag->name . '</p>';
}
add_action( "edit_tag_form_fields", "weplugins_modify_tag_form_fields" , 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’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.