Review the existing codebase

Oct 13, 2025 by wbrum.org 55 views

Overview

The Twemoji library has been widely adopted across various platforms, including WordPress, to provide a seamless and efficient way to display emojis. However, in certain situations, implementers may need to bypass specific nodes or elements that contain emojis. To address this requirement, the WordPress version of Twemoji has been modified to introduce a doNotParse callback setting. This feature allows implementers to indicate that a node should not be parsed, thereby bypassing any emojis within that node.

Background

In WordPress, contributors have been using the doNotParse callback to bypass nodes that include the class wp-exclude-emoji. This is particularly useful in situations where emojis are not desired within specific elements or nodes. For instance, in the WordPress ticket #52219, the issue of emojis being displayed within certain nodes was raised, and the doNotParse callback was introduced as a solution.

Introducing the `doNotParse` callback to Twemoji Core

Given the success of the doNotParse callback in WordPress, it is worth considering introducing this feature to Twemoji Core. This would enable implementers across various platforms to bypass specific nodes or elements that contain emojis. The benefits of introducing this feature include:

Improved flexibility: Implementers would have more control over how emojis are displayed within their applications.
Enhanced customization: The doNotParse callback would allow implementers to tailor the behavior of Twemoji to their specific needs.
Better compatibility: By introducing this feature, Twemoji would be more compatible with a wider range of applications and use cases.

Implementation

To implement the doNotParse callback in Twemoji Core, the following steps could be taken:

Review the existing codebase: Study the current implementation of Twemoji and identify areas where the doNotParse callback could be integrated.
Create a new callback function: Develop a new function that accepts a callback as an argument and uses it to determine whether a node should be parsed or not.
Modify the parse() and grabAllTextNodes() functions: Update these functions to utilize the new callback function and pass it the doNotParse callback as an argument.
Test the implementation: Thoroughly test the updated implementation to ensure that it works as expected and does not introduce any regressions.

Conclusion

Introducing the doNotParse callback setting to Twemoji Core would provide implementers with a valuable feature that allows them to bypass specific nodes or elements that contain emojis. This would improve flexibility, enhance customization, and better compatibility with a wider range of applications and use cases. By following the steps outlined above, the implementation of this feature would be a straightforward process.

Example Use Case

Suppose we have a web application that uses Twemoji to display emojis within a specific element. However, we want to bypass emojis within a particular node that contains the class wp-exclude-emoji. We can achieve this by passing the doNotParse callback to the parse() function, like so:

const twemoji = require('twemoji');

// Define the doNotParse callback
const doNotParse = (node) => {
    return node.classList.contains('wp-exclude-emoji');
};

// Parse the emoji within the specified node
twemoji.parse(node, doNotParse);

In this example, the doNotParse callback is used to determine whether the node should be parsed or not. If the node contains the class wp-exclude-emoji, the callback returns true, indicating that the node should not be parsed. Otherwise, the callback returns false, allowing the node to be parsed as usual.

API Documentation

The doNotParse callback setting would be documented in the Twemoji API as follows:

`doNotParse` Callback

The doNotParse callback is a function that accepts a node as an argument and returns a boolean value indicating whether the node should be parsed or not.

Parameters

node: The node to be parsed.

Returns

boolean: A boolean value indicating whether the node should be parsed or not.

Example

const doNotParse = (node) => {
    return node.classList.contains('wp-exclude-emoji');
};

Q: What is the `doNotParse` callback?

A: The doNotParse callback is a feature introduced in the WordPress version of Twemoji that allows implementers to bypass specific nodes or elements that contain emojis. It is a function that accepts a node as an argument and returns a boolean value indicating whether the node should be parsed or not.

Q: Why is the `doNotParse` callback useful?

A: The doNotParse callback is useful in situations where emojis are not desired within specific elements or nodes. It provides implementers with more control over how emojis are displayed within their applications, allowing them to tailor the behavior of Twemoji to their specific needs.

Q: How does the `doNotParse` callback work?

A: The doNotParse callback is used in conjunction with the parse() and grabAllTextNodes() functions in Twemoji. When these functions are called, they pass the doNotParse callback as an argument, which is then used to determine whether a node should be parsed or not.

Q: Can I use the `doNotParse` callback in my own application?

A: Yes, you can use the doNotParse callback in your own application. To do so, you will need to create a new callback function that accepts a node as an argument and returns a boolean value indicating whether the node should be parsed or not. You can then pass this callback to the parse() and grabAllTextNodes() functions in Twemoji.

Q: How do I implement the `doNotParse` callback in my application?

A: To implement the doNotParse callback in your application, you will need to follow these steps:

Review the existing codebase to identify areas where the doNotParse callback could be integrated.
Create a new callback function that accepts a node as an argument and returns a boolean value indicating whether the node should be parsed or not.
Modify the parse() and grabAllTextNodes() functions to utilize the new callback function and pass it the doNotParse callback as an argument.
Test the implementation to ensure that it works as expected and does not introduce any regressions.

Q: What are some use cases for the `doNotParse` callback?

A: Some use cases for the doNotParse callback include:

Bypassing emojis within specific elements or nodes that contain the class wp-exclude-emoji.
Preventing emojis from being displayed within certain areas of the application.
Customizing the behavior of Twemoji to meet the specific needs of the application.

Q: Is the `doNotParse` callback compatible with all versions of Twemoji?

A: The doNotParse callback is compatible with the latest version of Twemoji. However, it may not be compatible with older versions of the library. If you are using an older version of Twemoji, you may need to upgrade to the latest version in order to use the doNotParse callback.

Q: Can I use the `doNotParse` callback in conjunction with other Twemoji features?

A: Yes, you can use the doNotParse callback in conjunction with other Twemoji features. For example, you can use the doNotParse callback in conjunction with the parse() function to bypass emojis within specific elements or nodes.

Q: How do I get started with using the `doNotParse` callback in my application?

A: To get started with using the doNotParse callback in your application, follow these steps:

Review the documentation for the doNotParse callback to understand how it works.
Create a new callback function that accepts a node as an argument and returns a boolean value indicating whether the node should be parsed or not.
Modify the parse() and grabAllTextNodes() functions to utilize the new callback function and pass it the doNotParse callback as an argument.
Test the implementation to ensure that it works as expected and does not introduce any regressions.

By following these steps, you can successfully implement the doNotParse callback in your application and take advantage of its many benefits.