PagePermissions::viewable() method

Hook for Page::viewable() or Page::viewable($user) method

Is the page viewable by the current user? (or specified user)

  • Optionally specify User object to hook as first argument to check for a specific User.
  • Optionally specify a field name (or Field object) as first argument to check for specific field.
  • Optionally specify Language object or language name as first argument to check if viewable in that language (requires LanguageSupportPageNames module).
  • Optionally specify boolean false as first or second argument to bypass template filename check.
  • Optionally specify a Pagefile object or file basename to check if file is viewable. (3.0.166+)

Returns boolean true or false. If given a Pagefile or file basename, it can also return null if the Page itself is viewable but the file did not map to something we recognize as access controlled, like a file basename that isn’t present in any file fields on the page.

Usage

$pagePermissions->viewable(HookEvent $event);

Arguments

NameType(s)Description
eventHookEvent

PagePermissions methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #518
    The 518th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 13 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull