'object', 'properties' => array( 'content' => array( 'type' => 'string', 'sanitize_callback' => 'sanitize_text_field', 'description' => esc_html__( 'Content to generate title suggestions for.', 'ai' ), ), 'context' => array( 'type' => 'string', 'sanitize_callback' => 'sanitize_text_field', 'description' => esc_html__( 'Additional context to use when generating title suggestions. This can either be a string of additional context or can be a post ID that will then be used to get context from that post (if it exists). If no content is provided but a valid post ID is used here, the content from that post will be used.', 'ai' ), ), ), ); } /** * {@inheritDoc} * * @since 0.1.0 */ protected function output_schema(): array { return array( 'type' => 'object', 'properties' => array( 'title' => array( 'type' => 'string', 'description' => esc_html__( 'Generated title suggestion.', 'ai' ), ), ), ); } /** * {@inheritDoc} * * @since 0.1.0 */ protected function execute_callback( $input ) { // Default arguments. $args = wp_parse_args( $input, array( 'content' => null, 'context' => null, ), ); // If a post ID is provided, ensure the post exists before using its' content. if ( is_numeric( $args['context'] ) ) { $post = get_post( (int) $args['context'] ); if ( ! $post ) { return new WP_Error( 'post_not_found', /* translators: %d: Post ID. */ sprintf( esc_html__( 'Post with ID %d not found.', 'ai' ), absint( $args['context'] ) ) ); } // Get the post context. $context = get_post_context( $post->ID ); $content = $context['content'] ?? ''; unset( $context['content'] ); // Default to the passed in content if it exists. if ( $args['content'] ) { $content = normalize_content( $args['content'] ); } } else { $content = normalize_content( $args['content'] ?? '' ); $context = $args['context'] ?? ''; } // If we have no content, return an error. if ( empty( $content ) ) { return new WP_Error( 'content_not_provided', esc_html__( 'Content is required to generate title suggestions.', 'ai' ) ); } // Generate the title. $result = $this->generate_title( $content, $context ); // If we have an error, return it. if ( is_wp_error( $result ) ) { return $result; } // If we have no result, return an error. if ( empty( $result ) ) { return new WP_Error( 'no_results', esc_html__( 'No title suggestion was generated.', 'ai' ) ); } // Return the title in the format the Ability expects. return array( 'title' => sanitize_text_field( trim( $result, ' "\'' ) ), ); } /** * {@inheritDoc} * * @since 0.1.0 */ protected function permission_callback( $args ) { $post_id = isset( $args['context'] ) && is_numeric( $args['context'] ) ? absint( $args['context'] ) : null; if ( $post_id ) { $post = get_post( $post_id ); // Ensure the post exists. if ( ! $post ) { return new WP_Error( 'post_not_found', /* translators: %d: Post ID. */ sprintf( esc_html__( 'Post with ID %d not found.', 'ai' ), absint( $post_id ) ) ); } // Ensure the user has permission to edit this particular post. if ( ! current_user_can( 'edit_post', $post_id ) ) { return new WP_Error( 'insufficient_capabilities', esc_html__( 'You do not have permission to generate titles for this post.', 'ai' ) ); } // Ensure the post type is allowed in REST endpoints. $post_type = get_post_type( $post_id ); if ( ! $post_type ) { return false; } $post_type_obj = get_post_type_object( $post_type ); if ( ! $post_type_obj || empty( $post_type_obj->show_in_rest ) ) { return false; } } elseif ( ! current_user_can( 'edit_posts' ) ) { // Ensure the user has permission to edit posts in general. return new WP_Error( 'insufficient_capabilities', esc_html__( 'You do not have permission to generate titles.', 'ai' ) ); } return true; } /** * {@inheritDoc} * * @since 0.1.0 */ protected function meta(): array { return array( 'show_in_rest' => true, ); } /** * Generates a title suggestion from the given content. * * @since 0.1.0 * * @param string $content The content to generate a title suggestion for. * @param string|array $context Additional context to use. * @return string|\WP_Error The generated title, or a WP_Error if there was an error. */ protected function generate_title( string $content, $context ) { // Convert the context to a string if it's an array. if ( is_array( $context ) ) { $context = implode( "\n", array_map( static function ( $key, $value ) { return sprintf( '%s: %s', ucwords( str_replace( '_', ' ', $key ) ), $value ); }, array_keys( $context ), $context ) ); } $content = '' . $content . ''; // If we have additional context, add it to the content. if ( $context ) { $content .= "\n\n" . $context . ''; } $content = $this->filter_prompt( $content, $context ); $prompt_builder = $this->get_prompt_builder( $content ); if ( is_wp_error( $prompt_builder ) ) { return $prompt_builder; } // Generate the title using the AI client. return $prompt_builder->generate_text(); } /** * Gets a prompt builder for generating titles. * * @since 0.7.0 * * @param string $prompt The prompt to generate titles from. * @return \WP_AI_Client_Prompt_Builder|\WP_Error The prompt builder, or a WP_Error on failure. */ private function get_prompt_builder( string $prompt ) { $prompt_builder = wp_ai_client_prompt( $prompt ) ->using_system_instruction( $this->get_system_instruction() ); $prompt_builder = $this->filter_prompt_builder( $prompt_builder, Title_Generation_Experiment::class, array(), $prompt ); return $this->ensure_text_generation_supported( $prompt_builder, esc_html__( 'Title generation failed. Please ensure you have a connected provider that supports text generation.', 'ai' ) ); } }