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

Parse those tags, mama
LGF • Views: 44,758
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
Orkestra Obsolete Play Blue Monday Using 1930s Instruments - BBC Arts More information: bbc.in New Order's Blue Monday was released on 7 March 1983, and its cutting-edge electronic groove changed pop music forever. But what would it have sounded like if it had been made 50 years earlier? In a ...
Thanos
19 hours, 10 minutes ago
Views: 105 • Comments: 0 • Rating: 1
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Tune-Yards - ABC 123 (Official Video) 'ABC 123' by Tune-Yards. New album 'I can feel you creep into my private life' is released January 19th 2018: smarturl.it Director: Dear Mr QuistgaardProducer: Abi Atkinson, LS ProductionsCommissioner: Gabe Spierer, Beggars GroupExec Producer: Saskia Whinney, SomesuchDOP: Deepa KeshvalaEditor: ...
Thanos
19 hours, 14 minutes ago
Views: 84 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Funding Restrictions Have Made Gun Violence Researchers Get Creative A study published Thursday concludes that a subsequent increase in gun exposure led to more accidental firearm deaths than otherwise would have occurred in the months after the school shooting. "It was the spike [in sales] itself that sort ...
Thanos
21 hours, 19 minutes ago
Views: 107 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Recycling Chaos in U.S. As China Bans ‘Foreign Waste’ Like many Portland residents, Satish and Arlene Palshikar are serious recyclers. Their house is coated with recycled bluish-white paint. They recycle their rainwater, compost their food waste and carefully separate the paper and plastic they toss out. But recently, ...
Thanos
21 hours, 34 minutes ago
Views: 173 • Comments: 0 • Rating: 1
Tweets: 2 • Share to Facebook
Shares: 0
Comments: 0
: 0
Trump Jerusalem Move: Tear Gas at Lebanon US Embassy Protest There have been violent clashes near the US embassy in Lebanon, in the latest protest against President Donald Trump's decision to recognise Jerusalem as the capital of Israel. Security forces fired tear gas and water cannon to force back ...
Thanos
21 hours, 38 minutes ago
Views: 129 • Comments: 0 • Rating: 0
Tweets: 3 • Share to Facebook
Shares: 0
Comments: 0
: 0
Trump Says He and Trudeau Disagree on Trade Deficit. U.S. Stats Seem to Be on the PM’s SideHair Furor just can't seem to catch a break these days....Despite Trump's insistence the U.S. has a trade deficit with Canada, statistics from the website of the office of the U.S. Trade Representative -- the office handling NAFTA negotiations -- ...
The Major
1 day, 3 hours ago
Views: 165 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Blondie - Doom or Destiny (Official Video)Blondie performing "Doom or Destiny" from the new album "Pollinator".Out Now: blondie.lnk.to Follow Blondiefacebook.cominstagram.com@BlondieOfficial vevo.ly
Thanos
2 days, 6 hours ago
Views: 248 • Comments: 1 • Rating: 2
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Beth Hart & Joe Bonamassa - Black Coffee (Official Music Video) Official video for Black Coffee from the new Beth Hart & Joe Bonamassa album Black Coffee. Pre-order: smarturl.it BLACK COFFEE is available to pre-order on CD and vinyl. The limited CD box includes 2 coasters, a postcard and an ...
Thanos
2 days, 6 hours ago
Views: 1,125 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Sparks - ‘This Town Ain’t Big Enough for Both of Us’ (Live at WFUV) wfuv.org • Follow @wfuv: ow.ly Sparks (allsparks.com) performs "This Town Ain't Big Enough For Both of Us" live in Studio A. Recorded 10.12.17. Host: Darren DeVivoAudio: Jim O'HaraCameras: Dan Tuozzoli, Kristal Ho, Monica Fafaul, Alexandra Brennan and Liz CarrEditor: ...
Thanos
2 days, 6 hours ago
Views: 176 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Conyers Resigns Amid Sexual Harassment Allegations Rep. John Conyers, D-Mich., has sent a letter to House Speaker Paul Ryan and Minority Leader Nancy Pelosi informing them of his decision to step down from Congress as of Tuesday, amid allegations of sexual misconduct leveled by multiple ...
Thanos
2 days, 8 hours ago
Views: 181 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0