Skip to content

Drafts ​

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

View source

Public Methods ​

MethodDescription
__construct()
apply()
create()
delete()
list()

__construct() ​

View source

Arguments ​

  • $drafts
  • $elementQueries
  • $elementQueryCriteria
  • $elementSerializer
  • $actor

apply() ​

View source

Arguments ​

  • $type
  • $id
  • $uid
  • $siteId

Returns ​

array{element: array<string,mixed>}

create() ​

View source

Arguments ​

  • $type
  • $id
  • $uid
  • $siteId
  • $name
  • $notes
  • $provisional

Returns ​

array{draft: array<string,mixed>}

delete() ​

View source

Arguments ​

  • $type
  • $id
  • $uid
  • $siteId

Returns ​

array{deleted: true}

list() ​

View source

Arguments ​

  • $type
  • $id
  • $uid
  • $siteId
  • $criteria (array<string,mixed>)
  • $fields (list<string>, null)
  • $unpublished

Returns ​

array{count: int, limit: int, offset: int, nextOffset: int|null, drafts: list<array<string,mixed>>}

Constants ​

ConstantDescription
CriteriaSchema