Sites

Type: Class
Namespace: craft\services
Inherits: craft\services\Sites » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable
Since: 3.0.0

Sites service.

An instance of the service is available via Craft::$app->getSites().

Public Properties

Property	Description
allGroups	craft\models\SiteGroup[] – The site groups
allSiteIds	integer[] – all of the site IDs
allSites	craft\models\Site[] – all of the sites
behaviors	yii\base\Behavior – List of behaviors attached to this component.
currentSite	craft\models\Site, null – the current site
editableSiteIds	integer[] – all of the site IDs that are editable by the current user
editableSites	craft\models\Site[] – All the editable sites
hasCurrentSite	boolean
maxSites	integer – The maximum number of sites that can be created.
primarySite	craft\models\Site – the primary site
remainingSites	integer
totalEditableSites	integer – the total number of sites that are editable by the current user
totalSites	integer – the total number of sites

`allGroups`

Type: craft\models\SiteGroup[]
Default value: null
Access: Read-only

The site groups

View source

`allSiteIds`

Type: integer[]
Default value: null

all of the site IDs

View source

`allSites`

Type: craft\models\Site[]
Default value: null

all of the sites

View source

`currentSite`

Type: craft\models\Site, null
Default value: null

the current site

View source

`editableSiteIds`

Type: integer[]
Default value: null

all of the site IDs that are editable by the current user

View source

`editableSites`

Type: craft\models\Site[]
Default value: null
Access: Read-only

All the editable sites

View source

`hasCurrentSite`

Type: boolean
Default value: null
Access: Read-only

View source

`maxSites`

Type: integer
Default value: 100
Since: 5.0.0

The maximum number of sites that can be created.

View source

`primarySite`

Type: craft\models\Site
Default value: null

the primary site

View source

`remainingSites`

Type: integer
Default value: null
Access: Read-only
Since: 5.0.0

View source

`totalEditableSites`

Type: integer
Default value: null

the total number of sites that are editable by the current user

View source

`totalSites`

Type: integer
Default value: null

the total number of sites

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()	Constructor.
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__serialize()	Serializer
__set()	Sets the value of a component property.
__unset()	Sets a component property to be null.
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
behaviors()	Returns a list of behaviors that this component should behave as.
canGetProperty()	Returns a value indicating whether a property can be read.
canSetProperty()	Returns a value indicating whether a property can be set.
className()	Returns the fully qualified name of this class.
deleteGroup()	Deletes a site group.
deleteGroupById()	Deletes a site group by its ID.
deleteSite()	Deletes a site.
deleteSiteById()	Deletes a site by its ID.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
getAllGroups()	Returns all site groups.
getAllSiteIds()	Returns all of the site IDs.
getAllSites()	Returns all sites.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getCurrentSite()	Returns the current site.
getEditableSiteIds()	Returns all of the site IDs that are editable by the current user.
getEditableSites()	Returns all editable sites.
getEditableSitesByGroupId()	Returns editable sites by a group ID.
getGroupById()	Returns a site group by its ID.
getGroupByUid()	Returns a site group by its UID.
getHasCurrentSite()	Returns whether the current site has been set yet.
getPrimarySite()	Returns the primary site. The primary site is whatever is listed first in Settings > Sites in the control panel.
getRemainingSites()	Returns the number of sites that can be created, based on maxSites.
getSiteByHandle()	Returns a site by its handle.
getSiteById()	Returns a site by its ID.
getSiteByUid()	Returns a site by it's UID.
getSitesByGroupId()	Returns sites by a group ID.
getSitesByLanguage()	Returns sites by their language.
getTotalEditableSites()	Gets the total number of sites that are editable by the current user.
getTotalSites()	Gets the total number of sites.
handleChangedGroup()	Handle site group change
handleChangedSite()	Handle site changes.
handleDeletedGroup()	Handle site group getting deleted.
handleDeletedSite()	Handle a deleted Site.
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.
hasMethod()	Returns a value indicating whether a method is defined.
hasProperty()	Returns a value indicating whether a property is defined for this component.
init()	Initializes the object.
off()	Detaches an existing event handler from this component.
on()	Attaches an event handler to an event.
refreshSites()	Refresh the status of all sites based on the DB data.
reorderSites()	Reorders sites.
restoreSiteById()	Restores a site by its ID.
saveGroup()	Saves a site group.
saveSite()	Saves a site.
setCurrentSite()	Sets the current site.
trigger()	Triggers an event.

`__serialize()`

Since: 3.5.14

Serializer

View source

`deleteGroup()`

Deletes a site group.

View source

Arguments

$group (craft\models\SiteGroup) – The site group

Returns

boolean – Whether the site group was deleted successfully

`deleteGroupById()`

Deletes a site group by its ID.

View source

Arguments

$groupId (integer) – The site group’s ID

Returns

boolean – Whether the site group was deleted successfully

`deleteSite()`

Deletes a site.

View source

Arguments

$site (craft\models\Site) – The site to be deleted
$transferContentTo (integer, null) – The site ID that should take over the deleted site’s contents

Returns

boolean – Whether the site was deleted successfully

Throws

yii\base\Exception
if $site is the primary site
Throwable
if reasons

`deleteSiteById()`

Deletes a site by its ID.

View source

Arguments

$siteId (integer) – The site ID to be deleted
$transferContentTo (integer, null) – The site ID that should take over the deleted site’s contents

Returns

boolean – Whether the site was deleted successfully

Throws

Throwable
if reasons

`getAllGroups()`

Returns all site groups.

View source

Returns

craft\models\SiteGroup[] – The site groups

`getAllSiteIds()`

Returns all of the site IDs.

View source

Arguments

$withDisabled (boolean, null)

Returns

integer[] – All the sites’ IDs

`getAllSites()`

Returns all sites.

View source

Arguments

$withDisabled (boolean, null)

Returns

craft\models\Site[] – All the sites

`getCurrentSite()`

Returns the current site.

NOTE

This will always return the primary site for control panel requests. To fetch the site the control panel is currently working with, based on the site query string param, use craft\helpers\Cp::requestedSite().

View source