KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #deepseek-harness #typescript #ai-agent #codex #developer-tools #claude-code #windows #mcp #python #desktop-app

php-weasyprint

★ 79 Open GitHub ↗

PHP library allowing PDF generation or snapshot from an URL or an HTML page. Wrapper for Kozea/WeasyPrint

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PhpWeasyPrint

PhpWeasyPrint is a PHP library allowing PDF generation from a URL or an HTML page.
It's a wrapper for [WeasyPrint](https://weasyprint.org/), a smart solution helping web developers to create PDF documents, available everywhere Python runs.

You will have to download and install WeasyPrint to use PhpWeasyPrint (version 60 or greater is required).

This library is massively inspired by [KnpLabs/snappy](https://github.com/KnpLabs/snappy) and aims to be a drop-in replacement: its `GeneratorInterface` mirrors Snappy's method contract (same method names and behaviour), though it lives in its own namespace and is strictly typed (`string`-only input, declared return types).
See "[Differences with Snappy](#differences-with-snappy)" section to see how the two differs

## Requirements

* PHP 8.3, 8.4 or 8.5
* WeasyPrint 60 or greater

## Installation using [Composer](https://getcomposer.org/)

```bash
$ composer require pontedilana/php-weasyprint
```

## Usage

### Initialization

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Pontedilana\PhpWeasyPrint\Pdf;

$pdf = new Pdf('/usr/local/bin/weasyprint');

// or you can do it in two steps
$pdf = new Pdf();
$pdf->setBinary('/usr/local/bin/weasyprint');
```

### Display the pdf in the browser

```php
$pdf = new Pdf('/usr/local/bin/weasyprint');
header('Content-Type: application/pdf');
echo $pdf->getOutput('https://www.github.com');
```

### Download the pdf from the browser

```php
$pdf = new Pdf('/usr/local/bin/weasyprint');
header('Content-Type: application/pdf');
header('Content-Disposition: attachment; filename="file.pdf"');
echo $pdf->getOutput('https://www.github.com');
```

### Generate local pdf file

```php
$pdf = new Pdf('/usr/local/bin/weasyprint');
$pdf->generateFromHtml('<h1>Bill</h1><p>You owe me money, dude.</p>', '/tmp/bill-123.pdf');
```

### Pass options to PhpWeasyPrint

```php
// Type weasyprint -h to see the list of options
$pdf = new Pdf('/usr/local/bin/weasyprint');
$pdf->setOption('encoding', 'utf8');
$pdf->setOption('media-type', 'screen');
$pdf->setOption('presentational-hints', true);
$pdf->setOption('optimize-images', true);
$pdf->setOption('stylesheet', ['/path/to/first-style.css', '/path/to/second-style.css']);
$pdf->setOption('attachment', ['/path/to/image.png', '/path/to/logo.jpg']);
```

For options whose value is constrained to a fixed set, you can pass a backed enum
instead of a raw string (it is converted to its scalar value automatically):

```php
use Pontedilana\PhpWeasyPrint\Enum\MediaType;
use Pontedilana\PhpWeasyPrint\Enum\PdfVariant;
use Pontedilana\PhpWeasyPrint\Enum\PdfVersion;

$pdf->setOption('media-type', MediaType::Screen);
$pdf->setOption('pdf-variant', PdfVariant::PdfA3b);
$pdf->setOption('pdf-version', PdfVersion::Pdf17);
```

### Allowed URL schemes

Options that accept URLs (e.g. `attachment`) may be fetched server-side by the library.
To prevent SSRF and local file disclosure, only `http` and `https` URLs are fetched by
default; a value with any other scheme is treated as inline content instead of being
fetched. Local files keep working through their plain filesystem path.

If you need to fetch other schemes, pass an allow-list as the fourth constructor argument:

```php
// Default: only http(s) URLs are fetched
$pdf = new Pdf('/usr/local/bin/weasyprint');
$pdf->setOption('attachment', ['https://example.com/logo.png', '/path/to/local.png']);

// Opt in to additional schemes (e.g. ftp)
$pdf = new Pdf('/usr/local/bin/weasyprint', [], null, ['http', 'https', 'ftp']);

// Or, with named arguments (PHP 8.0+)
$pdf = new Pdf('/usr/local/bin/weasyprint', allowedSchemes: ['http', 'https', 'ftp']);
```

### Command execution

The WeasyPrint process is executed from an argument array (`new Process([...])`), **never through a shell**. This makes command injection through option values, filenames or the binary path structurally impossible: there is no shell to interpret metacharacters, so no escaping is involved at execution time.

`getCommand()` and `buildCommand()` still return the command as a human-readable, shell-escaped string, but that representation is used only for logging and exception messages — it is not what gets executed.

> **Note for libraries extending `AbstractGenerator`/`Pdf`:**
> if you override `executeCommand()`, its signature changed from `executeCommand(string $command)` to `executeCommand(array $command)`. The binary executability check also moved from `getEscapedBinary()` to the new `checkBinary()` method.

### Reset options
Options can be reset to their initial values with `resetOptions()` method.

```php
$pdf = new Pdf('/usr/local/bin/weasyprint');
// Set some options
$pdf->setOption('media-type', 'screen');
// ..
// Reset options
$pdf->resetOptions();
```

### Timeouts

A default timeout of 10 seconds is set for the WeasyPrint process to prevent orphaned or hanging processes.  
This is a defensive measure that applies in most cases and helps ensure system stability.

You can change the timeout with the `setTimeout()` method:

```php
$pdf = new Pdf('/usr/local/bin/weasyprint');
$pdf->setTimeout(30); // 30 seconds
```

The timeout can be disabled entirely using either of the following:

```php
$pdf->setTimeout(null);
// or
$pdf->disableTimeout();
```

This is especially useful if you're running inside a *queue worker*, *job runner*, or other environments that already handle timeouts (e.g. Symfony Messenger, Laravel Queue, Supervisor).  
Disabling the internal timeout in those cases avoids conflicts with higher-level timeout strategies.

> **Note:**  
> The `setTimeout()` method affects **both**:
> - how long the process is allowed to run before being forcibly stopped, and
> - the `--timeout` option passed to the WeasyPrint command-line tool.
>
> If you only want to disable WeasyPrint's own timeout (while keeping the execution time limit), use:
>
> ```php
> $pdf->setOption('timeout', null);
> ```

## Differences with Snappy

Although PhpWeasyPrint and Snappy are interchangeable, there are a couple of differences between the two, due to WeasyPrint CLI API:

* WeasyPrint doesn't support multiple sources to be merged in one single output pdf, so only one input source (string or URL) is accepted in PhpWeasyPrint;
* WeasyPrint version >= 53 doesn't generate images, so image generation from HTML string or URL is possible only with WeasyPrint lower versions and an unsupported PhpWeasyPrint version (`Pontedilana\PhpWeasyPrint\Image` has been successfully tested with Weasyprint 52.5 on PhpWeasyPrint 0.13.0).

## Bugs & Support

If you found a bug please fill a [detailed issue](https://github.com/pontedilana/php-weasyprint/issues) with all the following points.
If you need some help, please at least provide a complete reproducer, so we could help you based on facts rather than assumptions.

* OS and its version
* WeasyPrint, its version and how you installed it
* A complete reproducer with relevant PHP and html/css/js code

If your reproducer is big, please try to shrink it. It will help everyone to narrow the bug.

## Credits

PhpWeasyPrint has been originally developed by the [Pontedilana](https://www.pontedilana.it) dev team.  
Snappy has been originally developed by the [KnpLabs](https://knplabs.com) team.

php-weasyprint

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README