How to use edit_form_before_permalink action in WordPress

edit_form_before_permalink action

Fires before the permalink field in the edit form.

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

Parameters

Below the 1 parameter is required to use this hook.

• $post : (WP_Post) Post object.

Live Examples

Example 1: Adding Custom Content Before Permalink

Below is an example of how you can use this hook to add custom content before the permalink field in the edit form.

    function weplugins_execute_on_edit_form_before_permalink_event($post) {
        echo '<div>Custom Content Before Permalink</div>';
    }
    add_action("edit_form_before_permalink", "weplugins_execute_on_edit_form_before_permalink_event", 10, 1);
    

Example 2: Displaying Post Meta Information

This example demonstrates how to display custom post meta information before the permalink field.

    function weplugins_display_post_meta_before_permalink($post) {
        $meta_value = get_post_meta($post->ID, '_custom_meta_key', true);
        echo '<div>Custom Meta: ' . esc_html($meta_value) . '</div>';
    }
    add_action("edit_form_before_permalink", "weplugins_display_post_meta_before_permalink", 10, 1);
    

Example 3: Removing a Previously Added Hook

To remove a hook callback, use the example below.

    remove_action("edit_form_before_permalink", "weplugins_execute_on_edit_form_before_permalink_event", 10, 1);
    

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