How to use get_archives_link filter in WordPress

get_archives_link filter

Filters the archive link content.

To use the get_archives_link filter, first you need 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.

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_modify_get_archives_link_defaults which takes 7 parameters and we registered using add_filter. The first parameter get_archives_link is the name of the hook, the second parameter weplugins_modify_get_archives_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 get_archives_link filter.

Parameters

Below are the 7 parameters required to use this hook.

• $link_html : (string) The archive HTML link content.
• $url : (string) URL to archive.
• $text : (string) Archive text description.
• $format : (string) Link format. Can be ‘link’, ‘option’, ‘html’, or custom.
• $before : (string) Content to prepend to the description.
• $after : (string) Content to append to the description.
• $selected : (bool) True if the current page is the selected archive.

Live Examples

Example 1: Basic Modification

Below is an example of how you can use this hook to modify the archive link content.

function weplugins_modify_get_archives_link_defaults($link_html, $url, $text, $format, $before, $after, $selected) {
    // Update the $link_html variable according to your website requirements and return this variable. You can modify the $link_html variable conditionally too if you want.
    return $link_html;
}
// Add the filter
add_filter("get_archives_link", "weplugins_modify_get_archives_link_defaults", 10, 7);

Example 2: Conditional Modification

This example demonstrates modifying the archive link content based on specific conditions (e.g., day, month, year).

function weplugins_example_get_archives_link($link_html) {
    if (is_day() || is_month() || is_year()) {
        if (is_day()) {
            $data = get_the_time('Y/m/d');
        } elseif (is_month()) {
            $data = get_the_time('Y/m');
        } elseif (is_year()) {
            $data = get_the_time('Y');
        }
    }
    return $link_html;
}
add_filter("get_archives_link", "weplugins_example_get_archives_link");

Example 3: Removing the Hook Callback

To remove a hook callback, use the example below. Ensure you provide the same callback function name, priority, and number of arguments while removing the hook callback.

remove_filter("get_archives_link", "weplugins_modify_get_archives_link_defaults", 10, 7);

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.