get_bookmarks filter
The first time the hook is evaluated in this file, it returns the cached bookmarks list. The second evaluation returns a cached bookmarks list if the link category is passed but does not exist. The third evaluation returns the full cached results.
To use get_bookmarks 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.
At WePlugins, we 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_get_bookmarks_defaults which takes 2 parameters and we registered using add_filter. The first parameter get_bookmarks is the name of the hook, The second parameter modify_get_bookmarks_defaults is the name of the function which needs to be called, 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 get_bookmarks filter.
Parameters
Live Example 1
Below is an example of how you can use this hook.
function weplugins_modify_get_bookmarks_defaults($bookmarks, $parsed_args) {
// Update the $bookmarks variable according to your website requirements and return this variable. You can modify the $bookmarks variable conditionally too if you want.
return $bookmarks;
}
// add the filter
add_filter( "get_bookmarks", "weplugins_modify_get_bookmarks_defaults", 10, 2 );
Live Example 2
To remove a hook callback, use the example below.
remove_filter( "get_bookmarks", "weplugins_modify_get_bookmarks_defaults", 10, 2 );
Live Example 3
Another example where you might want to modify the bookmarks based on a specific condition.
function weplugins_custom_bookmarks_filter($bookmarks, $parsed_args) {
if (isset($parsed_args['category']) && $parsed_args['category'] == 'special') {
// Modify bookmarks for 'special' category
$bookmarks = array_filter($bookmarks, function($bookmark) {
return $bookmark->link_visible == 'Y';
});
}
return $bookmarks;
}
add_filter('get_bookmarks', 'weplugins_custom_bookmarks_filter', 10, 2);
Contact Us
If you need customization, please Contact Us.
