$prop_schema Property schema.
* @return mixed Example value.
*/
private function get_example_value( array $prop_schema ) {
if ( isset( $prop_schema['default'] ) ) {
return $prop_schema['default'];
}
if ( isset( $prop_schema['example'] ) ) {
return $prop_schema['example'];
}
$type = $prop_schema['type'] ?? 'string';
switch ( $type ) {
case 'string':
return '';
case 'number':
case 'integer':
return 0;
case 'boolean':
return false;
case 'array':
return array();
case 'object':
return new \stdClass();
default:
return null;
}
}
/**
* AJAX handler for invoking abilities.
*
* @since 0.2.0
*/
public function ajax_invoke_ability(): void {
// Verify nonce.
check_ajax_referer( 'ai_ability_explorer_invoke', 'nonce' );
// Check user capabilities.
if ( ! current_user_can( 'manage_options' ) ) {
wp_send_json_error(
array(
'message' => __( 'Insufficient permissions.', 'ai' ),
)
);
}
// Get parameters.
$ability_slug = isset( $_POST['ability'] ) ? sanitize_text_field( wp_unslash( $_POST['ability'] ) ) : '';
$input = isset( $_POST['input'] ) ? json_decode( wp_unslash( $_POST['input'] ), true ) : array(); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
if ( empty( $ability_slug ) ) {
wp_send_json_error(
array(
'message' => __( 'Ability slug is required.', 'ai' ),
)
);
}
// Get ability to validate.
$ability = Ability_Handler::get_ability( $ability_slug );
if ( ! $ability ) {
wp_send_json_error(
array(
'message' => __( 'Ability not found.', 'ai' ),
)
);
}
// Validate input.
if ( ! empty( $ability['input_schema'] ) ) {
$validation = Ability_Handler::validate_input( $ability['input_schema'], $input );
if ( ! $validation['valid'] ) {
wp_send_json_error(
array(
'message' => __( 'Input validation failed.', 'ai' ),
'errors' => $validation['errors'],
)
);
}
}
// Invoke the ability.
$result = Ability_Handler::invoke_ability( $ability_slug, $input );
if ( $result['success'] ) {
wp_send_json_success(
array(
'message' => __( 'Ability invoked successfully.', 'ai' ),
'data' => $result['data'] ?? null,
)
);
} else {
wp_send_json_error(
array(
'message' => $result['error'] ?? __( 'Unknown error occurred.', 'ai' ),
'trace' => $result['trace'] ?? null,
)
);
}
}
/**
* Add contextual help tabs to the screen.
*
* @since 0.4.0
*/
public function add_help_tabs(): void {
$screen = get_current_screen();
if ( ! $screen ) {
return;
}
$screen->add_help_tab(
array(
'id' => 'abilities-overview',
'title' => __( 'Overview', 'ai' ),
'content' =>
'' . esc_html__( 'Abilities are a standardized way for WordPress core, plugins, and themes to expose discrete units of functionality. Each ability has a name, optional input/output schemas, and can be invoked programmatically.', 'ai' ) . '
' .
'' . esc_html__( 'The Abilities Explorer lets you browse every registered ability, inspect its schemas, and test it with custom input right from the admin.', 'ai' ) . '
',
)
);
$provider_tags = array( 'strong' => array() );
$screen->add_help_tab(
array(
'id' => 'abilities-providers',
'title' => esc_html__( 'Providers', 'ai' ),
'content' =>
'' . esc_html__( 'Every ability is associated with a provider that indicates where it comes from:', 'ai' ) . '
' .
'' .
'- ' . wp_kses( __( 'Core: Built into WordPress itself.', 'ai' ), $provider_tags ) . '
' .
'- ' . wp_kses( __( 'Plugin: Registered by an active plugin.', 'ai' ), $provider_tags ) . '
' .
'- ' . wp_kses( __( 'Theme: Registered by the active theme.', 'ai' ), $provider_tags ) . '
' .
'
',
)
);
$screen->add_help_tab(
array(
'id' => 'abilities-testing',
'title' => esc_html__( 'Testing', 'ai' ),
'content' =>
'' . esc_html__( 'You can test any ability directly from this screen:', 'ai' ) . '
' .
'' .
'- ' . __( 'Click "Test" next to an ability in the list.', 'ai' ) . '
' .
'- ' . __( 'Edit the pre-filled Input Data if the ability accepts JSON parameters.', 'ai' ) . '
' .
'- ' . __( 'Use "Validate Input" to check your JSON against the schema.', 'ai' ) . '
' .
'- ' . __( 'Click "Invoke Ability" to execute it and see the result.', 'ai' ) . '
' .
'
',
)
);
$screen->set_help_sidebar(
'' . esc_html__( 'For more information:', 'ai' ) . '
' .
'' . esc_html__( 'Abilities API Documentation', 'ai' ) . '
'
);
}
}