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

Parse those tags, mama
LGF • Views: 48,177
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
Nothing to See here… Except Russian as New President of Interpolwashingtonpost.com The advancement of worldwide Authoritarianism and Putin’s agenda advances at an ever increasing rate. I especially am entertained about the Russian official’s Tweet about arresting the entire Ukrainian Government. That should be good for a few laughs inside the ...
Rocky-in-Connecticut
13 hours, 46 minutes ago
Views: 66 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Katie Porter Wins in California Porter becomes the fourth Democrat to flip a Republican-held House seat in Southern California this cycle; Democrat Gil Cisneros now leads Republican Young Kim in the last uncalled race and is poised to become the fifth. Advertise with Mother ...
Thanos
5 days, 4 hours ago
Views: 182 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
European Court: Russia’s Arrests of Navalny Were Political The court’s highest chamber found that Russian authorities violated multiple human rights in detaining Navalny seven times from 2012 to 2014, and that two of the arrests were expressly aimed at “suppressing political pluralism.” It ordered Russia to pay ...
Thanos
6 days, 4 hours ago
Views: 189 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
“Documenting Hate: New American Nazis, ” Coming Soon… — ProPublica In the wake of the deadly anti-Semitic attack at the Tree of Life synagogue in Pittsburgh, ProPublica and Frontline present a new investigation into white supremacist groups in America — in particular, a neo-Nazi group, Atomwaffen Division, that has ...
Thanos
1 week, 1 day ago
Views: 243 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
Democrat Kyrsten Sinema Wins Arizona Senate Race, Flipping Second GOP Seat Democrat Kyrsten Sinema has defeated Republican Martha McSally to win the Arizona Senate race, the Associated Press projected Monday evening. With Sinema's victory to flip the open seat of retiring GOP Sen. Jeff Flake, she becomes the first Democrat ...
Thanos
1 week, 1 day ago
Views: 231 • Comments: 0 • Rating: 0
Tweets: 2 • Share to Facebook
Shares: 0
Comments: 0
: 0
I DONT KNOW HOW but THEY FOUND ME - Do It All the Time This footage was first thought to be a conceptual art piece produced by the band before making music videos had become standard music industry practice. While the exact date and circumstances under which it was produced are unclear, the ...
Thanos
1 week, 3 days ago
Views: 268 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
Sirintip - Don’t Give Up (Youtube Spaces Session) “Don’t Give Up”Music and lyrics by Sirintip Sirintip - voiceHorace Bray - guitarAndrew Freedman - keysJames Quinlan - bassNolan Byrd - drums Filmed at: Youtube Space New York Videographer: Matt MarlinskiAudio Engineer: Irving GadouryMixed by: Jonathan SmithMixed at: Galaxy ...
Thanos
1 week, 3 days ago
Views: 280 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
Muse Perform the Dark Side on Later… With Jools HollandMuse perform The Dark Side on Later... with Jools Holland on BBC Two (6th October 2018). For more performances and interviews from the show, subscribe now: bit.ly. Watch the whole episode here: bbc.co.uk
Thanos
1 week, 3 days ago
Views: 244 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
The Pentagon Has Prepared a Cyberattack Against Russia Officials say the new Trump cyberoperations order, National Security Presidential Memorandum 13 (NSPM 13), is designed to allow Defense Secretary James Mattis and Director of National Intelligence Dan Coats to approve retaliatory strikes without the approval of others in ...
Unshaken Defiance
2 weeks, 4 days ago
Views: 436 • Comments: 1 • Rating: 1
Tweets: 3 • Share to Facebook
Shares: 0
Comments: 0
: 0
Trump’s Orwellian EPA Disappears Climate Change Pagemotherboard.vice.com epa.gov pages that previously provided information about climate change have been changed from claiming that they are "updating" to an error message that reads, "We want to help you find what you are looking for," as revealed by a ...
Rocky-in-Connecticut
2 weeks, 4 days ago
Views: 581 • Comments: 0 • Rating: 1
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0