How to use dashboard_primary_link filter in WordPress

dashboard_primary_link filter

Filters the primary link URL for the ‘WordPress Events and News’ dashboard widget.

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

Parameters

Below the 1 parameter is required to use this hook.

• $link : (string) The widget’s primary link URL.

Live Example 1: Modifying the Primary Link URL

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

    function weplugins_modify_dashboard_primary_link_defaults($link) { 
        // 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("dashboard_primary_link", "weplugins_modify_dashboard_primary_link_defaults", 10, 1);
    

Live Example 2: Removing the Hook Callback

To remove a hook callback, use the example below.

    remove_filter("dashboard_primary_link", "weplugins_modify_dashboard_primary_link_defaults", 10, 1);
    

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

Live Example 3: Customizing the Link Based on User Role

This example shows how to customize the primary link URL based on the user’s role.

    function weplugins_modify_dashboard_primary_link_by_role($link) {
        if(current_user_can('administrator')) {
            // Update the link for administrators
            $link = 'https://weplugins.com/admin-dashboard';
        }
        return $link;
    }
    // add the filter
    add_filter("dashboard_primary_link", "weplugins_modify_dashboard_primary_link_by_role", 10, 1);
    

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.