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

Parse those tags, mama
LGF • Views: 45,468
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.

Donate with
PayPal
Square Cash Shop at amazon
as an LGF Associate!
Recent PagesClick to refresh
Live From Daryl’s House - ‘I’m Alright’On this episode of Live From Daryl's House, Kenny Loggins drops by to get "Footloose" with Daryl and his band.
Thanos
2 days, 4 hours ago
Views: 187 • Comments: 0 • Rating: 1
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Author Retraces Her Journey From Survivalist Childhood to Cambridge Ph.D. As a girl, Westover says, "There wasn't ever any question about what my future would look like: I would get married when I was 17 or 18, and I would be given some corner of the farm and my ...
Thanos
2 days, 18 hours ago
Views: 285 • Comments: 2 • Rating: 5
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
Florida Republicans Choose Unregulated Murder Weapons Over Children’s LivesI keep drilling this to everyone who discusses this shooting. Republicans value ownership of unregulated murder weapons over children's lives. So much so that they voted along party lines with Stoneman Douglas students watching they voted to decline debate on ...
TDG2112
3 days, 2 hours ago
Views: 301 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Weekend Box Office: ‘Black Panther’ Bounds to Record-Shattering $218M-Plus Bow In a defining moment for Hollywood, Disney and Marvel Studios' Black Panther exploded at the Presidents Day box office, bounding to a record-shattering estimate of $192 million for the three-day weekend and a projected $218 million-plus for the four-day ...
Thanos
5 days, 8 hours ago
Views: 582 • Comments: 0 • Rating: 1
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Brandi Carlile - the Joke (Official Video) From the album "By The Way, I Forgive You" available now. elektrar.ec Directed by Danny Clinch Produced by Lindha Narvaez for MILKT Choreography by Peter Leung Ballet sequence filmed by Middle Table Productions Connect with Brandi: brandicarlile.com facebook.com @brandicarlile ...
Thanos
6 days, 4 hours ago
Views: 641 • Comments: 0 • Rating: 1
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
School Shooter Nikolas Cruz Belonged to White Supremacist GroupThis my surprised face.... BREAKING: Nikolas Cruz, alleged perpetrator in the deadly school shooting in Parkland, Florida, was associated with white supremacist group Republic of Florida &amp; participated in the group’s training exercises, according to the group’s leader. More info: ...
Scottish Dragon
1 week, 1 day ago
Views: 754 • Comments: 2 • Rating: 1
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Your Medicine Cabinet Knows What AIls Youblog.timesunion.com HOFFMAN FILESYour medicine cabinet knows what ails you.By Rob Hoffman on February 15, 2018 at 5:27 AM1We all fancy ourselves experts when it comes to the human condition. We see our fellow human beings as open books, and we ...
rhoffman
1 week, 1 day ago
Views: 734 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 1
Comments: 0
: 1
A.G. Schneiderman Files Civil Rights Lawsuit Against the Weinstein Companies, Harvey Weinstein, and Robert Weinstein NEW YORK – New York Attorney General Eric T. Schneiderman today filed suit against The Weinstein Company (“TWC”), Harvey Weinstein, and Robert Weinstein for egregious violations of New York’s civil rights, human rights, and business laws. The suit, filed ...
Thanos
1 week, 5 days ago
Views: 1,518 • Comments: 0 • Rating: 1
Tweets: 5 • Share to Facebook
Shares: 2
Comments: 0
: 2
Portugal. The Man - Keep on (Official Video) Portugal. The Man - Keep On Video conceptualized, created and directed by Paulin RoguesFollow Paulin at instagram.com Catch Portugal. The Man on tour:portugaltheman.com WOODSTOCK available now!atlantic.lnk.to Follow Portugal. The ManWebsite: portugaltheman.comFB: facebook.com IG: instagram.comTW: @portugalthemanSC: SoundCloudYT: youtube.comTumblr: portugaltheman.tumblr.com ...
Thanos
1 week, 6 days ago
Views: 1,604 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
Marvel’s Jessica Jones - Season 2 Jessica Jones is back as New York City’s tough-as-nails private investigator. Although this time, the case is even more personal than ever before. Fueled by a myriad of questions and lies, she will do whatever it takes to uncover ...
Thanos
1 week, 6 days ago
Views: 1,392 • Comments: 1 • Rating: 2
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0