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

Twitter updates

  • ProcessWire 3.0.180 core updates– More
    18 June 2021
  • Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we’ll take a closer look at in this post— More
    11 June 2021
  • ProcessWire 3.0.179 adds great new admin theme customization tools that put you in full control over the Uikit admin styles— More
    28 May 2021

Latest news

  • ProcessWire Weekly #371
    In the 371st issue of ProcessWire Weekly we'll check out ProcessWire 3.0.180, introduce a new module called Flowti Page Serializer, highlight some recent forum posts and tutorials, and more. Read on!
    Weekly.pw / 19 June 2021
  • ProcessWire FormBuilder v50 updates
    Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we'll take a closer look at in this post.
    Blog / 11 June 2021
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK