Cheatsheet


$permissions

  • Permissions Methods
    • $permissions->find("selector")
    • $permissions->get(name|id)
    • $permissions->add("name")
    • $permissions->save($permission)
    • $permissions->delete($permission)
  • Permission Properties
    • $permission->id
    • $permission->name
    • $permission->title
  • Permission Methods
    • $permission->get($key)
    • $permission->save()
    • $permission->delete()

Sections

  • $pages
    • Built-in Methods Reference
      • $pages->find("selector")
      • $pages->count("selector")
      • $pages->get("selector")
      • $pages->get(123)
      • $pages->get("/path/to/page/")
      • $pages->save($page)
      • $pages->saveField($page, 'field')
      • $pages->trash($page)
      • $pages->delete($page)
      • $pages->delete($page, true)
      • $pages->clone($page)
      • $pages->clone($page, $parent)
      • $pages->clone($page, $parent, false)
  • $page
    • Built-in Fields Reference
      • $page->id
      • $page->name
      • $page->title
      • $page->path
      • $page->url
      • $page->httpUrl
      • $page->parent
      • $page->parentID
      • $page->parents
      • $page->rootParent
      • $page->template
      • $page->fields
      • $page->numChildren
      • $page->children
      • $page->child
      • $page->siblings
      • $page->next
      • $page->prev
      • $page->created
      • $page->modified
      • $page->createdUser
      • $page->modifiedUser
    • Built-in Methods Reference
      • $page->find($selector)
      • $page->get("field")
      • $page->get("field1|f2|f3")
      • $page->getUnformatted("field")
      • $page->setOutputFormatting(true|false)
      • $page->of(true|false)
      • $page->numChildren(bool)
      • $page->children($selector)
      • $page->child($selector)
      • $page->siblings($selector)
      • $page->parent($selector)
      • $page->parents($selector)
      • $page->parentsUntil($selector, $filter)
      • $page->closest($selector)
      • $page->next($pageArray)
      • $page->nextAll($selector, $siblings)
      • $page->nextUntil($selector, $filter, $siblings)
      • $page->prev($pageArray)
      • $page->prevAll($selector, $siblings)
      • $page->prevUntil($selector, $filter, $siblings)
      • $page->save()
      • $page->save($field)
      • $page->delete()
      • $page->is($name)
      • $page->isChanged()
      • $page->isChanged("field")
      • $page->isNew()
      • $page->isHidden()
      • $page->isTrash()
      • $page->matches("selector")
      • $page->render()
      • $page->set("field", $value)
      • $page->editable()
      • $page->editable('field')
      • $page->viewable()
      • $page->addable()
      • $page->addable($addPage)
      • $page->moveable()
      • $page->moveable($parent)
      • $page->sortable()
      • $page->deleteable()
      • $page->addStatus(Page::statusHidden)
      • $page->removeStatus(Page::statusHidden)
    • Page Status
      • Page::statusOn (1)
      • Page::statusLocked (4)
      • Page::statusSystemID (8)
      • Page::statusSystem (16)
      • Page::statusHidden (1024)
      • Page::statusUnpublished (2048)
      • Page::statusTrash (8192)
  • PageArray/WireArray
    • PageArray only
      • $a->getTotal()
      • $a->setTotal($n)
      • $a->getLimit()
      • $a->setLimit($n)
      • $a->getStart()
      • $a->setStart($n)
      • $a->getSelectors()
    • Getting Items
      • $a[$key]
      • $a->$key
      • $a->get($key)
      • $a->find("selector")
      • $a->get("selector")
      • $a->getRandom()
      • $a->findRandom($n)
      • $a->findRandomTimed($n, $seed='Ymd')
      • $a->slice($n)
      • $a->slice($n, $limit)
      • $a->shift()
      • $a->pop()
      • $a->index($n)
      • $a->eq($n)
      • $a->first()
      • $a->last()
      • $a->getNext($item)
      • $a->getPrev($item)
      • $a->getArray()
      • $a->getKeys()
      • $a->getValues()
      • $a->unique()
      • $a->implode([$delim], $key)
      • $a->explode($key)
      • $a->and($item | $items)
    • Sorting and Filtering
      • $a->shuffle()
      • $a->sort("property")
      • $a->filter("selector")
      • $a->not("selector")
      • $a->reverse()
    • Setting and modifying items
      • $a[] = $item
      • $a->add($item)
      • $a[$key] = $item
      • $a->set($key, $item)
      • $a->$key = $item
      • $a->import($items)
      • $a->prepend($item)
      • $a->append($item)
      • $a->insertBefore($item, $existingItem)
      • $a->insertAfter($item, $existingItem)
      • $a->unshift($item)
      • $a->shift()
      • $a->push($item)
      • $a->pop()
      • unset($array[$key])
      • $a->remove($key)
      • $a->remove($item)
      • $a->removeAll()
      • $a->replace($itemA, $itemB)
    • Checking for items
      • $a->count()
      • count($a)
      • $a->has($key)
      • $a->has("selector")
      • $a->has($object)
      • isset($a[$key])
      • $a->isValidItem($item)
      • $a->isValidKey($key)
      • $a->getItemKey($item)
    • Change Tracking
      • $a->setTrackChanges()
      • $a->setTrackChanges(false)
      • $a->resetTrackChanges()
      • $a->resetTrackChanges(false)
      • $a->isChanged()
      • $a->getChanges()
      • $a->getItemsAdded()
      • $a->getItemsRemoved()
    • Miscellaneous
      • $a->makeBlankItem()
      • $a->makeNew()
      • $a->data([$key], [$value])
  • Files
    • Page Files Multiple (WireArray)
      • $files->path
      • $files->url
      • $files->page
      • $files->delete($file)
      • $files->deleteAll()
    • $file Properties
      • $file->url
      • $file->httpUrl
      • $file->filename
      • $file->name
      • $file->description
      • $file->ext
      • $file->filesize
      • $file->filesizeStr
      • (string) $file
      • $file->pagefiles
      • $file->page
    • $file Methods
      • $file->rename($name)
      • $file->getNext()
      • $file->getPrev()
    • $image Properties (in addition to those in $file)
      • $image->width
      • $image->height
      • $image->original
    • $image Methods
      • $image->size($width, $height, $options)
      • $image->width($width)
      • $image->height($height)
      • $image->getVariations()
      • $image->removeVariations()
  • $templates
    • Methods
      • $templates->find("selector")
      • $templates->get("name")
      • $templates->save($template)
      • $templates->delete($template)
    • Template Properties
      • $template->id
      • $template->name
      • $template->filename
      • $template->label
      • $template->fieldgroup
      • $template->fields
      • $template->cacheTime
      • $template->childrenTemplatesID
      • $template->allowPageNum
      • $template->urlSegments
      • $template->slashUrls
      • $template->redirectLogin
      • $template->protocol
    • Template Methods
      • $template->get($property)
      • $template->set($property, $value)
      • $template->getNumPages()
      • $template->hasField(string|int|Field)
      • $template->save()
  • $fields
    • Fields Methods
      • $fields->find("selector")
      • $fields->get("name")
      • $fields->get(123)
      • $fields->get("selector")
      • $fields->save($field)
      • $fields->delete($field)
    • Field Properties
      • (string) $field
      • $field->id
      • $field->name
      • $field->label
      • $field->type
      • $field->flags
    • Field Methods
      • $field->get($key)
      • $field->set($key, $value)
      • $field->save()
      • $field->numFieldgroups()
      • $field->getFieldgroups()
      • $field->getTable()
      • $field->getInputfield($page)
  • $users
    • Users Methods
      • $users->find("selector")
      • $users->get(name|id|selector)
      • $users->add("name")
      • $users->save($user)
      • $users->delete($user)
  • $user
    • User Properties
      • $user->id
      • $user->name
      • $user->email
      • $user->pass
      • $user->roles
    • User Methods
      • $user->isGuest()
      • $user->isSuperuser()
      • $user->isLoggedin()
      • $user->get($property)
      • $user->set($property, $value)
      • $user->save()
      • $user->hasRole($role)
      • $user->addRole($role)
      • $user->removeRole($role)
      • $user->hasPermission($permission)
      • $user->hasPermission($permission, $page)
  • $roles
    • Roles Methods
      • $roles->find("selector")
      • $roles->get(name|id)
      • $roles->add("name")
      • $roles->save($role)
      • $roles->delete($role)
    • Role Properties
      • $role->id
      • $role->name
      • $role->permissions
    • Role Methods
      • $role->get($key)
      • $role->save()
      • $role->hasPermission(name|id|Permission)
      • $role->addPermission(name|id|Permission)
      • $role->removePermission(name|id|Permission)
  • $permissions
    • Permissions Methods
      • $permissions->find("selector")
      • $permissions->get(name|id)
      • $permissions->add("name")
      • $permissions->save($permission)
      • $permissions->delete($permission)
    • Permission Properties
      • $permission->id
      • $permission->name
      • $permission->title
    • Permission Methods
      • $permission->get($key)
      • $permission->save()
      • $permission->delete()
  • Selectors
    • Built-In Page Selector Properties
      • any_field=any_value
      • limit=n
      • sort=field
      • parent=id
      • parent=$page
      • parent=/path/to/page/
      • has_parent=/path/to/page/
      • has_parent=id
      • has_parent=$page
      • path=/path/to/page/
      • template=name
      • template=$template
      • start=n
      • end=n
      • include=all
      • include=hidden
      • check_access=0
      • children.count=n
      • created=timestamp
      • modified=timestamp
      • created_users_id=int
      • modified_users_id=int
    • Selector Operators
      • =
      • !=
      • <
      • >
      • <=
      • >=
      • *=
      • ~=
      • %=
      • ^=
      • $=
  • $input
    • Properties and Methods
      • $input->get
      • $input->get->name
      • $input->get["name"]
      • $input->get("name")
      • $input->post
      • $input->post->name
      • $input->post["name"]
      • $input->post("name")
      • $input->cookie
      • $input->cookie->name
      • $input->cookie["name"]
      • $input->cookie("name")
      • $input->whitelist($key, $value)
      • $input->whitelist($key)
      • $input->urlSegments
      • $input->urlSegment($n)
      • $input->urlSegment1 (2,3,..)
      • $input->pageNum
  • $sanitizer
    • Properties and Methods
      • $sanitizer->email($value)
      • $sanitizer->fieldName($value)
      • $sanitizer->name($value)
      • $sanitizer->pageName($value)
      • $sanitizer->pageName($value, true)
      • $sanitizer->selectorField($value)
      • $sanitizer->selectorValue($value)
      • $sanitizer->text($value)
      • $sanitizer->text($value, $options)
      • $sanitizer->textarea($value)
      • $sanitizer->textarea($value, $options)
      • $sanitizer->url($value)
      • $sanitizer->username($value)
      • $options
  • $session
    • Properties and Methods
      • $session->set($name, $value)
      • $session->get($name)
      • $session->$name = $value
      • $value = $session->$name
      • $session->getAll()
      • $session->remove($name)
      • $session->login($name, $pass)
      • $session->logout()
      • $session->redirect($url)
      • $session->redirect($url, false)
  • $config
    • Runtime Configuration
      • $config->ajax
      • $config->httpHost
      • $config->https
      • $config->version
      • $config->styles
      • $config->scripts
    • Urls
      • $config->urls->root
      • $config->urls->templates
      • $config->urls->admin
      • $config->urls->adminTemplates
      • $config->urls->modules
      • $config->urls->siteModules
      • $config->urls->core
      • $config->urls->assets
      • $config->urls->files
    • Paths
      • $config->paths->root
      • $config->paths->templates
      • $config->paths->adminTemplates
      • $config->paths->modules
      • $config->paths->siteModules
      • $config->paths->core
      • $config->paths->assets
      • $config->paths->files
      • $config->paths->cache
      • $config->paths->logs
      • $config->paths->sessions
  • System Configuration
    • Date and Time
      • $config->dateFormat
      • $config->timezone
    • Session
      • $config->sessionName
      • $config->sessionExpireSeconds
      • $config->sessionChallenge
      • $config->sessionFingerprint
    • File creation and identification
      • $config->chmodDir
      • $config->chmodFile
      • $config->templateExtension
      • $config->uploadUnzipCommand
      • $config->uploadBadExtensions
    • Mode
      • $config->debug
      • $config->advanced
      • $config->demo
    • MySQL Database
      • $config->dbHost
      • $config->dbName
      • $config->dbUser
      • $config->dbPass
      • $config->dbPort
      • $config->dbCharset
      • $config->dbSocket
    • Authentication
      • $config->userAuthHashType
      • $config->userAuthSalt
    • Pagination
      • $config->pageNumUrlPrefix
    • Email
      • $config->adminEmail
    • System IDs
      • $config->adminRootPageID
      • $config->trashPageID
      • $config->loginPageID
      • $config->http404PageID
      • $config->usersPageID
      • $config->rolesPageID
      • $config->permissionsPageID
      • $config->guestUserPageID
      • $config->superUserPageID
      • $config->guestUserRolePageID
      • $config->superUserRolePageID
      • $config->userTemplateID
      • $config->roleTemplateID
      • $config->permissionTemplateID
  • Bootstrap / System
    • Global Namespace Wire
      • wire('pages')->get("/about/contact/")
@ 2021 by Philipp "Soma" Urlich / @somartist | ProcessWire © 2013-2021 by Ryan Cramer | @processwire