How to use attachment_link filter in WordPress

attachment_link filter

Filters the permalink for an attachment.

To use the attachment_link 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.

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

Parameters

Below are the 2 parameters required to use this hook.

• $link : (string) The attachment’s permalink.
• $post_id : (int) Attachment ID.

Live Example 1

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

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

Live Example 2

To remove a hook callback, use the example below.

    remove_filter("attachment_link", "weplugins_modify_attachment_link_defaults", 10, 2);
    

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

Live Example 3

Another example where we conditionally modify the attachment link.

    function weplugins_conditional_attachment_link($link, $post_id) {
        if ($post_id == 123) {
            $link = 'https://example.com/custom-link';
        }
        return $link;
    }
    add_filter("attachment_link", "weplugins_conditional_attachment_link", 10, 2);
    

Contact Us

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