PluginProbe
BetterDocs – AI Documentation, Knowledge Base, MCP Server, Docs, Wikis, FAQ & Chatbot / 4.9.3
BetterDocs – AI Documentation, Knowledge Base, MCP Server, Docs, Wikis, FAQ & Chatbot v4.9.3
4.9.3 4.9.2 4.9.1 4.9.0 4.8.2 4.8.1 4.8.0 4.7.0 4.6.2 4.6.1 4.6.0 4.5.6 4.5.5 4.5.4 4.5.3 4.5.2 4.5.1 4.5.0 4.4.1 4.4.0 3.3.4 3.4.0 3.4.1 3.4.2 3.5.0 All 201 releases
← All changes | includes/Core/Settings.php +330 -83 4.5.6 → 4.9.3 View file →
@@ -9,8 +9,11 @@
9 9 use WP_Error;
10 10 use WP_User;
11 11 use WPDeveloper\BetterDocs\Admin\Builder\GlobalFields;
12 12 use WPDeveloper\BetterDocs\Admin\Builder\Rules;
13 +use WPDeveloper\BetterDocs\AI\ModelRegistry;
14 +use WPDeveloper\BetterDocs\AI\ProviderFactory;
15 +use WPDeveloper\BetterDocs\REST\AIEdit;
13 16 use WPDeveloper\BetterDocs\Utils\AIHelper;
14 17 use WPDeveloper\BetterDocs\Utils\Base;
15 18 use WPDeveloper\BetterDocs\Utils\Database;
16 19 use WPDeveloper\BetterDocs\Utils\Helper;
@@ -76,8 +79,31 @@
76 79 return esc_url( admin_url( 'admin.php?page=betterdocs-settings' ) );
77 80 }
78 81
79 82 /**
83 + * Settings keys holding secret API keys. These are masked before reaching
84 + * the browser, stripped for non-admins, and never persisted as their mask.
85 + *
86 + * Covers the AI Chatbot key plus every content-suite platform key. OpenAI's
87 + * is `ai_autowrite_api_key` (see ProviderFactory::key_field_for), hence the
88 + * dedupe.
89 + *
90 + * @return array<int,string>
91 + */
92 + public static function sensitive_api_key_fields() {
93 + $fields = array(
94 + ProviderFactory::OPENAI_KEY_FIELD,
95 + 'ai_chatbot_api_key',
96 + );
97 + foreach ( array_keys( ModelRegistry::platforms() ) as $platform ) {
98 + $fields[] = ProviderFactory::key_field_for( $platform );
99 + }
100 + // Add-ons (e.g. the AI Chatbot) register their own per-platform keys here
101 + // so they are masked in the browser and stripped for non-admins.
102 + return apply_filters( 'betterdocs_sensitive_api_key_fields', array_values( array_unique( $fields ) ) );
103 + }
104 +
105 + /**
80 106 * This method is responsible for enqueueing scripts in settings panel
81 107 *
82 108 * @param string $hook
83 109 *
@@ -94,9 +120,9 @@
94 120
95 121 $settings = GlobalFields::normalize( $this->settings_args() );
96 122
97 123 // Mask sensitive API keys before they reach the browser. Non-admins still get them stripped entirely below.
98 - $sensitive_api_keys = array( 'ai_autowrite_api_key', 'ai_chatbot_api_key' );
124 + $sensitive_api_keys = self::sensitive_api_key_fields();
99 125 foreach ( $sensitive_api_keys as $api_key_field ) {
100 126 if ( ! empty( $settings[ 'values' ][ $api_key_field ] ) ) {
101 127 $settings[ 'values' ][ $api_key_field ] = Helper::mask_api_key( $settings[ 'values' ][ $api_key_field ] );
102 128 }
@@ -202,8 +228,9 @@
202 228 */
203 229 public function get_default() {
204 230 $_default = array(
205 231 'multiple_kb' => '',
232 + 'enable_ai_sample_docs' => true,
206 233 'enable_export_faq' => true,
207 234 'builtin_doc_page' => true,
208 235 'breadcrumb_doc_title' => __( 'Docs', 'betterdocs' ),
209 236 'enable_category_hierarchy_slugs' => false,
@@ -256,8 +283,12 @@
256 283 'enable_breadcrumb_category' => true,
257 284 'enable_breadcrumb_title' => true,
258 285 'enable_sidebar_cat_list' => true,
259 286 'enable_print_icon' => true,
287 + 'print_enable_logo' => false,
288 + 'print_logo' => array(),
289 + 'print_enable_footer' => false,
290 + 'print_footer_text' => '',
260 291 'enable_tags' => true,
261 292 'email_feedback' => true,
262 293 'feedback_link_text' => __( 'Still stuck? How can we help?', 'betterdocs' ),
263 294 'reaction_feedback_text' => __( 'Thanks for your feedback', 'betterdocs' ),
@@ -270,8 +301,9 @@
270 301 'enable_credit' => false,
271 302 'enable_archive_sidebar' => true,
272 303 'archive_nested_subcategory' => true,
273 304 'archive_enable_pagination' => false,
305 + 'archive_lazy_load_descendants' => false,
274 306 'enable_content_restriction' => false,
275 307 'enable_reporting' => false,
276 308 'enable_sample_data' => false,
277 309 'reporting_day' => 'monday',
@@ -278,14 +310,34 @@
278 310 'reporting_email' => get_option( 'admin_email' ),
279 311 'enable_write_with_ai' => true,
280 312 'enable_faq_write_with_ai' => true,
281 313 'enable_glossaries_write_with_ai' => true,
314 + 'enable_docs_ai_suite' => true,
282 315 'write_with_ai_model' => 'gpt-4o-mini',
283 316 'ai_autowrite_api_key' => '',
284 317 'ai_autowrite_max_token' => 2500,
318 + 'write_with_ai_instructions' => array(
319 + array(
320 + 'id' => 'default',
321 + 'title' => __( 'Default/Core', 'betterdocs' ),
322 + 'content' => WriteWithAI::default_instruction_content()
323 + )
324 + ),
325 + 'ai_edit_actions' => AIEdit::default_actions(),
285 326 'enable_article_summary' => false,
286 327 'article_summary_model' => 'gpt-4o-mini',
287 328 'article_summary_max_token' => 1500,
329 + // Multi-platform AI (content suite). `ai_platform` selects the active
330 + // provider; `ai_model` is the single global model; keys are stored
331 + // per platform so switching never loses a saved key. OpenAI reuses
332 + // `ai_autowrite_api_key` above — it has always held an OpenAI key,
333 + // so nothing needs migrating.
334 + 'ai_platform' => 'openai',
335 + 'ai_model' => 'gpt-4o-mini',
336 + 'ai_api_key_gemini' => '',
337 + 'ai_api_key_claude' => '',
338 + 'ai_api_key_deepseek' => '',
339 + 'ai_api_key_openrouter' => '',
288 340 'enable_estimated_reading_time' => true,
289 341 'enable_encyclopedia' => false,
290 342 'enable_glossaries' => false,
291 343 'show_glossary_suggestions' => true,
@@ -295,9 +347,21 @@
295 347 'singular_estimated_reading_time_text' => __( 'min read', 'betterdocs' ),
296 348 'betterdocs_access_control_repeater' => array(),
297 349 'internal_knowledge_base_type' => 'basic',
298 350 'betterdocs_access_control_repeater_kb' => array(),
299 - 'enable_git_integration' => false
351 + 'enable_git_integration' => false,
352 + /**
353 + * MCP master switch. Off by default; the toggle lives on the
354 + * BetterDocs → MCP page, not in the settings tree, and writes
355 + * through POST betterdocs/v1/settings.
356 + *
357 + * The key has to be listed here or `get()` cannot see it at all:
358 + * it answers `$default` for anything absent from the defaults
359 + * array, whatever the stored option holds.
360 + *
361 + * @since 4.9.0
362 + */
363 + 'enable_mcp' => ''
300 364 );
301 365
302 366 $_default = apply_filters( 'betterdocs_default_settings', $_default );
303 367 // $_default = apply_filters_deprecated(
@@ -590,19 +654,27 @@
590 654 }
591 655
592 656 $_old_settings = $this->database->get( $this->base_key, $this->get_default() );
593 657
594 - // The frontend only ever sees masked API keys. If a submitted value matches the mask of
595 - // the stored value, the user did not change it — restore the original so the mask string
596 - // is never persisted.
597 - $sensitive_api_keys = array( 'ai_autowrite_api_key', 'ai_chatbot_api_key' );
658 + // The frontend only ever sees masked API keys. A submitted value that still looks like a
659 + // mask (contains a run of asterisks — no real key does) means "unchanged": restore the
660 + // stored original so a mask string is never persisted. Guarding on the mask SHAPE rather
661 + // than strict equality with mask(stored) closes the corruption loop QA hit: once a mask
662 + // slips into storage, mask(mask) === mask, so an equality-only guard would faithfully
663 + // preserve the corrupted value forever (round-2 follow-up #1). When the stored value is
664 + // itself mask-shaped it is unrecoverable — clear it so the UI and the GeoIP/GA4 status
665 + // surfaces honestly report a missing key instead of failing downstream with 401s.
666 + $sensitive_api_keys = self::sensitive_api_key_fields();
598 667 foreach ( $sensitive_api_keys as $api_key_field ) {
599 668 if ( ! isset( $settings[ $api_key_field ] ) ) {
600 669 continue;
601 670 }
602 - $stored = isset( $_old_settings[ $api_key_field ] ) ? $_old_settings[ $api_key_field ] : '';
603 - if ( '' !== $stored && trim( (string) $settings[ $api_key_field ] ) === Helper::mask_api_key( $stored ) ) {
604 - $settings[ $api_key_field ] = $stored;
671 + $incoming = trim( (string) $settings[ $api_key_field ] );
672 + $stored = isset( $_old_settings[ $api_key_field ] ) ? (string) $_old_settings[ $api_key_field ] : '';
673 + $stored_is_mask = '' !== $stored && preg_match( '/\*{4,}/', $stored );
674 +
675 + if ( '' !== $incoming && preg_match( '/\*{4,}/', $incoming ) ) {
676 + $settings[ $api_key_field ] = $stored_is_mask ? '' : $stored;
605 677 }
606 678 }
607 679
608 680 // Minimum-token policy: reject saves where a feature's max_token field is below the
@@ -617,9 +689,9 @@
617 689 array(
618 690 'tab' => 'tab-betterdocs-ai',
619 691 'context' => 'write_with_ai',
620 692 'token_key' => 'ai_autowrite_max_token',
621 - 'model_key' => 'write_with_ai_model',
693 + 'model_key' => 'ai_model',
622 694 'label' => __( 'Write with AI', 'betterdocs' )
623 695 ),
624 696 array(
625 697 'tab' => 'tab-betterdocs-ai',
@@ -624,9 +696,9 @@
624 696 array(
625 697 'tab' => 'tab-betterdocs-ai',
626 698 'context' => 'article_summary',
627 699 'token_key' => 'article_summary_max_token',
628 - 'model_key' => 'article_summary_model',
700 + 'model_key' => 'ai_model',
629 701 'label' => __( 'AI Doc Summarizer', 'betterdocs' )
630 702 )
631 703 );
632 704 foreach ( $token_pairs as $pair ) {
@@ -661,21 +733,38 @@
661 733 betterdocs()->kbmigration->migrate();
662 734 }
663 735 $_settings = wp_parse_args( $_normalized_settings, $_old_settings );
664 736
665 - // Check if there are actual changes before saving.
666 - // update_option returns false when values serialize identically, which can happen
667 - // due to object caching or type normalization even when user made changes.
668 - $_has_changes = $_settings != $_old_settings;
737 + // Detect whether this save actually changes the effective settings.
738 + //
739 + // The stored option and the submitted payload are normalized differently:
740 + // an optional field can be ABSENT from storage yet arrive as '' (e.g.
741 + // Feedback URL), and array fields can be stored empty ( [] ) while their
742 + // normalized/default form is non-empty (e.g. Instant Answer's
743 + // display_ia_texonomy defaults to ['all']). Comparing the raw arrays
744 + // ( $_settings != $_old_settings ) therefore reported a phantom change on
745 + // every save, leaving the tab perpetually "dirty" and always toasting
746 + // "Changes Saved Successfully." instead of "There are no changes to be
747 + // saved." — see WPDevelopers/betterdocs-pro#78.
748 + //
749 + // Compare like-for-like instead: fill defaults on both sides and run both
750 + // through the same normalization, so semantically-equal states (absent vs
751 + // '', [] vs ['all'], 'on' vs true) collapse to identical values and only a
752 + // real edit registers. This is also more reliable than update_option()'s
753 + // return, which is false whenever values serialize identically under object
754 + // caching or type coercion even when the user did change something (#49).
755 + $_defaults = array_merge( $this->get_default(), $this->get_pro_defaults() );
756 + $_old_normalized = $this->get_normalized_values( wp_parse_args( $_old_settings, $_defaults ), $_defaults );
757 + $_new_normalized = $this->get_normalized_values( wp_parse_args( $_settings, $_defaults ), $_defaults );
758 + $_has_changes = $_new_normalized != $_old_normalized;
669 759
670 760 $_saved = $this->database->save( $this->base_key, $_settings );
671 761
672 762 do_action_ref_array( 'betterdocs::settings::saved', array( $_saved, $_settings, $_old_settings, &$this ) );
673 763
674 - // Return true if save succeeded OR if there were changes to attempt saving.
675 - // This handles cases where update_option returns false due to identical serialization
676 - // (e.g., object caching, type coercion during serialization).
677 - return $_saved || $_has_changes;
764 + // The success / no-changes toast reflects whether the user made a real
765 + // change, not update_option()'s (unreliable) return value.
766 + return $_has_changes;
678 767 }
679 768
680 769 public function views( $hook ) {
681 770 return betterdocs()->views->get( 'admin/settings' );
@@ -998,8 +1087,17 @@
998 1087 'enable_disable_text_active' => true,
999 1088 'default' => 1,
1000 1089 'priority' => 1
1001 1090 ),
1091 + 'archive_lazy_load_descendants' => array(
1092 + 'name' => 'archive_lazy_load_descendants',
1093 + 'type' => 'toggle',
1094 + 'label' => __( 'Lazy Load Sidebar Docs & Subcategories', 'betterdocs' ),
1095 + 'label_subtitle' => __( 'Applies to the Sidebar layout wherever it appears — single docs, category archives, and the Sidebar widget/block. Off by default: enable to render only the active category upfront and fetch the rest on click (or on scroll for the Memphis layout), cutting initial HTML size on large knowledge bases.', 'betterdocs' ),
1096 + 'enable_disable_text_active' => true,
1097 + 'default' => false,
1098 + 'priority' => 2
1099 + ),
1002 1100 'nested_subcategory' => array(
1003 1101 'name' => 'nested_subcategory',
1004 1102 'type' => 'toggle',
1005 1103 'label' => __( 'Nested Sub Category', 'betterdocs' ),
@@ -1004,9 +1102,9 @@
1004 1102 'type' => 'toggle',
1005 1103 'label' => __( 'Nested Sub Category', 'betterdocs' ),
1006 1104 'enable_disable_text_active' => true,
1007 1105 'default' => '',
1008 - 'priority' => 2
1106 + 'priority' => 3
1009 1107 ),
1010 1108 'column_number' => array(
1011 1109 'name' => 'column_number',
1012 1110 'type' => 'number',
@@ -1012,9 +1110,9 @@
1012 1110 'type' => 'number',
1013 1111 'label' => __( 'Number Of Columns', 'betterdocs' ),
1014 1112 'label_subtitle' => __( 'This setting is not applicable for sleek layout.', 'betterdocs' ),
1015 1113 'default' => 3,
1016 - 'priority' => 3
1114 + 'priority' => 4
1017 1115 ),
1018 1116 'posts_number' => apply_filters( 'betterdocs_posts_number', array(
1019 1117 'name' => 'posts_number',
1020 1118 'type' => 'number',
@@ -1020,9 +1118,9 @@
1020 1118 'type' => 'number',
1021 1119 'label' => __( 'Number Of Docs', 'betterdocs' ),
1022 1120 'label_subtitle' => __( 'This setting is not applicable for handbook layout.', 'betterdocs' ),
1023 1121 'default' => 10,
1024 - 'priority' => 4
1122 + 'priority' => 5
1025 1123 ) ),
1026 1124 'post_count' => array(
1027 1125 'name' => 'post_count',
1028 1126 'type' => 'toggle',
@@ -1028,9 +1126,9 @@
1028 1126 'type' => 'toggle',
1029 1127 'label' => __( 'Doc Count', 'betterdocs' ),
1030 1128 'enable_disable_text_active' => true,
1031 1129 'default' => 1,
1032 - 'priority' => 5
1130 + 'priority' => 6
1033 1131 ),
1034 1132 'count_text' => array(
1035 1133 'name' => 'count_text',
1036 1134 'type' => 'text',
@@ -1035,9 +1133,9 @@
1035 1133 'name' => 'count_text',
1036 1134 'type' => 'text',
1037 1135 'label' => __( 'Count Text', 'betterdocs' ),
1038 1136 'default' => __( 'Docs', 'betterdocs' ),
1039 - 'priority' => 6
1137 + 'priority' => 7
1040 1138 ),
1041 1139 'count_text_singular' => array(
1042 1140 'name' => 'count_text_singular',
1043 1141 'type' => 'text',
@@ -1042,9 +1140,9 @@
1042 1140 'name' => 'count_text_singular',
1043 1141 'type' => 'text',
1044 1142 'label' => __( 'Count Text Singular', 'betterdocs' ),
1045 1143 'default' => __( 'Doc', 'betterdocs' ),
1046 - 'priority' => 7
1144 + 'priority' => 8
1047 1145 ),
1048 1146 'exploremore_btn' => array(
1049 1147 'name' => 'exploremore_btn',
1050 1148 'type' => 'toggle',
@@ -1050,9 +1148,9 @@
1050 1148 'type' => 'toggle',
1051 1149 'label' => __( 'Explore More Button', 'betterdocs' ),
1052 1150 'enable_disable_text_active' => true,
1053 1151 'default' => true,
1054 - 'priority' => 8
1152 + 'priority' => 9
1055 1153 ),
1056 1154 'exploremore_btn_txt' => array(
1057 1155 'name' => 'exploremore_btn_txt',
1058 1156 'type' => 'text',
@@ -1057,9 +1155,9 @@
1057 1155 'name' => 'exploremore_btn_txt',
1058 1156 'type' => 'text',
1059 1157 'label' => __( 'Explore More Button Text', 'betterdocs' ),
1060 1158 'default' => __( 'Explore More', 'betterdocs' ),
1061 - 'priority' => 9,
1159 + 'priority' => 10,
1062 1160 'rules' => Rules::is( 'exploremore_btn', true )
1063 1161 ),
1064 1162 'betterdocs_popular_docs_text' => array(
1065 1163 'name' => 'betterdocs_popular_docs_text',
@@ -1065,9 +1163,9 @@
1065 1163 'name' => 'betterdocs_popular_docs_text',
1066 1164 'type' => 'text',
1067 1165 'label' => __( 'Popular Docs Text', 'betterdocs' ),
1068 1166 'default' => __( 'Popular Docs', 'betterdocs' ),
1069 - 'priority' => 10,
1167 + 'priority' => 11,
1070 1168 'is_pro' => true
1071 1169 ),
1072 1170 'betterdocs_popular_docs_number' => array(
1073 1171 'name' => 'betterdocs_popular_docs_number',
@@ -1073,9 +1171,9 @@
1073 1171 'name' => 'betterdocs_popular_docs_number',
1074 1172 'type' => 'number',
1075 1173 'label' => __( 'Popular Docs Number', 'betterdocs' ),
1076 1174 'default' => 10,
1077 - 'priority' => 11,
1175 + 'priority' => 12,
1078 1176 'is_pro' => true
1079 1177 )
1080 1178 )
1081 1179 ),
@@ -1319,8 +1417,44 @@
1319 1417 'enable_disable_text_active' => true,
1320 1418 'default' => 1,
1321 1419 'priority' => 3
1322 1420 ),
1421 + 'print_enable_logo' => array(
1422 + 'name' => 'print_enable_logo',
1423 + 'type' => 'toggle',
1424 + 'label' => __( 'Logo on Printed Doc', 'betterdocs' ),
1425 + 'label_subtitle' => __( 'Show a logo at the top of the printed / PDF page', 'betterdocs' ),
1426 + 'enable_disable_text_active' => true,
1427 + 'default' => 0,
1428 + 'priority' => 4
1429 + ),
1430 + 'print_logo' => array(
1431 + 'name' => 'print_logo',
1432 + 'type' => 'media',
1433 + 'value' => '',
1434 + 'label' => __( 'Print Logo', 'betterdocs' ),
1435 + 'label_subtitle' => __( 'Leave empty to use your site logo, or the site icon when no site logo is set', 'betterdocs' ),
1436 + 'priority' => 5,
1437 + 'rules' => Rules::is( 'print_enable_logo', true )
1438 + ),
1439 + 'print_enable_footer' => array(
1440 + 'name' => 'print_enable_footer',
1441 + 'type' => 'toggle',
1442 + 'label' => __( 'Footer on Printed Doc', 'betterdocs' ),
1443 + 'label_subtitle' => __( 'Show a footer on every page of the printed / PDF document', 'betterdocs' ),
1444 + 'enable_disable_text_active' => true,
1445 + 'default' => 0,
1446 + 'priority' => 6
1447 + ),
1448 + 'print_footer_text' => array(
1449 + 'name' => 'print_footer_text',
1450 + 'type' => 'textarea',
1451 + 'label' => __( 'Print Footer Text', 'betterdocs' ),
1452 + 'label_subtitle' => __( 'Leave empty to use the site name and current year', 'betterdocs' ),
1453 + 'default' => '',
1454 + 'priority' => 7,
1455 + 'rules' => Rules::is( 'print_enable_footer', true )
1456 + ),
1323 1457 'enable_tags' => array(
1324 1458 'name' => 'enable_tags',
1325 1459 'type' => 'toggle',
1326 1460 'label' => __( 'Tags', 'betterdocs' ),
@@ -1325,9 +1459,9 @@
1325 1459 'type' => 'toggle',
1326 1460 'label' => __( 'Tags', 'betterdocs' ),
1327 1461 'enable_disable_text_active' => true,
1328 1462 'default' => 1,
1329 - 'priority' => 4
1463 + 'priority' => 8
1330 1464 ),
1331 1465 'show_last_update_time' => array(
1332 1466 'name' => 'show_last_update_time',
1333 1467 'type' => 'toggle',
@@ -1333,9 +1467,9 @@
1333 1467 'type' => 'toggle',
1334 1468 'label' => __( 'Last Update Time', 'betterdocs' ),
1335 1469 'enable_disable_text_active' => true,
1336 1470 'default' => 1,
1337 - 'priority' => 5
1471 + 'priority' => 9
1338 1472 ),
1339 1473 'enable_navigation' => array(
1340 1474 'name' => 'enable_navigation',
1341 1475 'type' => 'toggle',
@@ -1341,9 +1475,9 @@
1341 1475 'type' => 'toggle',
1342 1476 'label' => __( 'Navigation', 'betterdocs' ),
1343 1477 'enable_disable_text_active' => true,
1344 1478 'default' => 1,
1345 - 'priority' => 6
1479 + 'priority' => 10
1346 1480 ),
1347 1481 'enable_comment' => array(
1348 1482 'name' => 'enable_comment',
1349 1483 'type' => 'toggle',
@@ -1349,9 +1483,9 @@
1349 1483 'type' => 'toggle',
1350 1484 'label' => __( 'Comment', 'betterdocs' ),
1351 1485 'enable_disable_text_active' => true,
1352 1486 'default' => '',
1353 - 'priority' => 7
1487 + 'priority' => 11
1354 1488 ),
1355 1489 'enable_credit' => array(
1356 1490 'name' => 'enable_credit',
1357 1491 'type' => 'toggle',
@@ -1357,9 +1491,9 @@
1357 1491 'type' => 'toggle',
1358 1492 'label' => __( 'Show Powered by BetterDocs', 'betterdocs' ),
1359 1493 'enable_disable_text_active' => true,
1360 1494 'default' => '',
1361 - 'priority' => 8
1495 + 'priority' => 12
1362 1496 ),
1363 1497 'reaction_feedback_text' => array(
1364 1498 'name' => 'reaction_feedback_text',
1365 1499 'type' => 'text',
@@ -1364,9 +1498,9 @@
1364 1498 'name' => 'reaction_feedback_text',
1365 1499 'type' => 'text',
1366 1500 'label' => __( 'Reaction Feedback Text', 'betterdocs' ),
1367 1501 'default' => __( 'Thanks for your feedback.', 'betterdocs' ),
1368 - 'priority' => 9
1502 + 'priority' => 13
1369 1503 ),
1370 1504 'enable_estimated_reading_time' => array(
1371 1505 'name' => 'enable_estimated_reading_time',
1372 1506 'type' => 'toggle',
@@ -1372,9 +1506,9 @@
1372 1506 'type' => 'toggle',
1373 1507 'label' => __( 'Estimated Reading Time', 'betterdocs' ),
1374 1508 'enable_disable_text_active' => true,
1375 1509 'default' => 0,
1376 - 'priority' => 10
1510 + 'priority' => 14
1377 1511 ),
1378 1512 'estimated_reading_time_title' => array(
1379 1513 'name' => 'estimated_reading_time_title',
1380 1514 'type' => 'text',
@@ -1379,9 +1513,9 @@
1379 1513 'name' => 'estimated_reading_time_title',
1380 1514 'type' => 'text',
1381 1515 'label' => __( 'Estimated Reading Time Title', 'betterdocs' ),
1382 1516 'default' => '',
1383 - 'priority' => 11,
1517 + 'priority' => 15,
1384 1518 'rules' => Rules::is( 'enable_estimated_reading_time', true )
1385 1519 ),
1386 1520 'estimated_reading_time_text' => array(
1387 1521 'name' => 'estimated_reading_time_text',
@@ -1387,9 +1521,9 @@
1387 1521 'name' => 'estimated_reading_time_text',
1388 1522 'type' => 'text',
1389 1523 'label' => __( 'Estimated Reading Time Text', 'betterdocs' ),
1390 1524 'default' => __( 'min read', 'betterdocs' ),
1391 - 'priority' => 12,
1525 + 'priority' => 16,
1392 1526 'rules' => Rules::is( 'enable_estimated_reading_time', true )
1393 1527 ),
1394 1528 'singular_estimated_reading_time_text' => array(
1395 1529 'name' => 'singular_estimated_reading_time_text',
@@ -1395,9 +1529,9 @@
1395 1529 'name' => 'singular_estimated_reading_time_text',
1396 1530 'type' => 'text',
1397 1531 'label' => __( 'Estimated Reading Time Text Singular', 'betterdocs' ),
1398 1532 'default' => __( 'min read', 'betterdocs' ),
1399 - 'priority' => 13,
1533 + 'priority' => 17,
1400 1534 'rules' => Rules::is( 'enable_estimated_reading_time', true )
1401 1535 )
1402 1536 )
1403 1537 ),
@@ -2277,18 +2411,84 @@
2277 2411 'open-ai-settings' => array(
2278 2412 'id' => 'open-ai-settings',
2279 2413 'name' => 'open-ai-settings',
2280 2414 'type' => 'section',
2281 - 'label' => __( 'API Settings', 'betterdocs' ),
2415 + 'label' => __( 'AI Platform & API', 'betterdocs' ),
2282 2416 'priority' => 1,
2283 2417 'fields' => array(
2418 + 'ai_platform' => array(
2419 + 'name' => 'ai_platform',
2420 + 'type' => 'select',
2421 + 'label' => __( 'AI Platform', 'betterdocs' ),
2422 + 'label_subtitle' => __( 'Choose which AI platform powers Write with AI, AI Edit, the Doc Summarizer and Quality Score. The model list and API key field below adapt to your choice.', 'betterdocs' ),
2423 + 'priority' => 1,
2424 + 'multiple' => false,
2425 + 'default' => 'openai',
2426 + // DeepSeek and OpenRouter are temporarily hidden from the
2427 + // dropdown. Filter the options here, NOT ModelRegistry::platforms() —
2428 + // sensitive_api_key_fields() loops the registry to mask each
2429 + // platform's key field, so trimming the registry would silently
2430 + // un-mask those keys. Re-enable later by dropping the array_diff_key.
2431 + 'options' => GlobalFields::normalize_fields(
2432 + array_diff_key( ModelRegistry::platforms(), array_flip( array( 'deepseek', 'openrouter' ) ) )
2433 + )
2434 + ),
2435 + // OpenAI's key field keeps its original name so installs
2436 + // that already saved a Write with AI key keep it.
2284 2437 'ai_autowrite_api_key' => array(
2285 2438 'name' => 'ai_autowrite_api_key',
2286 2439 'type' => 'text',
2287 - 'label' => __( 'API Key', 'betterdocs' ),
2288 - 'label_subtitle' => sprintf( /* translators: %s is a link to the documentation about generating an OpenAI API key. */__( 'Check out this <a target="_blank" href="%s">documentation</a> to find out how to generate your OpenAI API Key.', 'betterdocs' ), esc_url( 'https://betterdocs.co/docs/write-with-ai/' ) ),
2440 + 'label' => __( 'OpenAI API Key', 'betterdocs' ),
2441 + 'label_subtitle' => sprintf( /* translators: %s: documentation URL */ __( 'Check out this <a target="_blank" href="%s">documentation</a> to generate your OpenAI API key.', 'betterdocs' ), esc_url( 'https://betterdocs.co/docs/write-with-ai/' ) ),
2289 2442 'default' => '',
2290 - 'priority' => 1
2443 + 'priority' => 2,
2444 + 'rules' => Rules::is( 'ai_platform', 'openai' )
2445 + ),
2446 + 'ai_api_key_gemini' => array(
2447 + 'name' => 'ai_api_key_gemini',
2448 + 'type' => 'text',
2449 + 'label' => __( 'Google Gemini API Key', 'betterdocs' ),
2450 + 'label_subtitle' => sprintf( /* translators: %s: Google AI Studio URL */ __( 'Generate a key from <a target="_blank" href="%s">Google AI Studio</a>.', 'betterdocs' ), esc_url( 'https://aistudio.google.com/app/apikey' ) ),
2451 + 'default' => '',
2452 + 'priority' => 2,
2453 + 'rules' => Rules::is( 'ai_platform', 'gemini' )
2454 + ),
2455 + 'ai_api_key_claude' => array(
2456 + 'name' => 'ai_api_key_claude',
2457 + 'type' => 'text',
2458 + 'label' => __( 'Anthropic Claude API Key', 'betterdocs' ),
2459 + 'label_subtitle' => sprintf( /* translators: %s: Anthropic Console URL */ __( 'Generate a key from the <a target="_blank" href="%s">Anthropic Console</a>.', 'betterdocs' ), esc_url( 'https://console.anthropic.com/settings/keys' ) ),
2460 + 'default' => '',
2461 + 'priority' => 2,
2462 + 'rules' => Rules::is( 'ai_platform', 'claude' )
2463 + ),
2464 + 'ai_api_key_deepseek' => array(
2465 + 'name' => 'ai_api_key_deepseek',
2466 + 'type' => 'text',
2467 + 'label' => __( 'DeepSeek API Key', 'betterdocs' ),
2468 + 'label_subtitle' => sprintf( /* translators: %s: DeepSeek platform URL */ __( 'Generate a key from the <a target="_blank" href="%s">DeepSeek platform</a>.', 'betterdocs' ), esc_url( 'https://platform.deepseek.com/api_keys' ) ),
2469 + 'default' => '',
2470 + 'priority' => 2,
2471 + 'rules' => Rules::is( 'ai_platform', 'deepseek' )
2472 + ),
2473 + 'ai_api_key_openrouter' => array(
2474 + 'name' => 'ai_api_key_openrouter',
2475 + 'type' => 'text',
2476 + 'label' => __( 'OpenRouter API Key', 'betterdocs' ),
2477 + 'label_subtitle' => sprintf( /* translators: %s: OpenRouter keys URL */ __( 'Generate a key from <a target="_blank" href="%s">OpenRouter</a>.', 'betterdocs' ), esc_url( 'https://openrouter.ai/keys' ) ),
2478 + 'default' => '',
2479 + 'priority' => 2,
2480 + 'rules' => Rules::is( 'ai_platform', 'openrouter' )
2481 + ),
2482 + 'ai_model' => array(
2483 + 'name' => 'ai_model',
2484 + 'type' => 'platform_model_select',
2485 + 'label' => __( 'Model', 'betterdocs' ),
2486 + 'label_subtitle' => __( 'Available models depend on the selected platform.', 'betterdocs' ),
2487 + 'priority' => 10,
2488 + 'default' => 'gpt-4o-mini',
2489 + 'catalogue' => ModelRegistry::catalogue(),
2490 + 'defaults' => ModelRegistry::defaults()
2291 2491 )
2292 2492 )
2293 2493 ),
2294 2494 'write-with-ai' => array(
@@ -2297,8 +2497,39 @@
2297 2497 'type' => 'section',
2298 2498 'label' => __( 'Write with AI', 'betterdocs' ),
2299 2499 'priority' => 5,
2300 2500 'fields' => array(
2501 + 'write-with-ai-subtabs' => array(
2502 + 'id' => 'write-with-ai-subtabs',
2503 + 'name' => 'write_with_ai_subtabs',
2504 + 'label' => __( 'Write with AI', 'betterdocs' ),
2505 + 'classes' => 'tab-nested-layout',
2506 + 'type' => 'tab',
2507 + 'active' => 'wwa-configuration',
2508 + 'completionTrack' => true,
2509 + 'sidebar' => false,
2510 + 'save' => false,
2511 + 'title' => false,
2512 + 'config' => array(
2513 + 'active' => 'wwa-configuration',
2514 + 'sidebar' => false,
2515 + 'title' => false
2516 + ),
2517 + 'submit' => array(
2518 + 'show' => false
2519 + ),
2520 + 'step' => array(
2521 + 'show' => false
2522 + ),
2523 + 'priority' => 5,
2524 + 'fields' => array(
2525 + 'wwa-configuration' => array(
2526 + 'id' => 'wwa-configuration',
2527 + 'name' => 'wwa-configuration',
2528 + 'type' => 'section',
2529 + 'label' => __( 'Configuration', 'betterdocs' ),
2530 + 'priority' => 1,
2531 + 'fields' => array(
2301 2532 'enable_write_with_ai' => array(
2302 2533 'name' => 'enable_write_with_ai',
2303 2534 'type' => 'toggle',
2304 2535 'priority' => 0,
@@ -2322,29 +2553,20 @@
2322 2553 'priority' => 6,
2323 2554 'label' => __( 'Write Glossaries with AI', 'betterdocs' ),
2324 2555 'label_subtitle' => __( 'Generate AI based Glossary definitions from the Glossaries admin page', 'betterdocs' ),
2325 2556 'enable_disable_text_active' => true,
2557 + 'default' => true,
2558 + 'is_pro' => true
2559 + ),
2560 + 'enable_docs_ai_suite' => array(
2561 + 'name' => 'enable_docs_ai_suite',
2562 + 'type' => 'toggle',
2563 + 'priority' => 7,
2564 + 'label' => __( 'Enhance Docs with AI', 'betterdocs' ),
2565 + 'label_subtitle' => __( 'Add BetterDocs AI actions for suggesting categories, tags and excerpts inside the native Docs editor panels.', 'betterdocs' ),
2566 + 'enable_disable_text_active' => true,
2326 2567 'default' => true
2327 2568 ),
2328 - 'write_with_ai_model' => array(
2329 - 'name' => 'write_with_ai_model',
2330 - 'type' => 'select',
2331 - 'label' => __( 'OpenAI Model*', 'betterdocs' ),
2332 - 'priority' => 20,
2333 - 'multiple' => false,
2334 - 'default' => 'gpt-4o-mini',
2335 - 'options' => GlobalFields::normalize_fields( array(
2336 - 'gpt-4o-mini' => 'GPT-4o Mini',
2337 - 'gpt-4o' => 'GPT-4o',
2338 - 'gpt-4.1-nano' => 'GPT-4.1 Nano',
2339 - 'gpt-4.1-mini' => 'GPT-4.1 Mini',
2340 - 'gpt-4.1' => 'GPT-4.1',
2341 - 'gpt-5-nano' => 'GPT-5 Nano',
2342 - 'gpt-5-mini' => 'GPT-5 Mini',
2343 - 'gpt-5' => 'GPT-5',
2344 - 'gpt-5.5' => 'GPT-5.5'
2345 - ) )
2346 - ),
2347 2569 'ai_autowrite_max_token' => array(
2348 2570 'name' => 'ai_autowrite_max_token',
2349 2571 'type' => 'min_token_number',
2350 2572 'label' => __( 'Set Max Tokens', 'betterdocs' ),
@@ -2351,13 +2573,57 @@
2351 2573 'label_subtitle' => sprintf( // translators: %s is a link to more information about token limits.
2352 2574 __( 'Documentation will be generated based on the Token Limits you have set. For more information on Token Limits, you can check out this <a target="_blank" href="%s">link</a>.', 'betterdocs' ), esc_url( 'https://platform.openai.com/account/limits' ) ),
2353 2575 'default' => 2500,
2354 2576 'priority' => 10,
2355 - 'model_field' => 'write_with_ai_model',
2577 + 'model_field' => 'ai_model',
2356 2578 'context' => 'write_with_ai',
2357 2579 'min_token_map' => AIHelper::get_min_tokens_map( 'write_with_ai' ),
2358 2580 'classes' => 'wprf-type-text'
2359 2581 )
2582 + )
2583 + ),
2584 + 'wwa-personalize' => array(
2585 + 'id' => 'wwa-personalize',
2586 + 'name' => 'wwa-personalize',
2587 + 'type' => 'section',
2588 + 'label' => __( 'Write AI Personalize', 'betterdocs' ),
2589 + 'priority' => 5,
2590 + 'fields' => array(
2591 + 'write_with_ai_instructions' => array(
2592 + 'name' => 'write_with_ai_instructions',
2593 + 'type' => 'wwa_instructions',
2594 + 'label' => __( 'Instructions', 'betterdocs' ),
2595 + 'label_subtitle' => __( 'Add reusable instruction sets to steer how BetterDocs AI writes. The "Default/Core" set is always applied; extra sets can be picked in the Write with AI popup.', 'betterdocs' ),
2596 + 'priority' => 1,
2597 + 'default' => array(
2598 + array(
2599 + 'id' => 'default',
2600 + 'title' => __( 'Default/Core', 'betterdocs' ),
2601 + 'content' => WriteWithAI::default_instruction_content()
2602 + )
2603 + )
2604 + )
2605 + )
2606 + ),
2607 + 'edit-ai-personalize' => array(
2608 + 'id' => 'edit-ai-personalize',
2609 + 'name' => 'edit-ai-personalize',
2610 + 'type' => 'section',
2611 + 'label' => __( 'Edit AI Personalize', 'betterdocs' ),
2612 + 'priority' => 7,
2613 + 'fields' => array(
2614 + 'ai_edit_actions' => array(
2615 + 'name' => 'ai_edit_actions',
2616 + 'type' => 'ai_edit_actions',
2617 + 'label' => __( 'Actions', 'betterdocs' ),
2618 + 'label_subtitle' => __( 'Choose which Edit with AI actions appear in the editor. Toggle actions on or off, edit each action\'s instruction, or add your own custom actions. All predefined actions are enabled by default.', 'betterdocs' ),
2619 + 'priority' => 1,
2620 + 'default' => AIEdit::default_actions()
2621 + )
2622 + )
2623 + )
2624 + )
2625 + )
2360 2626 )
2361 2627 ),
2362 2628 'article-summary' => array(
2363 2629 'id' => 'article-summary',
@@ -2382,31 +2648,12 @@
2382 2648 'label_subtitle' => sprintf( // translators: %s is a link to more information about token limits.
2383 2649 __( 'Single Doc summarizer will be generated based on the token limits you have set. For more information on Token Limits, you can check out this <a target="_blank" href="%s">link</a>.', 'betterdocs' ), esc_url( 'https://platform.openai.com/account/limits' ) ),
2384 2650 'default' => 1500,
2385 2651 'priority' => 5,
2386 - 'model_field' => 'article_summary_model',
2652 + 'model_field' => 'ai_model',
2387 2653 'context' => 'article_summary',
2388 2654 'min_token_map' => AIHelper::get_min_tokens_map( 'article_summary' ),
2389 2655 'classes' => 'wprf-type-text'
2390 - ),
2391 - 'article_summary_model' => array(
2392 - 'name' => 'article_summary_model',
2393 - 'type' => 'select',
2394 - 'label' => __( 'OpenAI Model*', 'betterdocs' ),
2395 - 'priority' => 10,
2396 - 'multiple' => false,
2397 - 'default' => 'gpt-4o-mini',
2398 - 'options' => GlobalFields::normalize_fields( array(
2399 - 'gpt-4o-mini' => 'GPT-4o Mini',
2400 - 'gpt-4o' => 'GPT-4o',
2401 - 'gpt-4.1-nano' => 'GPT-4.1 Nano',
2402 - 'gpt-4.1-mini' => 'GPT-4.1 Mini',
2403 - 'gpt-4.1' => 'GPT-4.1',
2404 - 'gpt-5-nano' => 'GPT-5 Nano',
2405 - 'gpt-5-mini' => 'GPT-5 Mini',
2406 - 'gpt-5' => 'GPT-5',
2407 - 'gpt-5.5' => 'GPT-5.5'
2408 - ) )
2409 2656 )
2410 2657 )
2411 2658 )
2412 2659 )