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

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

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:

$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
A Science Journal Funded by Peter Thiel Is Running Articles Dismissing Climate Change and Evolution - Mother Jones everal articles on the site argued against the theory of evolution, for example, and at least one dismissed the overwhelming scientific consensus on global warming. Later, through tax documents and interviews, I would learn that all of Inference‘s funding ...
Thanos
12 hours, 4 minutes ago
Views: 123 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
20 Things I Don’t Know About Youblog.timesunion.com Who is the average blog reader? More importantly, who is the average Hoffman Files reader? What does this individual look like? Are they predominantly female or male? Are there certain ages of individuals who favor perusing the blog pages? ...
rhoffman
4 days, 4 hours ago
Views: 250 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
Lower Prescription Drug Prices Lure Americans to Mexico to Buy Meds "At that point I started tearing up. I could not believe how inexpensive it was and how easy it was," Greenseid says. "I said to [the pharmacist], 'Do you have any idea what it's like to get insulin in ...
Thanos
6 days, 9 hours ago
Views: 191 • Comments: 0 • Rating: 1
Tweets: 2 • Share to Facebook
Shares: 0
Comments: 0
: 0
California Gov. Gavin Newsom to Pull National Guard From Border With Mexico - Los Angeles Times Love the new Gov. In released excerpts of his speech, Newsom says he is giving the National Guard a new mission so that troops would not take part in the White House’s “political theater” and instead “refocus on the ...
Unshaken Defiance
1 week ago
Views: 265 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
It’s a Miracle! …Or Is It? SOURCES ARE BELOW:The charity I strongly endorse is called ASRI. It’s a hospital in Borneo that provides affordable health care to villages on the edge of a national park in return for a pledge not to cut down trees, ...
Thanos
1 week ago
Views: 277 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Drug Companies Are Sitting on Generics—43% of Recently Approved Aren’t for Sale Posting for that friend who loves to tell me that Trump and capitalism will find a way to produce needed drugs and make them cheaper... There are huge markets going untapped, and stagnant pools of decades old capital out ...
Thanos
1 week ago
Views: 247 • Comments: 0 • Rating: 1
Tweets: 1 • Share to Facebook
Shares: 2
Comments: 0
: 2
Facebook Fights Multibillion-Dollar Privacy Class Action SAN FRANCISCO (CN) – A federal judge on Friday rejected Facebook’s argument that it cannot be sued for letting third parties, such as Cambridge Analytica, access users’ private data because no “real world” harm has resulted from the conduct. ...
Thanos
2 weeks ago
Views: 313 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
The Specials - Vote for Me (Live - the One Show) (2019) (HD) 1979 to 2019... Celebrating 40 years of what is arguably one of the most important and influential music genres/ movements ever to influence the British music scene in it's history... 2 Tone... which for many became much more than ...
Thanos
2 weeks, 2 days ago
Views: 320 • Comments: 0 • Rating: 2
Tweets: 1 • Share to Facebook
Shares: 1
Comments: 0
: 1
Vampire Weekend - Harmony Hall (Official Audio) Harmony Hall/2021 available everywhere now: smarturl.it Lyrics: We took a vow in summertimeNow we find ourselves in late December I believe that New Year’s EveWill be the perfect timeFor their great surrender But they don’t remember Anger wants a ...
Thanos
2 weeks, 2 days ago
Views: 291 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
Feel It Still - Portugal the Man (’60s ‘Mr. Postman’ Style Cover) Ft. Joey, Adanna, Nina Ann Get the song: smarturl.it | Subscribe: bit.ly 2019 World Tour Tix: pmjtour.com | Our first video of 2019 stars Joey Cook, Adanna Duru & Nina Ann (in her PMJ debut!) in a "Mr. Postman" inspired take on "Feel It ...
Thanos
2 weeks, 2 days ago
Views: 352 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0