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

Parse those tags, mama
LGF • Views: 47,202
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
Trump’s Nixon-Style Enemies List So many Parallels - how much longer will the public put up with this? Reacting to The New York Times’ story that White House Counsel Don McGahn has been speaking with Robert Mueller’s team, President Donald Trump tweeted out ...
Thanos
14 hours, 8 minutes ago
Views: 84 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
Calexico - End of the World With You (Live on KEXP) kexp.org presents Calexico performing "End Of The World With You" live in the KEXP studio. Recorded June 19, 2018. Host: MorganAudio Engineers: Martin H. Gonzalez & Julian MartlewCameras: Jim Beckmann, Alaia D'Alessandro, Scott Holpainen & Justin WilmoreEditor: Jim Beckmann ...
Thanos
6 days, 18 hours ago
Views: 175 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
LSD - Thunderclouds (Official Audio) Ft. Sia, Diplo, Labrinth Labrinth, Sia & Diplo present LSD - Thunderclouds (Official Audio) Stream "Thunderclouds" now: smarturl.itSpotify: smarturl.itiTunes: smarturl.itApple Music: smarturl.itAmazon Music: smarturl.it Learn more about LSD and sign up for the official mailing list: droppinglsd.com Lyrics: All I need is oneOne ...
Thanos
6 days, 19 hours ago
Views: 227 • Comments: 1 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
Half•alive - Still Feel. [Music VIDEO] half•alive’s music video for ‘still feel.’ Save on Spotify : spoti.fi Apple Music : apple.coSoundcloud : SoundCloud find half•alive on… Instagram: instagr.amTwitter: @halfalivecoSpotify: spoti.fiSoundcloud: SoundCloudSite: halfalive.co Directed / Edited / Colored by : Josh TaylorDirector of Photography : Ryan ...
Thanos
6 days, 19 hours ago
Views: 264 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
Bands and Artists I LoveSuperorganism. Your text to link...
The Artist Formerly Known as Irenicum
1 week, 1 day ago
Views: 210 • Comments: 1 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
Dave Grohl - Play (Official Video) PLAY more at play.roswellfilms.com Pre-order limited edition vinyl bundles and stream the song: smarturl.it “PLAY” by Dave Grohl celebrates the rewards and challenges of dedicating one’s life to playing and mastering a musical instrument. Part one opens with narrated ...
Thanos
1 week, 2 days ago
Views: 214 • Comments: 0 • Rating: 1
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
The Seshen - Distant Heart (Live on KEXP) kexp.org presents The Seshen performing "Distant Heart" live at The Little London Plane during Upstream Music Fest. Recorded June 1, 2018. Host: Kevin ColeAudio Engineer: Kevin SuggsCameras: Jim Beckmann, Alaia D'Alessandro & Justin WilmoreDirector: Scott HolpainenEditor: Alaia D'Alessandro kexp.orgtheseshen.comupstreammusicfest.com ...
Thanos
2 weeks ago
Views: 998 • Comments: 0 • Rating: 0
Tweets: 1 • Share to Facebook
Shares: 0
Comments: 0
: 0
Retrograde PresidentProfit at any cost. American dream. President Trump. Blind destruction. BBC News: The Trump administration has overturned bans on the use of pesticides linked to declining bee populations and the cultivation of genetically modified crops in US national wildlife refuges. ...
Dom
2 weeks, 1 day ago
Views: 761 • Comments: 0 • Rating: 0
Tweets: 0 • Share to Facebook
Shares: 0
Comments: 0
: 0
David Crosby and Jason Isbell ‘Ohio’----Newport
Thanos
2 weeks, 2 days ago
Views: 1,146 • Comments: 1 • Rating: 3
Tweets: 2 • Share to Facebook
Shares: 0
Comments: 0
: 0
Activist Publishes 11,000 Private DMs Between Wikileaks and Its Supporters The DMs concern a particular group chat between the official Wikileaks account and several supporters. In the chat—dubbed “Wikileaks +10” due to number of participants—Wikileaks would coordinate smear campaigns against the group’s rivals, including journalists, according to the DMs. ...
Thanos
2 weeks, 6 days ago
Views: 1,667 • Comments: 0 • Rating: 0
Tweets: 2 • Share to Facebook
Shares: 0
Comments: 0
: 0