HTML to Image / PHP Examples

This page contains various examples of using the HTML to Image API in PHP. The examples are complete and fully functional. Read more about how to convert HTML to Image in PHP.

Basic examples
Template rendering examples
PHP website examples
Laravel examples
Symfony examples

Basic examples

Webpage to PNG file

<?php
require "pdfcrowd.php";

try
{
    // Create an API client instance.
    $client = new \Pdfcrowd\HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

    // Configure the conversion.
    $client->setOutputFormat("png");

    // Run the conversion and save the result to a file.
    $client->convertUrlToFile("http://www.example.com", "example.png");
}
catch(\Pdfcrowd\Error $why)
{
    error_log("PDFCrowd Error: {$why}");
    throw $why;
}

?>

Webpage to in-memory PNG

<?php
require "pdfcrowd.php";

try
{
    // Create an API client instance.
    $client = new \Pdfcrowd\HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

    // Configure the conversion.
    $client->setOutputFormat("png");

    // Run the conversion and store the result in the `image` variable.
    $image = $client->convertUrl("http://www.example.com");

    // at this point the "image" variable contains PNG raw data and
    // can be sent in an HTTP response, saved to a file, etc.
}
catch(\Pdfcrowd\Error $why)
{
    error_log("PDFCrowd Error: {$why}");
    throw $why;
}

?>

Webpage to PNG stream

<?php
require "pdfcrowd.php";

try
{
    // Create an API client instance.
    $client = new \Pdfcrowd\HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

    // Configure the conversion.
    $client->setOutputFormat("png");

    // Create an output stream for the conversion result
    $output_stream = fopen("example.png", "wb");

    // Check for a file creation error.
    if (!$output_stream)
        throw new \Exception(error_get_last()['message']);

    // run the conversion and write the result to the output stream.
    $client->convertUrlToStream("http://www.example.com", $output_stream);

    // Close the output stream.
    fclose($output_stream);
}
catch(\Pdfcrowd\Error $why)
{
    error_log("PDFCrowd Error: {$why}");
    throw $why;
}

?>

HTML file to PNG file

<?php
require "pdfcrowd.php";

try
{
    // Create an API client instance.
    $client = new \Pdfcrowd\HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

    // Configure the conversion.
    $client->setOutputFormat("png");

    // Run the conversion and save the result to a file.
    $client->convertFileToFile("/path/to/MyLayout.html", "MyLayout.png");
}
catch(\Pdfcrowd\Error $why)
{
    error_log("PDFCrowd Error: {$why}");
    throw $why;
}

?>

HTML file to in-memory PNG

<?php
require "pdfcrowd.php";

try
{
    // Create an API client instance.
    $client = new \Pdfcrowd\HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

    // Configure the conversion.
    $client->setOutputFormat("png");

    // Run the conversion and store the result in the `image` variable.
    $image = $client->convertFile("/path/to/MyLayout.html");

    // at this point the "image" variable contains PNG raw data and
    // can be sent in an HTTP response, saved to a file, etc.
}
catch(\Pdfcrowd\Error $why)
{
    error_log("PDFCrowd Error: {$why}");
    throw $why;
}

?>

HTML file to PNG stream

<?php
require "pdfcrowd.php";

try
{
    // Create an API client instance.
    $client = new \Pdfcrowd\HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

    // Configure the conversion.
    $client->setOutputFormat("png");

    // Create an output stream for the conversion result
    $output_stream = fopen("MyLayout.png", "wb");

    // Check for a file creation error.
    if (!$output_stream)
        throw new \Exception(error_get_last()['message']);

    // run the conversion and write the result to the output stream.
    $client->convertFileToStream("/path/to/MyLayout.html", $output_stream);

    // Close the output stream.
    fclose($output_stream);
}
catch(\Pdfcrowd\Error $why)
{
    error_log("PDFCrowd Error: {$why}");
    throw $why;
}

?>

HTML string to PNG file

<?php
require "pdfcrowd.php";

try
{
    // Create an API client instance.
    $client = new \Pdfcrowd\HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

    // Configure the conversion.
    $client->setOutputFormat("png");

    // Run the conversion and save the result to a file.
    $client->convertStringToFile("<html><body><h1>Hello World!</h1></body></html>", "HelloWorld.png");
}
catch(\Pdfcrowd\Error $why)
{
    error_log("PDFCrowd Error: {$why}");
    throw $why;
}

?>

HTML string to in-memory PNG

<?php
require "pdfcrowd.php";

try
{
    // Create an API client instance.
    $client = new \Pdfcrowd\HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

    // Configure the conversion.
    $client->setOutputFormat("png");

    // Run the conversion and store the result in the `image` variable.
    $image = $client->convertString("<html><body><h1>Hello World!</h1></body></html>");

    // at this point the "image" variable contains PNG raw data and
    // can be sent in an HTTP response, saved to a file, etc.
}
catch(\Pdfcrowd\Error $why)
{
    error_log("PDFCrowd Error: {$why}");
    throw $why;
}

?>

HTML string to PNG stream

<?php
require "pdfcrowd.php";

try
{
    // Create an API client instance.
    $client = new \Pdfcrowd\HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

    // Configure the conversion.
    $client->setOutputFormat("png");

    // Create an output stream for the conversion result
    $output_stream = fopen("HelloWorld.png", "wb");

    // Check for a file creation error.
    if (!$output_stream)
        throw new \Exception(error_get_last()['message']);

    // run the conversion and write the result to the output stream.
    $client->convertStringToStream("<html><body><h1>Hello World!</h1></body></html>", $output_stream);

    // Close the output stream.
    fclose($output_stream);
}
catch(\Pdfcrowd\Error $why)
{
    error_log("PDFCrowd Error: {$why}");
    throw $why;
}

?>

Get info about the current conversion

<?php
require "pdfcrowd.php";

try
{
    // Create an API client instance.
    $client = new \Pdfcrowd\HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

    // Configure the conversion.
    $client->setOutputFormat("png");
    $client->setDebugLog(true);

    // Run the conversion and save the result to a file.
    $client->convertFileToFile("/path/to/MyLayout.html", "MyLayout.png");
    
    // print URL pointing to the debug log for this request.
    echo "Debug log url: " . $client->getDebugLogUrl() . "\n";
    
    // print Number of conversion credits remaining in your account.
    echo "Remaining credit count: " . $client->getRemainingCreditCount() . "\n";
    
    // print Number of credits consumed for this conversion.
    echo "Consumed credit count: " . $client->getConsumedCreditCount() . "\n";
    
    // print Unique identifier assigned to this conversion job.
    echo "Job id: " . $client->getJobId() . "\n";
    
    // print Size of the output data in bytes.
    echo "Output size: " . $client->getOutputSize() . "\n";
}
catch(\Pdfcrowd\Error $why)
{
    error_log("PDFCrowd Error: {$why}");
    throw $why;
}

?>

Template rendering examples

Create Image from JSON data

<?php
require "pdfcrowd.php";

try
{
    // Create an API client instance.
    $client = new \Pdfcrowd\HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

    // Configure the conversion.
    $client->setOutputFormat("png");
    $client->setDataString('{
            "name": "World",
            "product": "Pdfcrowd API"
        }');

    // Run the conversion and save the result to a file.
    $client->convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf");
}
catch(\Pdfcrowd\Error $why)
{
    error_log("PDFCrowd Error: {$why}");
    throw $why;
}

?>

Create Image from XML data

<?php
require "pdfcrowd.php";

try
{
    // Create an API client instance.
    $client = new \Pdfcrowd\HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

    // Configure the conversion.
    $client->setOutputFormat("png");
    $client->setDataString('<?xml version="1.0" encoding="UTF-8"?>
        <data>
          <name>World</name>
          <product>Pdfcrowd API</product>
        </data>');

    // Run the conversion and save the result to a file.
    $client->convertStringToFile("Hello {{ data.name }} from {{ data.product }}", "output.pdf");
}
catch(\Pdfcrowd\Error $why)
{
    error_log("PDFCrowd Error: {$why}");
    throw $why;
}

?>

Create Image from YAML data

<?php
require "pdfcrowd.php";

try
{
    // Create an API client instance.
    $client = new \Pdfcrowd\HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

    // Configure the conversion.
    $client->setOutputFormat("png");
    $client->setDataString("name: World
product: Pdfcrowd API");

    // Run the conversion and save the result to a file.
    $client->convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf");
}
catch(\Pdfcrowd\Error $why)
{
    error_log("PDFCrowd Error: {$why}");
    throw $why;
}

?>

Create Image from CSV data

<?php
require "pdfcrowd.php";

try
{
    // Create an API client instance.
    $client = new \Pdfcrowd\HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

    // Configure the conversion.
    $client->setOutputFormat("png");
    $client->setDataString("name,product
World,Pdfcrowd API");

    // Run the conversion and save the result to a file.
    $client->convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf");
}
catch(\Pdfcrowd\Error $why)
{
    error_log("PDFCrowd Error: {$why}");
    throw $why;
}

?>

PHP website examples

Laravel examples

Symfony examples