Skip to main content

GravityKit\GravityCalendar\Abilities\Calendars\UpdateCalendar

gc_calendar_update: changes only the settings sent, saved the way the settings screen saves.

Since: TBD

Source: includes/abilities/Calendars/UpdateCalendar.php:24

Details​

  • Kind: class
  • Namespace: GravityKit\GravityCalendar\Abilities\Calendars
  • Extends: Ability

Methods​

MethodDescription
name()The ability's registered name.
label()The short title an AI client shows for gc_calendar_update.
description()What gc_calendar_update tells an AI client it does and when to call it.
category()The category gc_calendar_update is listed under.
input_schema()The settings input is exactly gc_calendar_get's settings output, so a read can be sent back.
output_schema()gc_calendar_get's output, plus changed.
annotations()Sending the same settings twice leaves the same calendar.
permission()Whether the current user may call gc_calendar_update.
execute()Runs gc_calendar_update.

Method Reference​

name()​

public static function name(): string

The ability's registered name.

Returns​

  • string — gk-gravitycalendar/calendar-update (MCP gc_calendar_update).

Since: TBD

Source: includes/abilities/Calendars/UpdateCalendar.php:33

label()​

public static function label(): string

The short title an AI client shows for gc_calendar_update.

Returns​

  • string

Since: TBD

Source: includes/abilities/Calendars/UpdateCalendar.php:44

description()​

public static function description(): string

What gc_calendar_update tells an AI client it does and when to call it.

Returns​

  • string

Since: TBD

Source: includes/abilities/Calendars/UpdateCalendar.php:55

category()​

public static function category(): string

The category gc_calendar_update is listed under.

Returns​

  • string

Since: TBD

Source: includes/abilities/Calendars/UpdateCalendar.php:80

input_schema()​

public static function input_schema(): array

The settings input is exactly gc_calendar_get's settings output, so a read can be sent back.

Returns​

  • array

Since: TBD

Source: includes/abilities/Calendars/UpdateCalendar.php:91

output_schema()​

public static function output_schema(): array

gc_calendar_get's output, plus changed.

Returns​

  • array

Since: TBD

Source: includes/abilities/Calendars/UpdateCalendar.php:112

annotations()​

public static function annotations(): array

Sending the same settings twice leaves the same calendar.

Returns​

  • array{readonly:bool, — destructive:bool, idempotent:bool}

Since: TBD

Source: includes/abilities/Calendars/UpdateCalendar.php:132

permission()​

public static function permission( array $input )

Whether the current user may call gc_calendar_update.

Parameters​

NameTypeDefaultDescription
$inputarrayInput as received.

Returns​

  • true | \WP_Error

Since: TBD

Source: includes/abilities/Calendars/UpdateCalendar.php:145

execute()​

public static function execute( array $input )

Runs gc_calendar_update.

Parameters​

NameTypeDefaultDescription
$inputarrayInput, validated against the input schema.

Returns​

  • array | \WP_Error

Since: TBD

Source: includes/abilities/Calendars/UpdateCalendar.php:158