Skip to content

The CMS
Docs
- Guide
- Cookbook
- Reference
- Screencasts
- Glossary
Resources
- Newsletter
- Plugins
- Roadmap
- Releases
Community

Try
Buy

View all results ›

Text
- KirbyText
- Markdown
Templates
- Field methods
- Helpers
Panel
- Blueprints
- Presets
- Fields
- Sections
- Blocks
- Icons
- Samples
Objects
- $kirby
- $site
- $page
- $pages
- $file
- $files
- $user
- $users
- $blocks
- $layouts
- $language
- $languages
- $pagination
- $request
- $session
- All classes
- Aliases
Router
- Patterns
- Response types
System
- Options
- Urls
- Roots
- Validators
Plugins
API
- Authentication
- Languages
- Pages
- Roles
- Site
- System
- Translations
- Users
Tools
- A
- Cookie
- Data
- Dir
- Escape
- F
- Header
- Html
- I18n
- Mime
- Query
- Server
- Str
- Tpl
- Url
- V
- Xml

new PagePicker()

Creates a new Picker instance
$pagepicker->defaults()

Extends the basic defaults
$pagepicker->items()

Search all pages for the picker
$pagepicker->itemsForParent()

Search for pages by parent
$pagepicker->itemsForQuery()

Search for pages by query string
$pagepicker->itemsToArray()

Converts all given items to an associative array that is already optimized for the panel picker component.
$pagepicker->model()

Returns the parent model object that is currently selected in the page picker.
$pagepicker->modelForQuery()

Returns a model object for the given query, depending on the parent and subpages options.
$pagepicker->modelToArray()

Returns basic information about the parent model that is currently selected in the page picker.
$pagepicker->paginate()

Apply pagination to the collection of items according to the options.
$pagepicker->paginationToArray()

Return the most relevant pagination info as array
$pagepicker->parent()

Returns the parent model.
$pagepicker->search()

Search through the collection of items if not deactivate in the options
$pagepicker->start()

Calculates the top-most model (page or site) that can be accessed when navigating through pages.
$pagepicker->toArray()

Returns an associative array with all information for the picker.

$pagepicker->defaults()

Extends the basic defaults

kirby/src/Cms/PagePicker.php#L41

$pagepicker->defaults(): array

Return type

array

Parent class

Kirby\Cms\PagePicker

Did you find an error? Help us improve our docs and edit this page on Github. Make sure to check out our styleguide →