How to use default_excerpt filter in WordPress

default_excerpt filter

Filters the default post excerpt initially used in the “Write Post” form.

To use the default_excerpt filter, first you have to register it using add_filter. You can write this code into the functions.php of your activated theme or in a custom WordPress Plugin.

WePlugins always prefers 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_modify_default_excerpt_defaults which takes 2 parameters, and we registered it using add_filter. The first parameter default_excerpt is the name of the hook, the second parameter weplugins_modify_default_excerpt_defaults is the name of the function that 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 the default_excerpt filter.

Parameters

Below are the 2 parameters required to use this hook.

• $post_excerpt : (string) Default post excerpt.
• $post : (WP_Post) Post object.

Live Examples

Example 1: Basic Usage

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

    function weplugins_modify_default_excerpt_defaults($post_excerpt, $post) { 
        // Update the $post_excerpt variable according to your website requirements and return this variable.
        // You can modify the $post_excerpt variable conditionally too if you want.
        return $post_excerpt; 
    }
    // add the filter
    add_filter("default_excerpt", "weplugins_modify_default_excerpt_defaults", 10, 2);
    

Example 2: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter("default_excerpt", "weplugins_modify_default_excerpt_defaults", 10, 2);
    

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

Example 3: Conditional Modification

Here’s an example where the excerpt is modified conditionally based on the post type.

    function weplugins_modify_default_excerpt_defaults_conditionally($post_excerpt, $post) {
        if ($post->post_type === 'custom_post_type') {
            $post_excerpt = 'This is a custom excerpt for custom post type.';
        }
        return $post_excerpt;
    }
    // add the filter
    add_filter("default_excerpt", "weplugins_modify_default_excerpt_defaults_conditionally", 10, 2);
    

Contact Us

If you’re having any trouble using this hook or need customization, please Contact Us.