GravityKit\GravityCalendar\Abilities\Discovery\GetCalendarSettingsSchema
gc_calendar_settings_schema: each setting with its kind, default and valid values, and, for a
form, which of its fields each field setting may name.
Since: TBD
Source: includes/abilities/Discovery/GetCalendarSettingsSchema.php:23
Details
- Kind:
class - Namespace:
GravityKit\GravityCalendar\Abilities\Discovery - Extends:
Ability
Methods
| Method | Description |
|---|---|
name() | The ability's registered name. |
label() | The short title an AI client shows for gc_calendar_settings_schema. |
description() | What gc_calendar_settings_schema tells an AI client it does and when to call it. |
category() | The category gc_calendar_settings_schema is listed under. |
input_schema() | The JSON schema of the input gc_calendar_settings_schema accepts. |
output_schema() | The JSON schema of what gc_calendar_settings_schema returns. |
annotations() | Hints that tell an AI client whether gc_calendar_settings_schema reads, writes or deletes. |
permission() | Whether the current user may call gc_calendar_settings_schema. |
execute() | Runs gc_calendar_settings_schema. |
Method Reference
name()
public static function name(): string
The ability's registered name.
Returns
string—gk-gravitycalendar/calendar-settings-schema(MCPgc_calendar_settings_schema).
Since: TBD
Source: includes/abilities/Discovery/GetCalendarSettingsSchema.php:46
label()
public static function label(): string
The short title an AI client shows for gc_calendar_settings_schema.
Returns
string
Since: TBD
Source: includes/abilities/Discovery/GetCalendarSettingsSchema.php:57
description()
public static function description(): string
What gc_calendar_settings_schema tells an AI client it does and when to call it.
Returns
string
Since: TBD
Source: includes/abilities/Discovery/GetCalendarSettingsSchema.php:68
category()
public static function category(): string
The category gc_calendar_settings_schema is listed under.
Returns
string
Since: TBD
Source: includes/abilities/Discovery/GetCalendarSettingsSchema.php:88
input_schema()
public static function input_schema(): array
The JSON schema of the input gc_calendar_settings_schema accepts.
Returns
array
Since: TBD
Source: includes/abilities/Discovery/GetCalendarSettingsSchema.php:99
output_schema()
public static function output_schema(): array
The JSON schema of what gc_calendar_settings_schema returns.
Returns
array
Since: TBD
Source: includes/abilities/Discovery/GetCalendarSettingsSchema.php:119
annotations()
public static function annotations(): array
Hints that tell an AI client whether gc_calendar_settings_schema reads, writes or deletes.
Returns
array{readonly:bool,— destructive:bool, idempotent:bool}
Since: TBD
Source: includes/abilities/Discovery/GetCalendarSettingsSchema.php:186
permission()
public static function permission( array $input )
Whether the current user may call gc_calendar_settings_schema.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$input | array | Input as received. |
Returns
true|\WP_Error
Since: TBD
Source: includes/abilities/Discovery/GetCalendarSettingsSchema.php:199
execute()
public static function execute( array $input )
Runs gc_calendar_settings_schema.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$input | array | Input, validated against the input schema. |
Returns
array|\WP_Error
Since: TBD
Source: includes/abilities/Discovery/GetCalendarSettingsSchema.php:212