$page->hasStatus() method

Does this page have the given status?

This method is the preferred way to check if a page has a particular status. The status may be specified as one of the Page::status constants or a string representing one of the constants, i.e. hidden, unpublished, locked, and so on.

Example

// check if page has hidden status using status name
if($page->hasStatus('hidden')) { ... }

// check if page has hidden status using status constant
if($page->hasStatus(Page::statusHidden)) { ... }

// There are also method shortcuts, i.e.
if($page->isHidden()) { ... }
if($page->isUnpublished()) { ... }
if($page->isLocked()) { ... }

Usage

$bool = $page->hasStatus($status);

Arguments

NameType(s)Description
statusint, string

Status flag constant or string representation (hidden, locked, unpublished, etc.)

Return value

bool

Returns true if page has the given status, or false if it doesn't.

See Also


$page methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #543
    In the 543rd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a couple of new third party modules — both authored by Bernhard Baumrock — and more. Read on!
    Weekly.pw / 5 October 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer