$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.125

Twitter updates

  • New post: This week we take a look at what’s in ProcessWire 3.0.126 which focuses largely on resolving issue reports, but also includes a handy new Page if() method— More
    15 February 2019
  • New post: ProcessWire 3.0.125 has several useful new Sanitizer methods & options, plus new ways to access them directly from the Input API variable. This makes handling user input even easier than before. Plus updates to our i18n functions & API docs— More
    25 January 2019
  • New post: In this week’s post, we’ll take a look a look at the new website and focus on some parts of it and how they were built. Then we’ll dive into the latest version of ProcessWire on the dev branch, version 3.0.124— More
    11 January 2019

Latest news

  • ProcessWire Weekly #249
    In the 249th issue of ProcessWire Weekly we're going to walk you through the latest core updates (ProcessWire 3.0.126), introduce a new third party module called Page Access Releasetime, and pick a new site of the week. Read on!
    Weekly.pw / 16 February 2019
  • ProcessWire 3.0.126 core updates
    This week we take a look at what’s in ProcessWire 3.0.126 which focuses largely on resolving issue reports, but also includes a handy new $page->if() method. 
    Blog / 15 February 2019
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer