Download

The current version of HTML Purifier is 4.5.0, released on 2013-02-17, and is compatible with PHP 5.0.5 and up (all code is E_STRICT compliant). This library is open-source, licensed under the LGPL v2.1+. We offer multiple ways of downloading and installing HTML Purifier.

Standard

We offer the standard zip and tarball downloads. Download them, unzip them, and with a few simple installation steps get to using HTML Purifier right away:

Lite Distribution

No, it's not magically faster. HTML Purifier Lite offers the same functionality of HTML Purifier (standard), except that anything not essentially to the basic functioning of the library has been stripped out: end-user documentation, unit-tests, profiling, maintenance scripts, etc. Just the library folder.

Standalone Distribution

For those of you who balk at the possibility of a 100+ includes, we also offer a conveniently packaged single-file version of HTML Purifier. Well, not really, since HTML Purifier does require some auxiliary files in order to work (but they are neatly tucked away in a folder named standalone). Include HTMLPurifier.standalone.php and be done with it!

SHA-1 checksums

Here are the SHA-1 checksums you can use to verify the integrity of your HTML Purifier download: 

9286f3c854cac229f142cdf21698bb246abd61d7  htmlpurifier-4.5.0-lite.tar.gz
63e8be62bcfcd8f7ec9fe253d2de9324982bdb40  htmlpurifier-4.5.0-lite.zip
82402dca2871831ae7138bf0205497b747376eb0  htmlpurifier-4.5.0-standalone.tar.gz
79a86aba75bcf970485295002bcfb73a2a3c20ef  htmlpurifier-4.5.0-standalone.zip
5ec90bae73f124badf44c36e93e2f598ba9ccea0  htmlpurifier-4.5.0.tar.gz
2df8f1bd83f89cde72dc852ee90ddc40bd3311cb  htmlpurifier-4.5.0.zip

GnuPG signatures

There are .sig files which you can use to cryptographically verify that the release is from me, Edward Z. Yang. You can find my public key here (0x869C48DA). My key's fingerprint is: 3FA8 E9A9 7385 B691 A6FC B3CB A933 BE7D 869C 48DA.

Verify files with this command:

gpg --verify $filename.sig

Future releases will be signed with my new ezyang@mit.edu key. This key is signed by my old key, and you can retrieve the signature from pgp.mit.edu.

PEAR

HTML Purifier is also available via a PEAR channel. The PEAR installer is an incredibly powerful and robust way to install PHP packages, and does not have to be limited to packages found on pear.php.net. With PEAR, installing is as simple as these two commands in your shell: 

pear channel-discover htmlpurifier.org
pear install hp/HTMLPurifier

...and then following the installation instructions.

You can upgrade with: 

pear upgrade hp/HTMLPurifier

Git

For those who like to live on the edge, you can also grab the latest developmental code from our Git repository. Simply execute this command in your shell: 

git clone git://repo.or.cz/htmlpurifier.git

You must have Git installed. Windows users can grab a copy of Git via the msysgit project.

Code in master is quite stable; a combination of extensive unit-testing and atomic commits means that the most recent version will almost never be broken.

Online repository browsing and mirroring services (click links to get pull URLs) are available at numerous places:

Installation

File permissions

HTML Purifier will write out cache files for HTMLDefinition in the subdirectories of HTMLPurifier/DefinitionCache/Serializer. If you are in the library/ folder of HTML Purifier, you can set the appropriate permissions using: 

chmod -R 0755 HTMLPurifier/DefinitionCache/Serializer

If the above command doesn't work, you may need to assign write permissions to all. This may be necessary if your webserver runs as nobody, but is not recommended since it means any other user can write files in the directory. Use: 

chmod -R 0777 HTMLPurifier/DefinitionCache/Serializer

You can also chmod files via your FTP client; this option is usually accessible by right clicking the corresponding directory and then selecting “chmod” or “file permissions”.

If you are unable or unwilling to give write permissions to the cache directory, you can either disable the cache (and suffer a performance hit): 

$config->set('Core', 'DefinitionCache', null);

Or move the cache directory somewhere else (no trailing slash): 

$config->set('Cache', 'SerializerPath', '/home/user/absolute/path');

Quick install

If your website is in UTF-8 and XHTML Transitional, use this code:

<?php
    require_once '/path/to/htmlpurifier/library/HTMLPurifier.auto.php';
    
    $purifier = new HTMLPurifier();
    $clean_html = $purifier->purify($dirty_html);
?>

If your website is in a different encoding or doctype, use this code:

<?php
    require_once '/path/to/htmlpurifier/library/HTMLPurifier.auto.php';
    
    $config = HTMLPurifier_Config::createDefault();
    $config->set('Core', 'Encoding', 'ISO-8859-1'); // replace with your encoding
    $config->set('HTML', 'Doctype', 'HTML 4.01 Transitional'); // replace with your doctype
    $purifier = new HTMLPurifier($config);
    
    $clean_html = $purifier->purify($dirty_html);
?>

People with HTML Purifier already in their path (PEAR, for example) can use: 

require_once 'HTMLPurifier.auto.php';

For detailed installation instructions, read the INSTALL document.

Mailing list

You can be notified of new releases by a low-traffic announce list. Subscribe at the mailman page. We take your privacy very seriously and will not use emails submitted to this web form for any other purposes.

You can also subscribe to a moderately higher traffic, unmoderated mailing list intended for development discussion and user support at Google Groups.

History

Previous releases can be obtained by browsing the release directory or checking code out of the tags/ directory. However, they are not supported and should not be used in live environments. If you are having trouble upgrading, pop over to the forums and get help.