Data escaping (output) in Wordpress

Introduction

Data escaping helps keep your website safe by cleaning output before showing it. It stops bad code from running on your site.

When showing user input on a page to avoid harmful scripts.

When printing data from the database that might contain special characters.

When adding dynamic content inside HTML attributes like links or image tags.

When displaying text that could include HTML or JavaScript from unknown sources.

Syntax

Wordpress

esc_html( $data )
esc_attr( $data )
esc_url( $url )
esc_js( $data )

esc_html() cleans text for safe HTML output.

esc_attr() cleans data for HTML attributes like title or alt.

Examples

Shows user input safely inside HTML content.

Wordpress

echo esc_html( $user_input );

Makes sure the URL is safe before adding it to a link.

Wordpress

echo '<a href="' . esc_url( $link ) . '">Click here</a>';

Escapes data inside an HTML attribute to avoid breaking the tag.

Wordpress

echo '<input type="text" value="' . esc_attr( $value ) . '">';

Sample Program

This example shows how to safely display user input, URLs, and attribute values using WordPress escaping functions. It prevents harmful scripts from running and keeps HTML valid.

Wordpress

<?php
// Simulate user input with special characters
$user_input = '<script>alert("hack")</script> Hello!';
$link = 'javascript:alert(1)';
$value = 'O\'Reilly & Co.';

// Safe output using escaping functions
?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Data Escaping Example</title>
</head>
<body>
  <h1>Escaped User Input:</h1>
  <p><?php echo esc_html($user_input); ?></p>

  <h2>Safe Link:</h2>
  <a href="<?php echo esc_url($link); ?>">Click me</a>

  <h2>Input Value:</h2>
  <input type="text" value="<?php echo esc_attr($value); ?>">
</body>
</html>

Important Notes

Always escape data right before output, not before storing it.

Use the right escaping function for the context: HTML content, attributes, URLs, or JavaScript.

Escaping helps protect your site from security risks like cross-site scripting (XSS).

Summary

Data escaping cleans output to keep your site safe.

Use esc_html(), esc_attr(), and esc_url() depending on where data goes.

Always escape data when showing it, especially if it comes from users or external sources.

Practice

1. What is the main purpose of using data escaping functions like esc_html() in WordPress?

easy

A. To clean output and protect the site from harmful code

B. To speed up the website loading time

C. To change the color of text on the page

D. To store data in the database securely

Solution

1. Step 1: Understand what data escaping does

   Data escaping cleans output by converting special characters to safe ones to prevent harmful code execution.

2. Step 2: Identify the purpose in WordPress context

   WordPress uses escaping functions to protect the site from security risks like cross-site scripting (XSS).

3. Final Answer:

   To clean output and protect the site from harmful code -> Option A

4. Quick Check:

   Data escaping = Protect site [OK]

Hint: Escaping means cleaning output to keep site safe [OK]

Common Mistakes:

• Thinking escaping speeds up the site
• Confusing escaping with styling
• Believing escaping stores data securely

2. Which of the following is the correct way to escape a URL before outputting it in WordPress?

easy

A. echo esc_html($url);

B. echo esc_url($url);

C. echo esc_attr($url);

D. echo sanitize_text_field($url);

Solution

1. Step 1: Identify the correct escaping function for URLs

   WordPress provides esc_url() specifically to clean URLs before output.

2. Step 2: Compare with other functions

   esc_html() is for HTML content, esc_attr() for attributes, and sanitize_text_field() is for input sanitizing, not output escaping.

3. Final Answer:

   echo esc_url($url); -> Option B

4. Quick Check:

   Escape URL with esc_url() [OK]

Hint: Use esc_url() for URLs, esc_attr() for attributes [OK]

Common Mistakes:

• Using esc_html() for URLs
• Using sanitize_text_field() for output escaping
• Not escaping URLs at all

3. What will be the output of this code snippet if $user_input = '<script>alert(1)</script>'; and we run echo esc_html($user_input);?

medium

A. <script>alert(1)</script>

B.

C. &lt;script&gt;alert(1)&lt;/script&gt;

D. alert(1)

Solution

1. Step 1: Understand what esc_html() does to special characters

   It converts special HTML characters like <, > to their safe encoded forms (<, >).

2. Step 2: Apply escaping to the input string

   The input already has < and > but esc_html() will convert the ampersands (&) to &, so the output becomes &lt;script&gt;alert(1)&lt;/script&gt;.

3. Final Answer:

   &lt;script&gt;alert(1)&lt;/script&gt; -> Option C

4. Quick Check:

   esc_html() encodes & to & [OK]

Hint: esc_html() converts & to & and < > to < > [OK]

Common Mistakes:

• Assuming esc_html() outputs raw HTML
• Ignoring double escaping of &
• Confusing esc_html() with esc_attr()

4. You see this code in a WordPress theme: echo $user_name; where $user_name comes from user input. What is the problem and how to fix it?

medium

A. No problem, output is safe as is

B. Missing escaping, fix with echo sanitize_text_field($user_name);

C. Missing escaping, fix with echo esc_url($user_name);

D. Missing escaping, fix with echo esc_html($user_name);

Solution

1. Step 1: Identify the security risk

   Outputting user input directly can cause security issues like XSS attacks.

2. Step 2: Choose the correct escaping function for HTML output

   Since the output is HTML content, esc_html() is the proper function to escape special characters safely.

3. Final Answer:

   Missing escaping, fix with echo esc_html($user_name); -> Option D

4. Quick Check:

   Escape user input with esc_html() for HTML output [OK]

Hint: Always escape user input before echoing in HTML [OK]

Common Mistakes:

• Not escaping user input at all
• Using esc_url() for plain text
• Using sanitize_text_field() only sanitizes input, not escapes output

5. You want to output a user-submitted URL inside an HTML attribute like <a href="...">. Which is the best way to escape it to keep your site safe and valid?

hard

A. echo esc_url($user_url);

B. echo esc_html($user_url);

C. echo esc_attr($user_url);

D. echo esc_url(esc_attr($user_url));

Solution

1. Step 1: Understand context of output

   The URL is inside an HTML attribute (href), so it needs URL-specific escaping and validation.

2. Step 2: Choose correct escaping function for URL attributes

   esc_url() sanitizes URL schemes (e.g., strips javascript:) and escapes for safe HTML attribute output.

3. Step 3: Why not esc_attr()?

   esc_attr() only escapes HTML chars but allows dangerous schemes like javascript:alert(1), leading to XSS.

4. Final Answer:

   echo esc_url($user_url); -> Option A

5. Quick Check:

   esc_url() for href attributes [OK]

Hint: esc_url() for links in href/src attributes [OK]

Common Mistakes:

• Using esc_attr() which doesn't validate URL schemes
• Using esc_html() for attributes
• Double escaping with esc_url(esc_attr())