Data escaping (output) in Wordpress - Step-by-Step Execution

Concept Flow - Data escaping (output)

Get raw data

↓

Choose escaping function

↓

Apply escaping

↓

Output safe data

↓

Browser renders escaped output

Data escaping in WordPress means taking raw data and making it safe before showing it on the page by applying the right escaping function.

Execution Sample

Wordpress

<?php
$user_input = '<script>alert(1)</script>';
echo esc_html($user_input);
?>

This code takes user input with HTML tags and safely outputs it by escaping HTML characters.

Execution Table

Step	Action	Input Data	Escaping Function	Output Data
1	Receive raw data	<script>alert(1)</script>	None	<script>alert(1)</script>
2	Apply esc_html()	<script>alert(1)</script>	esc_html()	&lt;script&gt;alert(1)&lt;/script&gt;
3	Output escaped data	&lt;script&gt;alert(1)&lt;/script&gt;	None	&lt;script&gt;alert(1)&lt;/script&gt;

💡 Data is escaped and safe for HTML output, preventing script execution.

Variable Tracker

Variable	Start	After esc_html()	Final Output
user_input	'<script>alert(1)</script>'	'&lt;script&gt;alert(1)&lt;/script&gt;'	'&lt;script&gt;alert(1)&lt;/script&gt;'

Key Moments - 2 Insights

Why do we use esc_html() instead of echoing raw data?

Because raw data may contain harmful HTML or scripts. esc_html() converts special characters to safe codes, as shown in step 2 of the execution table.

What happens if we forget to escape data before output?

The raw data may run scripts or break HTML, causing security risks or display errors, as seen in step 1 where raw data is unsafe.

Visual Quiz - 3 Questions

Look at the execution table, what is the output data after applying esc_html()?

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

B &lt;script&gt;alert(1)&lt;/script&gt;

C alert(1)

D &amp;lt;script&amp;gt;alert(1)&amp;lt;/script&amp;gt;

💡 Hint

Check the Output Data column at Step 2 in the execution table.

At which step is the data still unsafe to output?

A Step 1

B Step 2

C Step 3

D None

💡 Hint

Look at the Action and Output Data columns in the execution table.

If we used esc_attr() instead of esc_html(), what would change in the output?

A Output would be the same as esc_html()

B Output would be raw and unsafe

C HTML tags would be escaped for attribute context

D Output would be plain text without any escaping

💡 Hint

esc_attr() escapes for HTML attributes, different from esc_html() which escapes for HTML body content.

Concept Snapshot

Data escaping in WordPress:
- Use esc_html() to safely output data inside HTML.
- Converts special characters like < > to &lt; &gt;.
- Prevents scripts from running in the browser.
- Always escape before output to avoid security risks.

Full Transcript

Data escaping in WordPress means making raw data safe before showing it on a webpage. For example, if user input contains HTML tags or scripts, we use functions like esc_html() to convert special characters into safe codes. This stops harmful scripts from running and keeps the page safe. The process starts by getting raw data, then choosing the right escaping function, applying it, and finally outputting the safe data. If we skip escaping, the raw data might run scripts or break the page. Using esc_html() changes <script> tags into &lt;script&gt; so the browser shows them as text, not code. This is important for security and proper display.

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())