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+)
  • Optionally specify array as first or second argument for options (3.0.244+ internal use)

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.244

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer