Kint

Zero-setup replacement for var_dump(), print_r(), and debug_backtrace().

Advanced usage

Modifiers

Modifiers are a way to change Kint output without having to use a different function. Simply prefix your call to kint with a modifier to apply it:

! Expand all data in this dump automatically
+ Disable the depth limit in this dump
- Attempt to clear any buffered output before this dump
@ Return the output of this dump instead of echoing it
~ Use the text renderer for this dump

Example:

+Kint::dump($data); // Disabled depth limit
!d($data); // Expanded automatically

Helper functions

Sometimes you want to change Kint behavior without using a plugin, or just add a new function name for Kint. You can do that by making a new helper function.

In this example we’re going to make a helper function that only takes one parameter, but returns it afterwards.

<?php

// Some Kint features (Variable names, modifiers, mini trace) only work if Kint
// knows where it was called from. But Kint can't know that if it doesn't know
// what the helper function is called. Add your functions to `Kint::$aliases`.
Kint::$aliases[] = 'dr';

function dr($var)
{
    Kint::dump($var);
    return $var;
}

Removed dd, sd, and ddd helper functions

The dd, sd, and ddd functions have been removed from Kint as of 2.0.

They were polluting the global namespace (And conflicting with some popular packages such as Laravel) and all they provided was an exit after dumping.

You can just exit manually, or reimplement them with aliases like this:

<?php
function ddd(...$vars)
{
    Kint::dump(...$vars);
    exit;
}
Kint::$aliases[] = 'ddd';

This works on PHP 5.6+. Use func_get_args and call_user_func_array if you’re on end-of-life PHP versions

Disabling helper functions in composer

Kint won’t define the d() and s() helper functions if they already exist, but when using composer you may sometimes want to disable them ahead of time.

By adding an extra.kint.disable-helper-functions key to your composer.json, Kint will skip defining the helper functions. You can use this in your root composer.json, or any package installed alongside Kint, and it should work.

{
    "require-dev": {
        "kint-php/kint": "^2.0"
    },
    "extra": {
        "kint": {
            "disable-helper-functions": true
        }
    }
}

Kint::dumpArray

With Kint 2.2 comes a new helper function: Kint::dumpArray which can be used to manually supply seeds for variables. This means you can supply your own names and access paths for the dumped variables to replace the ones discovered by the Kint_SourceParser.

For a simple example, if you want to print the context in twig, you could supply the variable names while dumping to ensure they are all shown in the output:

<?php

function dumpContext(array $context) {
    $names = [];
    $values = [];

    foreach ($context as $name => $value) {
        $values[] = $value;
        $o = new Kint_Object();
        $o->name = $name;
        $names[] = $o;
    }

    return @Kint::dumpArray($values, $names);
}

Render modes

Kint has 4 render modes available by default:

Rich

This is the one you saw on the previous page. It outputs the most data possible in an easy to read way.

Use this output mode with the d() helper function.

Text

The text mode is similar to var_dump - it outputs raw text with no formatting for the web. It also doesn’t display extra parsed data and only the raw values of the things you give it.

Use this output mode with the ~ modifier: ~d().

Plain

This is basically the text mode but with html escaping and color highlighting. It still only shows basic information but it does it in a way that’s easy to read in a browser.

Use this output mode with the s() helper function.

CLI

This is basically the text mode but with bash color highlighting and automated terminal width detection. This will be automatically chosen if you run your script from a terminal.

Integrations

Kint is integrated into some popular systems. Add an issue if you’ve built an integration you would like added to this list.

Twig

An official kint-php twig extension is provided in our kint-twig repository.

composer require kint-php/kint-twig
<?php

$twig->addExtension(new Kint_TwigExtension());

Kint plugins »