Skip to content

Sites ​

Type
Class
Namespace
craft\mcp\capabilities
Inherits
craft\mcp\capabilities\Sites
Since
5.12.0

View source

Public Methods ​

MethodDescription
__construct()
create()
delete()
get()
list()
resource()
resourceByIdentifier()
update()

__construct() ​

View source

Arguments ​

  • $sites

create() ​

View source

Arguments ​

  • $attributes (array<string,mixed>) – Native Craft site attributes.

Returns ​

array{site: array<string,mixed>}

delete() ​

View source

Arguments ​

  • $id
  • $uid
  • $handle
  • $transferContentTo (integer, null) – Site ID to transfer content to.

Returns ​

array{deleted: true}

get() ​

View source

Arguments ​

  • $id
  • $uid
  • $handle

Returns ​

array{site: array<string,mixed>}

list() ​

View source

Returns ​

array{count: int, sites: list<array<string,mixed>>}

resource() ​

View source

Returns ​

array{count: int, sites: list<array<string,mixed>>}

resourceByIdentifier() ​

View source

Arguments ​

  • $site

Returns ​

array{site: array<string,mixed>}

update() ​

View source

Arguments ​

  • $id
  • $uid
  • $handle
  • $attributes (array<string,mixed>) – Native Craft site attributes to update.

Returns ​

array{site: array<string,mixed>}

Constants ​

ConstantDescription
AttributesSchema