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->statusproperty.
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
| Name | Type(s) | Description |
|---|---|---|
value (optional) | bool, int | Optionally specify one of the following:
|
status (optional) | int, null | If you specified |
Return value
int array PageIf setting status, $this is returned. If getting status: current status or array of status names is returned.
See Also
API reference based on ProcessWire core version 3.0.236