Skip to content

Kirby 3.9.8

$page->documents()

Filters the Files collection by type documents

$page->documents(): Kirby\Cms\Files

Return type

Kirby\Cms\Files

Parent class

Kirby\Cms\Page

Example

<h2>Available PDFs</h2>
<ul>
  <?php foreach($page->documents()->filterBy('extension', 'pdf') as $pdf): ?>
  <li>
    <a href="<?= $pdf->url() ?>">
      <?= $pdf->filename() ?>
      (<?= $pdf->niceSize() ?>)
    </a>
  </li>
  <?php endforeach ?>
</ul>

What is a document file?

Kirby considers the following file types as document:

  • text
  • mdown
  • md
  • markdown
  • pdf
  • doc
  • docx
  • dotx
  • word
  • xl
  • xls
  • xlsx
  • xltx
  • ppt
  • pptx
  • csv
  • rtf
  • rtx