How to use excerpt_length filter in WordPress

excerpt_length filter

Filters the maximum number of words in a post excerpt.

To use the excerpt_length 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_excerpt_length_defaults which takes 1 parameter and we registered it using add_filter. The first parameter excerpt_length is the name of the hook, the second parameter modify_excerpt_length_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 the excerpt_length filter.

Parameters

Below the 1 parameter is required to use this hook.

• $number: (int) The maximum number of words. Default 55.

Live Example 1

This example shows how to set a custom excerpt length to 20 words.

    function weplugins_custom_excerpt_length( $length ) {
        return 20;
    }
    add_filter( 'excerpt_length', 'weplugins_custom_excerpt_length', 999 );
    

Live Example 2

Below is an example of how you can use this hook to modify the excerpt length dynamically.

    function weplugins_modify_excerpt_length_defaults($number) { 
        // Update the $number variable according to your website requirements and return this variable. You can modify the $number variable conditionally too if you want.
        return $number; 
    }
    // add the filter
    add_filter( "excerpt_length", "weplugins_modify_excerpt_length_defaults", 10, 1 );
    

Live Example 3

To remove a hook callback, use the example below.

    remove_filter( "excerpt_length", "weplugins_modify_excerpt_length_defaults", 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 need customization or are having any trouble using this hook, please contact us and we’d be happy to assist you.