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

Parse those tags, mama
LGF • Views: 44,311
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
Editorial: Kobach Is Desperate for Trump’s Approval Kris Kobach has been running a Trump-style gubernatorial campaign since the day he announced. From his empty insistence that there’s a “culture of corruption” in Topeka to his argument that the Legislature’s decision to repeal Gov. Sam Brownback’s tax ...
Thanos
6 hours, 18 minutes ago
Views: 85 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
First Aid Kit - It’s a Shame"It's a Shame" by First Aid Kit is available now: smarturl.it Production Company: Slutet är Nära / slutetarnara.se Director: Mats UddProducer: Petra KrigströmExecutive Producer: Alexandros Bakos Lyrics: genius.com Follow First Aid Kit: firstaidkitband.com facebook.com @firstaidkitband instagram.com
Thanos
1 day, 5 hours ago
Views: 170 • Comments: 1 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Jason Isbell and the 400 Unit - American Girl10/13/2017 Encore on night 4 of Ryman residency
Thanos
1 day, 5 hours ago
Views: 182 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
WALK the MOON - Headphones Get WALK THE MOON's “One Foot” and "Headphones" Instantly When You Pre-Order The New Album 'What If Nothing':iTunes - wtmband.comAmazon - wtmband.comSpotify Pre-Save - wtmband.comGoogle Play - wtmband.comMerch Store - wtmband.com Stream "Headphones" Now:Apple Music - wtmband.comSpotify - wtmband.com ...
Thanos
1 day, 5 hours ago
Views: 150 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Nightmare at PDX In all, Cristina was held for 48 hours with the jail population, though she had committed no crime. She was treated poorly, and denied medical treatment when she requested it. She had no money in her jail phone account ...
Thanos
4 days, 17 hours ago
Views: 725 • Comments: 0 • Rating: 3
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
First-Ever Sex Discrimination Legal Network Is Ready to Defend Women in Trump’s America Shortly after the election, the attorneys and advocates who work at the National Women’s Law Center (NWLC) started having a conversation. It seemed that the incoming Trump administration was likely to move backward on enforcing civil rights, loosening regulations, ...
Birth Control Works
5 days, 15 hours ago
Views: 750 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Meet Rhiannon Giddens, Newly Minted MacArthur ‘Genius’ As a solo artist — and, before that, as a member of the Carolina Chocolate Drops — singer-songwriter Rhiannon Giddens has made a career out of revitalizing and invigorating decades' worth of music reflecting the African-American experience. That's meant ...
Thanos
1 week, 1 day ago
Views: 1,177 • Comments: 0 • Rating: 2
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Lies About Black America Are ‘Central’ to Gun Ownership: A Reporter on What We Get Wrong About Gun Violence Lies that the GOP and Donald Trump promote all day long. “If you look at the neighborhoods where [gun violence] is most clustered,” Beckett said, it’s located in areas with high levels of poverty, low levels of education, and ...
Unshaken Defiance
1 week, 2 days ago
Views: 1,774 • Comments: 0 • Rating: 1
Tweets: 63 • Share to Facebook
Shares: 2
Comments: 0
: 2
St. Vincent Performs ‘Los Ageless’ One of Stephen's very favorite singer-songwriters collaborates with three pairs of boots to perform a song off her new album "Masseduction". Subscribe To "The Late Show" Channel HERE: bit.lyFor more content from "The Late Show with Stephen Colbert", click ...
Thanos
1 week, 2 days ago
Views: 1,415 • Comments: 0 • Rating: 1
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Star Wars: The Last Jedi Trailer (Official) Watch the new trailer for Star Wars: The Last Jedi and see it in theaters December 15. Get your tickets now: fandango.com Visit Star Wars at starwars.comSubscribe to Star Wars on YouTube at youtube.comLike Star Wars on Facebook at ...
Thanos
1 week, 2 days ago
Views: 1,366 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0