How to use emoji_url filter in WordPress

emoji_url filter

Filters the URL where emoji png images are hosted.

To use the emoji_url 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_emoji_url_defaults which takes 1 parameter and we registered it using add_filter. The first parameter emoji_url is the name of the hook, the second parameter weplugins_modify_emoji_url_defaults is the name of the function that 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 emoji_url filter.

Parameters

Below the 1 parameter is required to use this hook:

• $url: (string) The emoji base URL for png images.

Live Example

apply_filters( 'emoji_url', string $url )

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

Example 1: Modify Emoji URL

In this example, we modify the base URL for emoji images.

        function weplugins_modify_emoji_url_defaults($url) { 
            // Update the $url variable according to your website requirements and return this variable. You can modify the $url variable conditionally too if you want.
            return $url; 
        }
        // add the filter
        add_filter( "emoji_url", "weplugins_modify_emoji_url_defaults", 10, 1 );
    

Example 2: Remove Emoji URL Filter

To remove a hook callback, use the example below:

remove_filter( "emoji_url", "weplugins_modify_emoji_url_defaults", 10, 1 );

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

Example 3: Conditional Emoji URL Modification

Here’s how you can conditionally modify the emoji URL based on certain criteria:

        function weplugins_conditional_emoji_url($url) {
            if (is_page('special-page')) {
                $url = 'https://example.com/custom-emoji/';
            }
            return $url;
        }
        add_filter( 'emoji_url', 'weplugins_conditional_emoji_url', 10, 1 );
    

Contact Us

If you need any customization, feel free to Contact Us.