g
Frontend | Backend | Api

Pages\Models\Api\Page

Page

Property Description Returns
parent Get the parent for the page Page
fullSlug Get the slug of the page, including the slugs of parent pages string
fullPath Get the full path including the module route name string
url Get the url or path for a page. If the page belongs to a different site, this is respected in the returned url. This method will return the url using the primary environment and the primary hostname independently of the current environment the requests is viewed through. string
duplicateUrl Builds the URL to duplicate record. Does not get the URL for the main (homepage) record. string
hateoasLinks Get the HATEOAS links for the record array
createChildUrl Get the url for creating a child record. string
editUrl Get the url for editing the record. string
moveUrl Get the url for moving the record. string
deleteUrl Get the url for deleting the record. string
publishUrl Get the url for publishing the record. string
manageUrl Get the url for managing records. string
permissionsUrl Get the url for editing the permissions of the record. string
checkPermissionsUrl Get the url for checking user permissions for this record. string
showFrontendUrl Get the url showing the record in the frontend string
sourcePage The source page this page was translated from Page
relatedPages The pages this page has been translated to Collection (Page)
seoSettings The SEO settings for the page, like title, descriptions, robots and keywords SeoSettings
customUrl Get the custom url used for the page. This will take precedence over the slugs of this page, parent page and the module. CustomUrl
name Get the name for the active revision string
originalPath Get the original path for the page without any custom urls applied string
id The ID of the page int
slug The slug for the page, i.e. the url portion identifying the page. Does not include parent slugs or the module slug. string
publishAt Date at which the page will be published or has been published DateTime
unpublishAt Date after which the page should not be shown anymore DateTime
position Position of the page in the list of pages at the same level (i.e. with the same parent) int
created Date at which the page was created DateTime
modified Date at which the page was last modified DateTime
published Date at which the page was published DateTime
site Site associated with the page Site
activeRevision The active revision for the page PageRevision
lastRevision The last revision for the page PageRevision
language The language for the page Language
children Child pages, i.e. pages located underneath this page Collection (Page)
revisions Revisions for the page Collection (PageRevision)
tags Tags associated with the page Collection (Tag)
categories Categories associated with the page Collection (Category)
adminComments Admin comments for the page, i.e. comments that should only be displayed to backend users Collection (PageAdminComment)
published Determines if the record is published bool
owner The owner of the page, possibly having different access rights to the page User
fullPosition Get the full, dot-separated full position for hierarchical records string