Tech Note: A PHP Function to Strip Specific HTML Tags and Attributes

Parse those tags, mama
LGF • Views: 43,176
Image via Shutterstock

Every once in a while I come up with a bit of code that does something well enough I think it’s worth sharing, especially if it performs a function commonly used by lots of programmers, with a method that doesn’t already have hundreds of results in a Google search. And here’s one of those bits; maybe this will come in handy to another coder out there on the Internets, searching in vain for a good routine to parse tags and attributes.

For a long time I’ve been using a function to “sanitize” user input (e.g. comments and LGF Pages) to ensure no malicious code ever gets posted either on purpose or by accident. But I also allow certain HTML tags, and certain attributes for those tags.

The problem with the function I was using is that it employed regular expressions to parse the HTML, and that’s just a big freaking headache — inflexible and fragile. If you search a site like Stack Overflow for info on parsing HTML with regular expressions you’ll see tons of comments telling you “DO NOT DO THIS.” But the code worked well enough for a long time — until I started needing to allow HTML5 “data” attributes inside some tags.

Data attributes typically look like this:

data-conversation="none"

The word “data” is followed by a hyphen and then a variable name for the type of data involved. And that’s where my old attribute parsing function started to become a real hassle to use, because it was unable to deal with that variable part of the name easily, and I needed to add every type of data attribute I used to a list as they came up.

So today I came up with a vastly improved function that uses PHP’s DOMDocument library to actually build a Document Object Model out of the HTML code, then find the tags and attributes the right way instead of the bad old regex way, and remove everything except the tags and attributes I want to leave in place.

The new approach lets me use a regular expression only to match all types of data attributes — not to to find those attributes inside a big pile of HTML code. The task of finding the tags and attributes is handled by the XPath syntax of PHP’s DOMDocument methods.

Without further explanation, here’s that new function. It takes a string of HTML to “sanitize” and two arrays as parameters; the arrays are a list of the allowed tags, and a list of the allowed attributes. Note that if “href” or “src” attributes are allowed, the function checks to see if the value of the attribute is Javascript code, and changes it to “#” if so.

<?php
function stripTagsAttributes($html, $allowedTags = array(), $allowedAttributes = array('(?:a^)')) {
	if (!empty($html)) {
		$theTags = count($allowedTags) ? '<' . implode('><', $allowedTags) . '>' : '';
		$theAttributes = '%' . implode('|', $allowedAttributes) . '%i';
		$dom = @DOMDocument::loadHTML(
			mb_convert_encoding(
				strip_tags(
					$html,
					$theTags
				),
				'HTML-ENTITIES',
				'UTF-8'
			)
		);
		$xpath = new DOMXPath($dom);
		$tags = $xpath->query('//*');
		foreach ($tags as $tag) {
			$attrs = array();
			for ($i = 0; $i < $tag->attributes->length; $i++) {
				$attrs[] = $tag->attributes->item($i)->name;
			}
			foreach ($attrs as $attribute) {
				if (!preg_match($theAttributes, $attribute)) {
					$tag->removeAttribute($attribute);
				} elseif (preg_match('%^(?:href|src)$%i', $attribute) and preg_match('%^javascript:%i', $tag->getAttribute($attribute))) {
					$tag->setAttribute($attribute, '#');
				}
			}
		}
		return (
			trim(
				strip_tags(
					html_entity_decode(
						$dom->saveHTML()
					),
					$theTags
				)
			)
		);
	}
}
?>

There are a couple of gotchas with using PHP’s DOMDocument library I should mention:

  1. If you're parsing a fragment of HTML code instead of an entire page, and it doesn't have a character encoding tag, DOMDocument will assume the text is encoded in ISO-8859 instead of the much preferred UTF-8. So this function uses the mb_convert_encoding function (line 7) to convert any Unicode characters into HTML entities before loading the code fragment, then uses html_entity_decode (line 32) to convert the entities back into characters when the parsing is finished.
  2. The second gotcha is that when you're parsing an HTML fragment, DOMDocument always adds a DOCTYPE, <html> and <body> tags to the fragment, and you can't disable this "feature." So after parsing, my function uses strip_tags a second time to remove those extra unneeded tags.

Oh yes, and one more thing; this is what the two arrays of tags and attributes look like for our comments; notice that the last item in the $commentAttributes array is a simple regular expression that matches any type of data attribute:

<?php
$commentTags = array(
	'b',
	'i',
	'a',
	'strong',
	'em',
	'blockquote',
	'div',
	'p',
	'br',
	'strike',
	'del',
	'sup',
	'sub',
	'code',
	'pre',
	'span',
	'img',
	'button',
);
$commentAttributes = array(
	'href',
	'rel',
	'target',
	'src',
	'width',
	'height',
	'class',
	'data-\S*'
);
?>

There are more sanitization measures in place when comments are posted, by the way; for example, images can only be embedded in comments if they’re uploaded and hosted at LGF, otherwise they’re transformed into links to the external images. This is to prevent anyone posting malicious images that contain code, porn, etc.

Jump to top

Create a PageThis is the LGF Pages posting bookmarklet. To use it, drag this button to your browser's bookmark bar, and title it 'LGF Pages' (or whatever you like). Then browse to a site you want to post, select some text on the page to use for a quote, click the bookmarklet, and the Pages posting window will appear with the title, text, and any embedded video or audio files already filled in, ready to go.
Or... you can just click this button to open the Pages posting window right away.
Last updated: 2016-01-01 10:29 am PST
LGF User's Guide RSS Feeds Tweet

Help support Little Green Footballs!

Subscribe now for ad-free access!Register and sign in to a free LGF account before subscribing, and your ad-free access will be automatically enabled.

Recent PagesClick to refresh
Letters From Women Pleading for Abortion, Sent in 1917, Mirror Emails Sent Today In the early 1900s, desperate American women wrote letters to the founder of Planned Parenthood begging for help with unwanted pregnancies. A century later, they're sending eerily similar messages to an international abortion-by-mail service. "I'm in the family way ...
Birth Control Works
1 hour, 45 minutes ago
Views: 137 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 1
Comments: 0
: 1
Pregnant Women Are Being Arrested for Crimes They Didn’t Know They Committed Laurie was five months pregnant when she used methamphetamine. She'd previously been on anxiety medication, but her doctor switched her to an opiate when she told him she had history for drug addiction. She said the opiate made her ...
Birth Control Works
1 hour, 47 minutes ago
Views: 200 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 1
Comments: 0
: 1
Manchester: Defiant and Proud Everybody reading this will have some connection to Manchester. Whether it's music you love (*waves at Charles*), football you enjoy, science you respect or that radical tradition you've read of, Manchester is a World City we all have some ...
Paul Canning
5 hours, 16 minutes ago
Views: 310 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Inclusive Approaches to Preventing Violent Extremism - Carter Center Violent extremism fractures communities, fosters division, and exacerbates political conflicts. It knows no religious, national, or ethnic boundaries. Violent extremist movements continue to fuel the world’s most violent wars in Africa and the Middle East, and right-wing ethno-nationalist extremism ...
Birth Control Works
6 hours, 36 minutes ago
Views: 176 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 1
Comments: 0
: 1
Love It or Hate It-What Saudi Arabia Is Buying in Its $110 Billion Arms Deal Huge deals with israel, and Saudi Arabia. Our industrial war machine grows apace. TanksSaudi Arabia is expecting 153 M1A1/A2 tank structures, which will be turned into 133 Saudi-specification M1A2S main battle tanks. Twenty additional tanks will replace those from ...
Unshaken Defiance
7 hours, 29 minutes ago
Views: 219 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 1
Comments: 0
: 1
On Trump and RussiaPresident Trump’s remarks regarding Russia as a candidate for President of the United States should have alarmed Americans regardless of party. Candidate Trump went out of his way to praise Vladimir Putin’s Russia, while simultaneously belittling the President of the ...
HappyWarrior
1 day ago
Views: 201 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Work, Not Sex? the Real Reason Chinese Women Bound Their Feet Girls who had their feet bound didn't lead a life of idle beauty but rather served a crucial economic purpose, especially in the countryside, where girls as young as 7 weaved, spun and did work by hand, Bossen said.Read ...
Birth Control Works
1 day, 8 hours ago
Views: 308 • Comments: 2 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Why Are All the Anti-Abortion Democrats Men? A troubling pattern emerges if you start looking at who in the Democratic Party supports women's reproductive rights and who doesn't. Though disappointing, it's far from surprising that all of the anti-abortion Democrats are men. Let me put that ...
Birth Control Works
1 day, 8 hours ago
Views: 395 • Comments: 1 • Rating: 1
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Virtual Reality Can Help You Feel More Empathy for Women Harassed at Abortion Clinics It's hard to understand what it feels like to be confronted or bullied outside a women's health center — until it happens to you. I'd never had that experience until last year, while reporting on the Supreme Court case ...
Birth Control Works
1 day, 8 hours ago
Views: 403 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Families of Chechen Gay Men Pressured to Sign ‘No Complaint’ Documents, Org Says The existence of anti-gay pogroms in Chechnya first surfaced in the independent Russian newspaper Novaya Gazet in April, reporting that hundreds of people had been detained and at least three are now thought to have died. Since then, police ...
Birth Control Works
1 day, 9 hours ago
Views: 296 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0