Data escaping (output) in Wordpress - Mini Project: Build & Apply

Data escaping (output) in WordPress

📖 Scenario: You are building a simple WordPress theme template that displays user input safely on a webpage.Users can submit their name and a short message. You want to show these inputs on the page without risking security issues like cross-site scripting (XSS).

🎯 Goal: Build a WordPress PHP template snippet that outputs user-submitted $user_name and $user_message variables safely using proper WordPress escaping functions.

📋 What You'll Learn

Create two variables $user_name and $user_message with exact string values.

Add a configuration variable $max_length to limit message length.

Use WordPress escaping functions esc_html() and esc_attr() to safely output data.

Output the escaped variables inside HTML tags with proper attributes.

💡 Why This Matters

🌍 Real World

Preventing security vulnerabilities like cross-site scripting (XSS) when displaying user input in WordPress themes or plugins.

💼 Career

Essential skill for WordPress developers to ensure safe and secure output of dynamic content on websites.

1

Create user input variables

Create two PHP variables called $user_name and $user_message with these exact values: 'Alice & Bob' for $user_name and 'Hello ' for $user_message.

Wordpress

<?php

// Create variables $user_name and $user_message with exact values
# Your code here

Hint

Use single quotes around the strings exactly as shown.

2

Add message length limit configuration

Add a PHP variable called $max_length and set it to the integer 50 to limit the message length.

Wordpress

alert("XSS")';

// Add $max_length variable set to 50
# Your code here

Hint

Just create a variable named $max_length and assign it the number 50.

3

Escape and trim the user message

Use the PHP function mb_substr() to trim $user_message to $max_length characters, then assign it back to $user_message. Then use the WordPress function esc_html() to escape $user_message for safe HTML output.

Wordpress

alert("XSS")';
$max_length = 50;

// Trim $user_message to $max_length and escape it with esc_html()
# Your code here

Hint

Use mb_substr() to cut the message, then store the escaped version in $escaped_message.

4

Output escaped user name and message in HTML

Output the escaped $user_name inside an <h2> tag using esc_html(). Output the escaped message stored in $escaped_message inside a <p> tag. Also, add the escaped user name as the title attribute of the <h2> tag using esc_attr().

Wordpress

alert("XSS")';
$max_length = 50;
$user_message = mb_substr($user_message, 0, $max_length);
$escaped_message = esc_html($user_message);

// Output escaped $user_name in  with title attribute escaped by esc_attr()
// Output $escaped_message in 
# Your code here

Hint

Use esc_html() for the visible name and esc_attr() for the title attribute. Use echo to output the HTML.

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