Add AI settings section #1691
Add AI settings section #1691
Conversation
Introduces a new 'AI Settings' section in the settings options, allowing selection of AI provider, model, and API key. Adds dynamic filtering of AI models in the admin UI based on the selected provider. Removes unnecessary debug console logs from admin posting scripts and makes a minor formatting fix in the frontend render form.
WalkthroughIntroduces an AI Settings section to admin settings with provider, model, and API key fields; adds client-side filtering of AI models based on selected provider; removes debug logs in admin posting scripts; and applies a minor whitespace formatting change in frontend form rendering. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Assessment against linked issues
Assessment against linked issues: Out-of-scope changes
Poem
✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
assets/js/wpuf-admin.js (2)
239-257: Avoid filtering by provider via display text; add a provider attribute.Relying on option text containing “(OpenAI)/(Anthropic)/...” is brittle (customizations, filters, localization). Prefer a data attribute (e.g., data-provider) or a value prefix to classify options.
Example minimal client-side indexing (no PHP changes), then filter on the indexed attribute:
- // Filter and add relevant options based on provider - aiModelSelect.data('all-options').each(function() { + // Index provider once from trailing "(Provider)" if not already set + if (!aiModelSelect.data('provider-indexed')) { + aiModelSelect.data('all-options').each(function () { + var $opt = $(this); + var m = $opt.text().match(/\(([^)]+)\)\s*$/); + if (m) { $opt.attr('data-provider', m[1].toLowerCase()); } + }); + aiModelSelect.data('provider-indexed', true); + } + // Filter and add relevant options based on provider + aiModelSelect.data('all-options').each(function() { var option = $(this); - var optionText = option.text(); - var optionValue = option.val(); + var optionValue = option.val(); // Skip empty value option if (!optionValue) return; - // Check if option belongs to selected provider - if (selectedProvider === 'openai' && optionText.includes('(OpenAI)')) { - aiModelSelect.append(option.clone()); - } else if (selectedProvider === 'anthropic' && optionText.includes('(Anthropic)')) { - aiModelSelect.append(option.clone()); - } else if (selectedProvider === 'google' && optionText.includes('(Google)')) { - aiModelSelect.append(option.clone()); - } else if (selectedProvider === 'others' && optionText.includes('(Others)')) { - aiModelSelect.append(option.clone()); - } + if (option.attr('data-provider') === selectedProvider) { + aiModelSelect.append(option.clone()); + } });
263-276: Guard defaults and prefer localized placeholder text.
- Ensure the default model exists before selecting; otherwise pick the first real option.
- “Select AI Model” should be localized (use wp_localize_script or wp.i18n).
Apply:
- aiModelSelect.append('<option value="">Select AI Model</option>'); + aiModelSelect.append('<option value="">' + (window.wpuf_admin_i18n?.select_ai_model || 'Select AI Model') + '</option>'); @@ - } else if (defaultModels[selectedProvider]) { - // Fall back to default model for the provider - aiModelSelect.val(defaultModels[selectedProvider]); + } else if (defaultModels[selectedProvider] && aiModelSelect.find('option[value="' + defaultModels[selectedProvider] + '"]').length) { + aiModelSelect.val(defaultModels[selectedProvider]); + } else { + // Fallback: select first available provider-specific model if present + var $first = aiModelSelect.find('option[value!=""]').first(); + if ($first.length) { aiModelSelect.val($first.val()); } }(Expose wpuf_admin_i18n.select_ai_model via wp_localize_script where this file is enqueued.)
includes/functions/settings-options.php (2)
640-707: Use password field for API key and consider stronger storage/handling.Displaying/storing API keys in plain text is risky in shared-admin contexts. Use a password-type field to mask input, and (optionally) avoid echoing the saved value back verbatim.
- [ - 'name' => 'ai_api_key', - 'label' => __( 'API Key', 'wp-user-frontend' ), - 'desc' => __( 'Enter your AI service API key. Keep this secure and never share it publicly.', 'wp-user-frontend' ), - 'type' => 'text', - 'default' => '', - ], + [ + 'name' => 'ai_api_key', + 'label' => __( 'API Key', 'wp-user-frontend' ), + 'desc' => __( 'Enter your AI service API key. Keep this secure and never share it publicly.', 'wp-user-frontend' ), + 'type' => 'password', + 'default' => '', + ],If feasible, add a sanitize callback to trim and store, and render a placeholder (e.g., ••••) when a key exists.
656-704: Facilitate robust provider filtering from JS.Since the admin JS needs to filter models by provider, expose a machine-readable provider key per option (e.g., value prefix
openai:gpt-4oor data-provider attribute rendered by the settings API). This avoids parsing human labels.If altering values is acceptable:
- 'gpt-4o' => 'GPT-4o (OpenAI)', + 'openai:gpt-4o' => 'GPT-4o (OpenAI)',Then update JS to split on
:and match provider reliably.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
assets/js/wpuf-admin.js(1 hunks)includes/Admin/Posting.php(1 hunks)includes/class-frontend-render-form.php(1 hunks)includes/functions/settings-options.php(2 hunks)
🔇 Additional comments (4)
includes/Admin/Posting.php (2)
688-695: Good removal of noisy console log.Swapping the console.log for a comment keeps admin console clean while preserving the initializer guard.
688-695: Confirm gmap “required” fix is actually in the PR.The PR description says it fixes issue #1086 (“gmap required” with multiple maps), but this file only removes a log. Please point to the commit/file that implements the validation fix, or add it to this PR.
includes/functions/settings-options.php (2)
52-56: AI Settings section inclusion looks good.Section id, title, and icon are consistent with existing sections.
656-704: Verify model identifiers and future-proof the list.Some slugs look hypothetical or umbrella (e.g., gpt-5, gpt-4.5, embeddings, tts). Please confirm identifiers you intend to support, and consider sourcing this list via a provider API or filter-only to avoid drift.
Would you like a small adapter that maps providers to models via a filterable registry, so the UI auto-populates from a single source?
| <input type="checkbox" class="wpuf_is_featured" name="is_featured_item" value="1" <?php echo $is_featured ? 'checked' : ''; ?> > | ||
| <span class="wpuf-items-table-containermessage-box" id="remaining-feature-item"> <?php echo sprintf( | ||
| <span class="wpuf-items-table-containermessage-box" id="remaining-feature-item"> <?php echo sprintf( | ||
| // translators: %1$s is Post type and %2$s is total feature item | ||
| wp_kses_post(__( 'Mark the %1$s as featured (remaining %2$d)', 'wp-user-frontend' ), esc_html ($this->form_settings['post_type'] ), esc_html( $user_sub['total_feature_item'] ) )); ?></span> | ||
| </label> |
There was a problem hiding this comment.
Fix fatal sprintf/escaping misuse and broken selector for counter.
- wp_kses_post() is called with extra args (PHP ArgumentCountError). Also, sprintf args are passed to wp_kses_post instead of sprintf.
- The counter selector in JS looks for
.wpuf-message-box, but the span hasclass="wpuf-items-table-containermessage-box"→ the live counter won’t update.
Apply this diff to fix both issues and harden types:
- <span class="wpuf-items-table-containermessage-box" id="remaining-feature-item"> <?php echo sprintf(
- // translators: %1$s is Post type and %2$s is total feature item
- wp_kses_post(__( 'Mark the %1$s as featured (remaining %2$d)', 'wp-user-frontend' ), esc_html ($this->form_settings['post_type'] ), esc_html( $user_sub['total_feature_item'] ) )); ?></span>
+ <span class="wpuf-message-box" id="remaining-feature-item">
+ <?php
+ // translators: %1$s is Post type and %2$d is total feature item
+ printf(
+ esc_html__( 'Mark the %1$s as featured (remaining %2$d)', 'wp-user-frontend' ),
+ esc_html( $this->form_settings['post_type'] ),
+ absint( $user_sub['total_feature_item'] )
+ );
+ ?>
+ </span>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <input type="checkbox" class="wpuf_is_featured" name="is_featured_item" value="1" <?php echo $is_featured ? 'checked' : ''; ?> > | |
| <span class="wpuf-items-table-containermessage-box" id="remaining-feature-item"> <?php echo sprintf( | |
| <span class="wpuf-items-table-containermessage-box" id="remaining-feature-item"> <?php echo sprintf( | |
| // translators: %1$s is Post type and %2$s is total feature item | |
| wp_kses_post(__( 'Mark the %1$s as featured (remaining %2$d)', 'wp-user-frontend' ), esc_html ($this->form_settings['post_type'] ), esc_html( $user_sub['total_feature_item'] ) )); ?></span> | |
| </label> | |
| <input | |
| type="checkbox" | |
| class="wpuf_is_featured" | |
| name="is_featured_item" | |
| value="1" | |
| <?php echo $is_featured ? 'checked' : ''; ?> | |
| > | |
| <span class="wpuf-message-box" id="remaining-feature-item"> | |
| <?php | |
| // translators: %1$s is Post type and %2$d is total feature item | |
| printf( | |
| esc_html__( 'Mark the %1$s as featured (remaining %2$d)', 'wp-user-frontend' ), | |
| esc_html( $this->form_settings['post_type'] ), | |
| absint( $user_sub['total_feature_item'] ) | |
| ); | |
| ?> | |
| </span> | |
| </label> |
Rubaiyat-E-Mohammad
added
QA Approved
fixes #1086
Introduces a new 'AI Settings' section in the settings options, allowing selection of AI provider, model, and API key. Adds dynamic filtering of AI models in the admin UI based on the selected provider. Removes unnecessary debug console logs from admin posting scripts and makes a minor formatting fix in the frontend render form.
Summary by CodeRabbit