How to use month_link filter in WordPress

month_link filter

Filters the month archive permalink.

To use the month_link 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_month_link_defaults which takes 3 parameters and we registered using add_filter. The first parameter month_link is the name of the hook, the second parameter modify_month_link_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 month_link filter.

Parameters

Below are the 3 parameters required to use this hook:

• $monthlink : (string) Permalink for the month archive.
• $year : (int) Year for the archive.
• $month : (int) The month for the archive.

Live Example

apply_filters( 'month_link', string $monthlink, int $year, int $month )

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

Example 1: Basic Usage

This example demonstrates basic usage of the month_link filter.

    function weplugins_modify_month_link_defaults($monthlink, $year, $month) { 
        // Update the $monthlink variable according to your website requirements and return this variable. 
        // You can modify the $monthlink variable conditionally too if you want.
        return $monthlink; 
    }
    // Add the filter
    add_filter( "month_link", "weplugins_modify_month_link_defaults", 10, 3 );
    

Example 2: Conditional Modification

This example shows how to modify the month link conditionally.

    function weplugins_modify_month_link_conditionally($monthlink, $year, $month) { 
        if ($year == 2023 && $month == 10) {
            $monthlink = 'https://example.com/custom-month-link';
        }
        return $monthlink; 
    }
    // Add the filter
    add_filter( "month_link", "weplugins_modify_month_link_conditionally", 10, 3 );
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    // Remove the filter
    remove_filter( "month_link", "weplugins_modify_month_link_defaults", 10, 3 );
    

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.