A PHP class to generate PDF files from HTML with Unicode/UTF-8 and CJK support
mPDF is a PHP class which generates PDF files from UTF-8 encoded HTML. It is based on FPDF and HTML2FPDF (see CREDITS), with a number of enhancements. mPDF was written by Ian Back and is released under the GNU GPL v2 licence.
Note: If you are viewing this file on mPDF Github repository homepage, please note that the default repository branch is
developmentwhich can differ from the last stable release.
mPDF 7.0 requires PHP
^5.6 || ~7.0.0. PHP
gd extensions have to be loaded.
~7.1.0 should be compatible.
Additional extensions may be required for some advanced features such as
zlib for compression of embedded
resources such as fonts or
bcmath for generating barcodes.
Official installation method is via composer and its packagist package mpdf/mpdf.
$ composer require mpdf/mpdf
The simplest usage of the library would be as follows:
<?php require_once __DIR__ . '/vendor/autoload.php'; $mpdf = new \Mpdf\Mpdf(); $mpdf->WriteHTML('<h1>Hello world!</h1>'); $mpdf->Output();
This will output the PDF inline to the browser as application/pdf Content-type.
All configuration directives can
be set by the
$config parameter of the constructor.
It is recommended to set one's own temporary directory via
fontTempDir configuration variables.
The directory must have write permissions (mode
775 is recommended).
<?php $mpdf = new \Mpdf\Mpdf(['tempDir' => __DIR__ . '/tmp']);
By default, the temporary directory will be inside vendor directory and will have correct permissions from
post_install composer script.
If you have problems, please read the section on troubleshooting in the manual.
Online manual is available at https://mpdf.github.io/.
See CONTRIBUTING.md file in the project.
Unit testing for mPDF is done using PHPUnit.
To get started, run
composer install from the command line while in the mPDF root directory
(you'll need composer installed first).
To execute tests, run
vendor/bin/phpunit from the command line while in the mPDF root directory.
Any assistance writing unit tests for mPDF is greatly appreciated. If you'd like to help, please
note that any PHP file located in the
/tests/ directory will be autoloaded when unit testing.