Template::Plugin::Dumper(3) User Contributed Perl Documentation Template::Plugin::Dumper(3)

# [NAME](#NAME)

Template::Plugin::Dumper - Plugin interface to Data::Dumper

# [SYNOPSIS](#SYNOPSIS)

```
    [% USE Dumper %]
    
    [% Dumper.dump(variable) %]
    [% Dumper.dump_html(variable) %]
```

# [DESCRIPTION](#DESCRIPTION)

This is a very simple Template Toolkit Plugin Interface to the Data::Dumper module. A "Dumper" object will be instantiated via the following directive:

```
    [% USE Dumper %]
```

As a standard plugin, you can also specify its name in lower case:

```
    [% USE dumper %]
```

The following Data::Dumper options are supported as constructor arguments to affect the output generated:

"Indent", "Pad", "Varname", "Purity", "Useqq", "Terse", "Freezer", "Toaster", "Deepcopy", "Quotekeys", "Bless", "Maxdepth", "Sortkeys".

See Data::Dumper for further details on each option.

```
    [% USE dumper(Indent=0, Pad="<br>") %]
    [% USE dumper(Sortkeys=1, Terse=1) %]
```

These options can also be specified in lower case.

```
    [% USE dumper(indent=0, pad="<br>") %]
```

# [METHODS](#METHODS)

There are two methods supported by the "Dumper" object. Each will output into the template the contents of the variables passed to the object method.

## **dump()**

Generates a raw text dump of the data structure(s) passed

```
    [% USE Dumper %]
    [% Dumper.dump(myvar) %]
    [% Dumper.dump(myvar, yourvar) %]
```

## **dump\_html()**

Generates a dump of the data structures, as per **dump()**, but with the characters &lt;, &gt; and & converted to their equivalent HTML entities and newlines converted to &lt;br&gt;.

```
    [% USE Dumper %]
    [% Dumper.dump_html(myvar) %]
```

# [AUTHOR](#AUTHOR)

Simon Matthews &lt;sam@tt2.org&gt;

# [COPYRIGHT](#COPYRIGHT)

Copyright (C) 2000 Simon Matthews. All Rights Reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

# [SEE ALSO](#SEE_ALSO)

Template::Plugin, Data::Dumper

2026-10-26 perl v5.44.0

---

Document: Template::Plugin::Dumper(3pm) from perl-template-toolkit 3.106-r4 (Chainguard OS)
Source: https://github.com/abw/Template2.git