$page->status() method

Get or set current status

  • When manipulating status, you may prefer to use the $page->addStatus() and $page->removeStatus() methods instead.

  • Use this status() method when you want to set multiple statuses at once, or when you want to get status rather than set it.

  • You can also get or set status directly, by manipulating the $page->status property.

Example

// Get the current status as bitmask
$status = $page->status();

// Get an array of status names assigned to page
$statuses = $page->status(true);

// Set status by Page constant bitmask
$page->status(Page::statusHidden | Page::statusUnpublished);

// Set status by name
$page->status('unpublished');

// Set status by names
$page->status(['hidden', 'unpublished']); 

Usage

// basic usage
$int = $page->status();

// usage with all arguments
$int = $page->status($value = false, $status = null);

Arguments

NameType(s)Description
value (optional)bool, int

Optionally specify one of the following:

  • true (boolean): To return an array of status names (indexed by status number).
  • integer|string|array: Status number(s) or status name(s) to set the current page status (same as $page->status = $value)
status (optional)int, null

If you specified true for first argument, optionally specify status value you want to use (if not the current).

Return value

int array Page

If setting status, $this is returned. If getting status: current status or array of status names is returned.

See Also


$page methods and properties

API reference based on ProcessWire core version 3.0.148

Twitter updates

  • This week we’ve got a few new and interesting core updates in progress, though none quite ready to release just yet. So rather than releasing version 3.0.154 today, I thought we'd instead take a brief look at what’s coming over the next few weeks… More
    3 April 2020
  • ProcessWire 3.0.153 (dev) focuses on comments field updates, significant refactoring/improvements to ProcessWire’s core Template class and PagesLoader class (which is used by the pages API variable), and we introduce a useful new pages API method— More
    20 March 2020
  • ProcessWire 3.0.152 core updates— This week we have some major improvements to our core date/time Inputfield, as well as a new ability to specify your own custom classes for Page objects— More
    6 March 2020

Latest news

  • ProcessWire Weekly #307
    In the 307th issue of ProcessWire Weekly we're going to check out the latest dev branch updates, introduce some new third party modules, and more. Read on!
    Weekly.pw / 28 March 2020
  • ProcessWire updates and additions in progress
    This week we’ve got a few new and interesting core updates in progress, though none quite ready to release just yet. So rather than releasing version 3.0.154 today, I thought we'd instead take a brief look at what’s coming over the next few weeks. This post covers all the details.
    Blog / 3 April 2020
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.