$pages

The $pages object refers to a collection of pages. The pages in this collection can have the same or different parents, they can actually exist as subfolders in the content folder or be virtual pages created from a database, an Excel sheet, any API or any other source.

Full class name: Kirby\Cms\Pages

Alias: Pages

kirby/src/Cms/Pages.php#L23

You can extend this set of methods with custom pages methods.

How to get a `$pages` object

The $pages variable is available by default in templates and snippets and refers to a collection of all first level pages. In addition to that, you can define a $pages object in various ways:

Children of a page

$pages = $page->children();

All pages of the site

$pages = $site->index();

A custom combination of pages

// find specific pages in the site
$pages = $site->find('blog', 'projects', 'contact');

// find specific subpages
$pages = $page->find('article-a', 'article-b');

Examples

With the $pages object in place, we can start using the methods of this class to do many different things:

Filter the collection by any criterium

$articles = $pages->filterBy('date', '>', time());

Get only listed pages

$articles = $pages->listed()

Get all files of all the pages in the collection

$files = $pages->files();

Get the first/last page

$firstPage = $pages->first();
$lastPage = $pages->last();

Sort pages

$sorted = $pages->sortBy(function ($page) {
  return $page->date()->toDate();
}, 'desc');

$pages->add()

$pages->append()

$pages->audio()

$pages->callMethod()

$pages->children()

$pages->chunk()

$pages->clone()

$pages->code()

$pages->count()

$pages->current()

$pages->data()

$pages->documents()

$pages->drafts()

$pages->empty()

$pages->extend()

$pages->files()

$pages->filter()

$pages->filterBy()

$pages->find()

$pages->findBy()

$pages->findByKey()

$pages->findOpen()

$pages->first()

$pages->flip()

$pages->get()

$pages->getAttribute()

$pages->getIterator()

$pages->group()

$pages->groupBy()

$pages->has()

$pages->hasMethod()

$pages->images()

$pages->index()

$pages->indexOf()

$pages->intersection()

$pages->intersects()

$pages->isEmpty()

$pages->isEven()

$pages->isNotEmpty()

$pages->isOdd()

$pages->key()

$pages->keyOf()

$pages->keys()

$pages->last()

$pages->limit()

$pages->listed()

$pages->map()

$pages->merge()

$pages->next()

$pages->not()

$pages->notTemplate()

$pages->nth()

$pages->nums()

$pages->offset()

$pages->paginate()

$pages->pagination()

$pages->parent()

$pages->pluck()

$pages->prepend()

$pages->prev()

$pages->published()

$pages->query()

$pages->random()

$pages->remove()

$pages->rewind()

$pages->search()

$pages->set()

$pages->shuffle()

$pages->slice()

$pages->sort()

$pages->sortBy()

$pages->template()

$pages->toArray()

$pages->toJson()

$pages->toString()

$pages->unlisted()

$pages->valid()

$pages->values()

$pages->videos()

$pages->when()