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

Twitter updates

  • This week we focus in on a new and unique Inputfield module added to the core that enables a lot of useful new input capabilities for tags, sortable multiple selection and custom user input— More
    30 April 2021
  • With more than 25 commits, ProcessWire 3.0.176 resolves lots of minor issues, adds support for multiple randomly selected read-only database connections, upgrades the tag features in the Template editor, adds a useful new Tags Inputfield, and more… More
    23 April 2021
  • This week ProcessWire (3.0.175) gained the ability to maintain separate read-only and read-write database connections to optimize scalability, cost and performance. The post covers why this can be so valuable and how to configure it in ProcessWire— More
    2 April 2021

Latest news

  • ProcessWire Weekly #365
    In the 365th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module called FieldtypeOembed, and more. Read on!
    Weekly.pw / 9 May 2021
  • ProcessWire 3.0.177 core updates
    This week we focus in on a new and unique Inputfield module added to the core that enables a lot of useful new input capabilities for tags, sortable multiple selection and custom user input.
    Blog / 30 April 2021
  • Subscribe to weekly ProcessWire news

“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