Skip to content

Kirby 5.1.3

    Search by Algolia

    svg()

    Includes an SVG file by absolute or relative file path.

    svg(Kirby\Cms\File|string $file): string|false

    Parameters

    Name Type Default
    $filerequired Kirby\Cms\Fileorstring no default value

    Return types

    stringorfalse

    Screencast

    Working with SVG

    Kirby has a few useful helpers to load and embed logos and icons in your site.

    This video is loaded from YouTube servers with your consent. Read more…

    The svg() helper has access to the entire file system of your server as it can receive an absolute file path. Be careful about passing dynamic paths to it (especially paths that can be controlled from the request), as this may cause unexpected behavior or be abused by attackers.

    With $file object

    In addition to a string parameter you can also add a file object:

    <?php if ($file = $page->files()->filterBy('extension', 'svg')->first()): ?>
<?= svg($file) ?>
<?php endif ?>