PluginProbe
BetterDocs – AI Documentation, Knowledge Base, MCP Server, Docs, Wikis, FAQ & Chatbot / 3.3.2
BetterDocs – AI Documentation, Knowledge Base, MCP Server, Docs, Wikis, FAQ & Chatbot v3.3.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 3.5.1 3.5.2 All 199 releases
betterdocs / includes / Core / Settings.php

Settings.php in BetterDocs – AI Documentation, Knowledge Base, MCP Server, Docs, Wikis, FAQ & Chatbot 3.3.2, at includes/Core/Settings.php

2,184 lines 151.2 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2
3 namespace WPDeveloper\BetterDocs\Core;
4
5 use WP_User;
6 use WP_Error;
7 use WPDeveloper\BetterDocs\Utils\Base;
8 use WPDeveloper\BetterDocs\Utils\Database;
9 use WPDeveloper\BetterDocs\Admin\Builder\Rules;
10 use WPDeveloper\BetterDocs\Admin\Builder\GlobalFields;
11
12 class Settings extends Base {
13 public $base_key = 'betterdocs_settings';
14
15 /**
16 * Database class
17 * @var Database
18 */
19 protected $database;
20
21 private $deprecated = [];
22
23 private $cannot_be_empty = [
24 'breadcrumb_doc_title',
25 'docs_slug',
26 'category_slug',
27 'tag_slug',
28 'permalink_structure',
29 'docs_page'
30 ];
31
32 public function __construct( Database $database ) {
33 $this->database = $database;
34 $this->deprecated = $this->deprecated_settings();
35
36 add_action( 'admin_enqueue_scripts', [$this, 'enqueue'] );
37
38 if ( isset( $_GET['page'] ) && $_GET['page'] === 'betterdocs-settings' && ! has_action( 'betterdocs_settings_header' ) ) {
39 add_action( 'betterdocs_settings_header', [$this, 'header'] );
40 }
41
42 add_action( 'wp_ajax_betterdocs_dark_mode', [$this, 'dark_mode'] );
43 add_filter( 'betterdocs_settings_tab_advance', [$this, 'hide_roles_management'], 11, 1 );
44 add_action( 'betterdocs::settings::saved', [$this, 'fallback_slugs'], 99, 3 );
45 }
46
47 public function fallback_slugs( $_saved, $_settings, $_old_settings = [] ) {
48 $_default = $this->get_default();
49 foreach ( $this->cannot_be_empty as $key ) {
50 if ( $key === 'docs_page' && ! $_settings['builtin_doc_page'] && empty( $_settings[$key] ) ) {
51 $this->save( 'builtin_doc_page', true );
52 continue;
53 }
54
55 if ( empty( $_settings[$key] ) ) {
56 $this->save( $key, $_default[$key] );
57 }
58 }
59 }
60
61 /**
62 * Get the settings URL for admin
63 * @return string
64 */
65 public function url() {
66 return esc_url( admin_url( 'admin.php?page=betterdocs-settings' ) );
67 }
68
69 /**
70 * This method is responsible for enqueueing scripts in settings panel
71 *
72 * @since 2.5.0
73 * @param string $hook
74 *
75 * @return void
76 */
77 public function enqueue( $hook ) {
78 if ( $hook !== 'betterdocs_page_betterdocs-settings' ) {
79 return;
80 }
81
82 wp_enqueue_script( 'betterdocs-admin' );
83 betterdocs()->assets->enqueue( 'betterdocs-settings', 'admin/css/settings.css' );
84 betterdocs()->assets->enqueue( 'betterdocs-icons', 'admin/btd-icon/style.css' );
85 betterdocs()->assets->enqueue( 'betterdocs-settings', 'admin/js/settings.js' );
86 betterdocs()->assets->localize(
87 'betterdocs-settings',
88 'betterdocsAdminSettings',
89 GlobalFields::normalize( $this->settings_args() )
90 );
91 }
92
93 /**
94 * This method is responsible for printing header in dashboard settings page.
95 *
96 * @since 2.5.0
97 * @param string $hook
98 *
99 * @return void
100 */
101 public function header( $hook ) {
102 if ( $hook !== 'settings' ) {
103 return;
104 }
105
106 betterdocs()->views->get( 'admin/template-parts/settings-header' );
107 betterdocs()->views->get( 'admin/template-parts/settings-header-2' );
108 }
109
110 /**
111 * A list of deprecated settings keys.
112 *
113 * @since 2.5.0
114 * @return array
115 */
116 public function deprecated_settings() {
117 return [];
118 }
119
120 /**
121 * Dynamic migration caller.
122 *
123 * @since 2.5.0
124 * @return void
125 */
126 public function migration( $version ) {
127 if ( $version > 250 ) {
128 for ( $v = 250; $v <= $version; $v++ ) {
129 $_func = "v{$v}";
130 if ( method_exists( $this, $_func ) ) {
131 call_user_func( [$this, $_func] );
132 }
133 }
134 }
135 }
136
137 /**
138 * Migration for version 2.5.0
139 *
140 * @since 2.5.0
141 * @return void
142 */
143 public function v250() {
144 if ( $this->get( 'alphabetically_order_term', false ) ) {
145 $this->save( 'terms_orderby', 'name' );
146 }
147
148 if ( $orderby = $this->get( 'alphabetically_order_post', false ) ) {
149 if ( $orderby === '1' ) {
150 $this->save( 'alphabetically_order_post', 'title' );
151 }
152 }
153 }
154
155 /**
156 * A list of default settings data.
157 *
158 * @since 1.0.0
159 *
160 * @return array
161 */
162 public function get_default() {
163 $_default = [
164 'multiple_kb' => '',
165 'builtin_doc_page' => true,
166 'breadcrumb_doc_title' => __( 'Docs', 'betterdocs' ),
167 'docs_slug' => 'docs',
168 'docs_page' => 0,
169 'category_slug' => 'docs-category',
170 'tag_slug' => 'docs-tag',
171 'permalink_structure' => 'docs/',
172 'enable_faq_schema' => false,
173 'live_search' => true,
174 'advance_search' => false,
175 'popular_keyword_limit' => 5,
176 'search_letter_limit' => 3,
177 'search_placeholder' => __( 'Search...', 'betterdocs' ),
178 'search_not_found_text' => __( 'Sorry, no docs were found.', 'betterdocs' ),
179 'search_result_image' => true,
180 'masonry_layout' => true,
181 'category_title_link' => false,
182 'terms_orderby' => 'betterdocs_order',
183 'alphabetically_order_term' => false,
184 'terms_order' => 'ASC',
185 'alphabetically_order_post' => 'betterdocs_order',
186 'docs_order' => 'ASC',
187 'nested_subcategory' => false,
188 'column_number' => 3,
189 'posts_number' => 10,
190 'post_count' => true,
191 'count_text' => __( 'docs', 'betterdocs' ),
192 'count_text_singular' => __( 'doc', 'betterdocs' ),
193 'exploremore_btn' => true,
194 'exploremore_btn_txt' => __( 'Explore More', 'betterdocs' ),
195 'doc_single' => 1,
196 'enable_toc' => true,
197 'toc_title' => __( 'Table of Contents', 'betterdocs' ),
198 'toc_hierarchy' => true,
199 'toc_list_number' => true,
200 'toc_dynamic_title' => false,
201 'enable_sticky_toc' => true,
202 'sticky_toc_offset' => 100,
203 'collapsible_toc_mobile' => false,
204 'supported_heading_tag' => ['1', '2', '3', '4', '5', '6'],
205 'enable_post_title' => true,
206 'title_link_ctc' => true,
207 'enable_breadcrumb' => true,
208 'breadcrumb_home_text' => __( 'Home', 'betterdocs' ),
209 'breadcrumb_home_url' => get_home_url(),
210 'enable_breadcrumb_category' => true,
211 'enable_breadcrumb_title' => true,
212 'enable_sidebar_cat_list' => true,
213 'enable_print_icon' => true,
214 'enable_tags' => true,
215 'email_feedback' => true,
216 'feedback_link_text' => __( 'Still stuck? How can we help?', 'betterdocs' ),
217 'feedback_url' => '',
218 'feedback_form_title' => __( 'How can we help?', 'betterdocs' ),
219 'email_address' => get_option( 'admin_email' ),
220 'show_last_update_time' => true,
221 'enable_navigation' => true,
222 'enable_comment' => true,
223 'enable_credit' => true,
224 'enable_archive_sidebar' => true,
225 'archive_nested_subcategory' => true,
226 'enable_content_restriction' => false,
227 'enable_reporting' => false,
228 'reporting_day' => 'monday',
229 'reporting_email' => get_option( 'admin_email' ),
230 'enable_write_with_ai' => true,
231 'enable_faq_write_with_ai' => true,
232 'ai_autowrite_api_key' => '',
233 'ai_autowrite_max_token' => 1500
234 ];
235
236 $_default = apply_filters( 'betterdocs_default_settings', $_default );
237 // $_default = apply_filters_deprecated(
238 // 'betterdocs_option_default_settings', [$_default], '2.5.0',
239 // 'betterdocs_default_settings', 'betterdocs_option_default_settings will be removed from v3.5.0.'
240 // );
241
242 return $_default;
243 }
244
245 /**
246 * A list of default settings for pro plugins.
247 *
248 * @since 2.5.0
249 * @return array
250 */
251 public function get_pro_defaults() {
252 return [];
253 }
254
255 /**
256 * Get customizer links for docs page.
257 *
258 * @since 1.0.0
259 * @return string
260 */
261 public function customizer_link() {
262 $query['autofocus[panel]'] = 'betterdocs_customize_options';
263 $query['return'] = admin_url( 'edit.php?post_type=docs' );
264 $builtin_doc_page = betterdocs()->settings->get( 'builtin_doc_page' );
265 $docs_slug = betterdocs()->settings->get( 'docs_slug' );
266 $docs_page = betterdocs()->settings->get( 'builtin_doc_page' );
267
268 if ( $builtin_doc_page == 1 && $docs_slug ) {
269 $query['url'] = site_url( '/' . $docs_slug );
270 } elseif ( $builtin_doc_page != 1 && $docs_page ) {
271 $post_info = get_post( $docs_page );
272 $query['url'] = site_url( '/' . $post_info->post_name );
273 }
274
275 return add_query_arg( $query, admin_url( 'customize.php' ) );
276 }
277
278 /**
279 * Get All Roles
280 * dynamically
281 *
282 * @return array
283 */
284 public function get_roles() {
285 $roles = wp_roles()->role_names;
286 unset( $roles['subscriber'] );
287 return $roles;
288 }
289
290 /**
291 * Set dark mode
292 *
293 * @since 1.0.0
294 * @return void
295 */
296 public function dark_mode() {
297 if ( ! check_ajax_referer( 'doc_cat_order_nonce', 'nonce', false ) ) {
298 wp_send_json_error();
299 }
300
301 if ( isset( $_POST['mode'] ) ) {
302 if ( $this->save( 'dark_mode', rest_sanitize_boolean( $_POST['mode'] ) ) ) {
303 wp_send_json_success();
304 }
305 }
306
307 wp_send_json_error();
308 }
309
310 public function get_normalized_value( $key, $value, $default = null ) {
311 $_origin_value = $_value = $value;
312
313 if ( in_array( $_value, ['on', 'off', '1', 'false', 'true'], true ) ) {
314 switch ( $_value ) {
315 case 'on':
316 case 'ON':
317 case '1':
318 case 'true':
319 $_value = true;
320 break;
321 case 'off':
322 case 'OFF':
323 case '':
324 case 'false':
325 $_value = false;
326 break;
327 }
328 }
329
330 $this->type_validation( $_value, $default );
331 return $_value;
332 }
333
334 public function get_normalized_values( $values, $default_values = [] ) {
335 if ( empty( $values ) ) {
336 return [];
337 }
338
339 $_settings = [];
340 foreach ( $values as $key => $value ) {
341 $_default_value = isset( $default_values[$key] ) ? $default_values[$key] : null;
342 $_settings[$key] = $this->get_normalized_value( $key, $value, $_default_value );
343 }
344
345 return $_settings;
346 }
347
348 public function get_all( $raw = false ) {
349 $_default_settings = $raw ? [] : array_merge( $this->get_default(), $this->get_pro_defaults() );
350 $_settings = $this->database->get( $this->base_key, $_default_settings );
351 return $this->get_normalized_values( $_settings, $_default_settings );
352 }
353
354 public function type_validation( &$value, $defaultValue = null ) {
355 if ( $defaultValue !== null ) {
356 /**
357 * Check if value is not in same type
358 */
359 $_default_type = gettype( $defaultValue );
360
361 if ( ! ( is_scalar( $defaultValue ) && is_scalar( $value ) ) && empty( $value ) ) {
362 $value = $defaultValue;
363 }
364
365 settype( $value, $_default_type );
366 }
367 }
368
369 /**
370 * Get settings value by key
371 *
372 * @since 2.5.0
373 *
374 * @param string $key
375 * @param mixed $default
376 * @param bool $get_all
377 *
378 * @return mixed
379 */
380 public function get( $key, $default = null ) {
381 $_default_settings = array_merge( $this->get_default(), $this->get_pro_defaults() );
382 $_settings = $this->database->get( $this->base_key, $_default_settings );
383
384 $_value = $default;
385 switch ( true ) {
386 // Check if it's a PRO Option
387 case ! isset( $_default_settings[$key] ):
388 $_value = $default;
389 break;
390 // Check if it's a FREE Option and not in DB.
391 case ! isset( $_settings[$key] ) && isset( $_default_settings[$key] ):
392 $_value = $default !== null ? $default : $_default_settings[$key];
393 break;
394 // Check if it's a FREE Option
395 case isset( $_settings[$key] ) && isset( $_default_settings[$key] ):
396 $_value = $_settings[$key];
397 break;
398 }
399
400 $_value = $this->get_normalized_value( $key, $_value, isset( $_default_settings[$key] ) ? $_default_settings[$key] : null );
401
402 if ( gettype( $_value ) === 'string' ) {
403 if ( empty( $_value ) && $default != null ) {
404 $_value = $default;
405 } elseif ( empty( $_value ) && $default === null && isset( $_default_settings[$key] ) ) {
406 $_value = $_default_settings[$key];
407 }
408 }
409
410 return $_value;
411 }
412
413 public function get_raw_field( $key, $default = null ) {
414 $_settings = $this->database->get( $this->base_key, [] );
415
416 if ( isset( $_settings[$key] ) ) {
417 return $this->get_normalized_value( $key, $_settings[$key], $default );
418 }
419
420 return $default;
421 }
422
423 public function save( $key, $value ) {
424 $_settings = $this->database->get( $this->base_key, [] );
425 $_settings[$key] = $value;
426
427 return $this->database->save( $this->base_key, $_settings );
428 }
429
430 public function save_settings( $settings ) {
431 $existing_plugins = betterdocs()->kbmigration->knowledge_base_plugins();
432 if ( ! current_user_can( 'edit_docs_settings' ) ) {
433 return new WP_Error( 'unauthorized_action', __( 'You don\'t have any rights for saving settings.', 'betterdocs' ) );
434 }
435
436 $_old_settings = $this->database->get( $this->base_key, $this->get_default() );
437 // @todo: sanitize the data before inject in DB.
438 $_normalized_settings = $this->get_normalized_values( $settings );
439 if ( $existing_plugins && isset( $_normalized_settings['migration_step'] ) && $_normalized_settings['migration_step'] == true ) {
440 betterdocs()->kbmigration->migrate();
441 }
442 $_settings = wp_parse_args( $_normalized_settings, $_old_settings );
443 $_saved = $this->database->save( $this->base_key, $_settings );
444
445 do_action_ref_array( 'betterdocs::settings::saved', [$_saved, $_settings, $_old_settings, &$this] );
446
447 return $_saved;
448 }
449
450 public function views( $hook ) {
451 return betterdocs()->views->get( 'admin/settings' );
452 }
453
454 public function save_default_settings() {
455 $_settings = $this->get_all();
456 return $this->database->save( $this->base_key, $_settings );
457 }
458
459 public function get_pages() {
460 $_pages = betterdocs()->query->get_posts( [
461 'post_type' => 'page',
462 'numberposts' => -1,
463 'post_status' => 'publish',
464 'posts_per_page' => -1
465 ] );
466
467 $__pages = [];
468
469 if ( ! empty( $_pages ) ) {
470 $__pages[0] = __( 'Select a Page', 'betterdocs' );
471 foreach ( $_pages->posts as $page ) {
472 $__pages[$page->ID] = esc_html( $page->post_title );
473 }
474 }
475
476 return $__pages;
477 }
478
479 public function settings_args() {
480 $wp_roles = $this->normalize_options( $this->get_roles() );
481
482 $settings = [
483 'id' => 'betterdocs_settings_metabox_wrapper',
484 'title' => __( 'betterdocs', 'betterdocs' ),
485 'object_types' => ['betterdocs'],
486 'context' => 'normal',
487 'priority' => 'high',
488 'show_header' => false,
489 'tabnumber' => false,
490 'is_pro_active' => betterdocs()->is_pro_active(),
491 'logoURL' => betterdocs()->assets->icon( 'betterdocs-icon.svg', true ),
492 'layout' => 'vertical',
493 'config' => [
494 'active' => 'tab-general',
495 'sidebar' => true,
496 'title' => false
497 ],
498 'submit' => [
499 'show' => true,
500 'label' => __( 'Save', 'betterdocs' ),
501 'loadingLabel' => __( 'Saving...', 'betterdocs' ),
502 'class' => 'save-settings',
503 'rules' => Rules::logicalRule( [
504 Rules::is( 'config.active', 'tab-design', true ),
505 Rules::is( 'config.active', 'tab-shortcodes', true ),
506 Rules::is( 'config.active', 'tab-instant-answer', true ),
507 Rules::is( 'config.active', 'tab-import-export', true )
508 ], 'and' )
509 ],
510 'values' => $this->get_all(),
511 'tabs' => apply_filters( 'betterdocs_settings_tabs', [
512 'tab-general' => apply_filters( 'betterdocs_settings_tab_general', [
513 'id' => 'tab-general',
514 'label' => __( 'General', 'betterdocs' ),
515 'classes' => 'tab-general',
516 'priority' => 10,
517 'fields' => [
518 'title-general' => [
519 'name' => 'title-general-tab',
520 'type' => 'section',
521 'label' => __( 'General Settings', 'betterdocs' ),
522 'priority' => 10,
523 'fields' => [
524 'multiple_kb' => apply_filters( 'betterdocs_multi_kb_settings', [
525 'name' => 'multiple_kb',
526 'type' => 'toggle',
527 'label' => __( 'Multiple Knowledge Base', 'betterdocs' ),
528 'enable_disable_text_active' => true,
529 'default' => '',
530 'priority' => 1,
531 'is_pro' => true
532 ] ),
533 'builtin_doc_page' => [
534 'name' => 'builtin_doc_page',
535 'type' => 'toggle',
536 'label' => __( 'Built-in Documentation Page', 'betterdocs' ),
537 'enable_disable_text_active' => true,
538 'default' => 1,
539 'priority' => 2,
540 'label_subtitle' => __( 'If you disable root slug for KB Archives, your individual knowledge base URL will be like this: https://example.com/knowledgebase-1', 'betterdocs' )
541 ],
542 'breadcrumb_doc_title' => [
543 'name' => 'breadcrumb_doc_title',
544 'type' => 'text',
545 'label' => __( 'Documentation Page Title', 'betterdocs' ),
546 'default' => 'Docs',
547 'priority' => 3
548 ],
549 'docs_slug' => [
550 'name' => 'docs_slug',
551 'type' => 'text',
552 'label' => __( 'BetterDocs Root Slug', 'betterdocs' ),
553 'default' => 'docs',
554 'priority' => 4,
555 'rules' => Rules::is( 'builtin_doc_page', true )
556 ],
557 'docs_page' => [
558 'name' => 'docs_page',
559 'label' => __( 'Docs Page', 'betterdocs' ),
560 'type' => 'select',
561 'default' => 0,
562 'priority' => 5,
563 'search' => true,
564 'options' => $this->normalize_options( $this->get_pages() ),
565 'label_subtitle' => __( 'You will need to insert BetterDocs Shortcode inside the page. This page will be used as docs permalink.', 'betterdocs' ),
566 'rules' => Rules::is( 'builtin_doc_page', false )
567 ],
568 'category_slug' => [
569 'name' => 'category_slug',
570 'type' => 'text',
571 'label' => __( 'Custom Category Slug', 'betterdocs' ),
572 'default' => 'docs-category',
573 'priority' => 6
574 ],
575 'tag_slug' => [
576 'name' => 'tag_slug',
577 'type' => 'text',
578 'label' => __( 'Custom Tag Slug', 'betterdocs' ),
579 'default' => 'docs-tag',
580 'priority' => 7
581 ],
582 'permalink_structure' => [
583 'name' => 'permalink_structure',
584 'type' => 'permalink_structure',
585 'label' => __( 'Single Docs Permalink', 'betterdocs' ),
586 'default' => PostType::permalink_structure(),
587 'priority' => 9,
588 'tags' => $this->normalize_options( [
589 '%doc_category%' => '%doc_category%',
590 '%knowledge_base%' => '%knowledge_base%'
591 ] ),
592 'label_subtitle' => __( 'Make sure to keep Docs Root Slug in the Single Docs Permalink. You are not able to keep it blank. You can use the available tags from below.', 'betterdocs' )
593 ],
594 'enable_faq_schema' => [
595 'name' => 'enable_faq_schema',
596 'type' => 'toggle',
597 'label' => __( 'FAQ Schema', 'betterdocs' ),
598 'enable_disable_text_active' => true,
599 'default' => '',
600 'priority' => 10
601 ],
602 'analytics_from' => [
603 'name' => 'analytics_from',
604 'type' => 'select',
605 'label' => __( 'Analytics From', 'betterdocs' ),
606 'options' => $this->normalize_options( [
607 'everyone' => __( 'Everyone', 'betterdocs' ),
608 'guests' => __( 'Guests Only', 'betterdocs' ),
609 'registered_users' => __( 'Registered Users Only', 'betterdocs' )
610 ] ),
611 'default' => 'everyone',
612 'priority' => 11,
613 'is_pro' => true
614 ],
615 'exclude_bot_analytics' => [
616 'name' => 'exclude_bot_analytics',
617 'type' => 'toggle',
618 'label' => __( 'Exclude Bot Analytics', 'betterdocs' ),
619 'enable_disable_text_active' => true,
620 'default' => true,
621 'priority' => 12,
622 'is_pro' => true
623 ]
624 ]
625 ]
626 ]
627 ] ),
628 'tab-layout' => apply_filters( 'betterdocs_settings_tab_layout', [
629 'id' => 'tab-layout',
630 'label' => __( 'Layout', 'betterdocs' ),
631 'classes' => 'tab-layout',
632 'priority' => 20,
633 'fields' => [
634 'title-layout' => [
635 'name' => 'title-layout-tab',
636 'type' => 'section',
637 'label' => __( 'Layout Settings', 'betterdocs' ),
638 'priority' => 20,
639 'fields' => [
640 'tab-sidebar-layout' => apply_filters( 'betterdocs_settings_tab_sidebar_layout', [
641 'id' => 'tab-sidebar-layout',
642 'name' => 'tab_sidebar_layout',
643 'label' => __( 'Layout Settings', 'betterdocs' ),
644 'classes' => 'tab-layout',
645 'type' => "tab",
646 'active' => "layout_documentation_page",
647 'completionTrack' => true,
648 'sidebar' => false,
649 'save' => false,
650 'title' => false,
651 'config' => [
652 'active' => 'layout_documentation_page',
653 'sidebar' => false,
654 'title' => false
655 ],
656 'submit' => [
657 'show' => false
658 ],
659 'step' => [
660 'show' => false
661 ],
662 'priority' => 20,
663 'fields' => [
664 'layout_documentation_page' => [
665 'id' => 'layout_documentation_page',
666 'name' => 'layout_documentation_page',
667 'type' => 'section',
668 'label' => __( 'Documentation Page', 'betterdocs' ),
669 'priority' => 1,
670 'fields' => [
671 'tab-nested-layout-1' => [
672 'id' => 'tab-nested-layout-1',
673 'name' => 'tab_nested_layout_1',
674 'label' => __( 'Documentation Page', 'betterdocs' ),
675 'classes' => 'tab-nested-layout',
676 'type' => "tab",
677 'active' => "layout_documentation_page_general",
678 'completionTrack' => true,
679 'sidebar' => false,
680 'save' => false,
681 'title' => false,
682 'config' => [
683 'active' => 'layout_documentation_page_general',
684 'sidebar' => false,
685 'title' => false
686 ],
687 'submit' => [
688 'show' => false
689 ],
690 'step' => [
691 'show' => false
692 ],
693 'priority' => 1,
694 'fields' => [
695 'layout_documentation_page_general' => [
696 'id' => 'layout_documentation_page_general',
697 'name' => 'layout_documentation_page_general',
698 'type' => 'section',
699 'label' => __( 'General', 'betterdocs' ),
700 'priority' => 1,
701 'fields' => [
702 'category_title_link' => [
703 'name' => 'category_title_link',
704 'type' => 'toggle',
705 'label' => __( 'Category Title Link', 'betterdocs' ),
706 'label_subtitle' => __( 'This setting is applicable for category grid layout', 'betterdocs' ),
707 'enable_disable_text_active' => true,
708 'default' => false,
709 'priority' => 0
710 ],
711 'masonry_layout' => [
712 'name' => 'masonry_layout',
713 'type' => 'toggle',
714 'label' => __( 'Masonry', 'betterdocs' ),
715 'enable_disable_text_active' => true,
716 'default' => 1,
717 'priority' => 1
718 ],
719 'nested_subcategory' => [
720 'name' => 'nested_subcategory',
721 'type' => 'toggle',
722 'label' => __( 'Nested Sub Category', 'betterdocs' ),
723 'enable_disable_text_active' => true,
724 'default' => '',
725 'priority' => 2
726 ],
727 'column_number' => [
728 'name' => 'column_number',
729 'type' => 'number',
730 'label' => __( 'Number Of Columns', 'betterdocs' ),
731 'default' => 3,
732 'priority' => 3
733 ],
734 'posts_number' => apply_filters( 'betterdocs_posts_number', [
735 'name' => 'posts_number',
736 'type' => 'number',
737 'label' => __( 'Number Of Docs', 'betterdocs' ),
738 'label_subtitle' => __( 'This setting is not applicable for handbook layout.', 'betterdocs' ),
739 'default' => 10,
740 'priority' => 4
741 ] ),
742 'post_count' => [
743 'name' => 'post_count',
744 'type' => 'toggle',
745 'label' => __( 'Doc Count', 'betterdocs' ),
746 'enable_disable_text_active' => true,
747 'default' => 1,
748 'priority' => 5
749 ],
750 'count_text' => [
751 'name' => 'count_text',
752 'type' => 'text',
753 'label' => __( 'Count Text', 'betterdocs' ),
754 'default' => __( 'docs', 'betterdocs' ),
755 'priority' => 6
756 ],
757 'count_text_singular' => [
758 'name' => 'count_text_singular',
759 'type' => 'text',
760 'label' => __( 'Count Text Singular', 'betterdocs' ),
761 'default' => __( 'doc', 'betterdocs' ),
762 'priority' => 7
763 ],
764 'exploremore_btn' => [
765 'name' => 'exploremore_btn',
766 'type' => 'toggle',
767 'label' => __( 'Explore More Button', 'betterdocs' ),
768 'enable_disable_text_active' => true,
769 'default' => true,
770 'priority' => 8
771 ],
772 'exploremore_btn_txt' => [
773 'name' => 'exploremore_btn_txt',
774 'type' => 'text',
775 'label' => __( 'Explore More Button Text', 'betterdocs' ),
776 'default' => __( 'Explore More', 'betterdocs' ),
777 'priority' => 9,
778 'rules' => Rules::is( 'exploremore_btn', true )
779 ],
780 'betterdocs_popular_docs_text' => [
781 'name' => 'betterdocs_popular_docs_text',
782 'type' => 'text',
783 'label' => __( 'Popular Docs Text', 'betterdocs' ),
784 'default' => __( 'Popular Docs', 'betterdocs' ),
785 'priority' => 10,
786 "is_pro" => true
787 ],
788 'betterdocs_popular_docs_number' => [
789 'name' => 'betterdocs_popular_docs_number',
790 'type' => 'number',
791 'label' => __( 'Popular Docs Number', 'betterdocs' ),
792 'default' => 10,
793 'priority' => 11,
794 "is_pro" => true
795 ]
796 ]
797 ],
798 'layout_documentation_page_search' => [
799 'id' => 'layout_documentation_page_search',
800 'name' => 'layout_documentation_page_search',
801 'type' => 'section',
802 'label' => __( 'Search', 'betterdocs' ),
803 'priority' => 2,
804 'fields' => [
805 'live_search' => [
806 'name' => 'live_search',
807 'type' => 'toggle',
808 'label' => __( 'Live Search', 'betterdocs' ),
809 'enable_disable_text_active' => true,
810 'default' => 1,
811 'priority' => 1
812 ],
813 'advance_search' => apply_filters( 'betterdocs_advance_search_settings', [
814 'name' => 'advance_search',
815 'type' => 'toggle',
816 'label' => __( 'Advanced Search', 'betterdocs' ),
817 'enable_disable_text_active' => true,
818 'default' => '',
819 'priority' => 2,
820 'is_pro' => true
821 ] ),
822 'child_category_exclude' => apply_filters( 'child_category_exclude', [
823 'name' => 'child_category_exclude',
824 'type' => 'toggle',
825 'label' => __( 'Category Search', 'betterdocs' ),
826 'enable_disable_text_active' => true,
827 'default' => '',
828 'priority' => 3,
829 'is_pro' => true
830 ] ),
831 'popular_keyword_limit' => apply_filters( 'betterdocs_popular_keyword_limit_settings', [
832 'name' => 'popular_keyword_limit',
833 'type' => 'number',
834 'label' => __( 'Minimum amount of Keywords Search', 'betterdocs' ),
835 'default' => 5,
836 'priority' => 4,
837 'is_pro' => true
838 ] ),
839 'search_letter_limit' => [
840 'name' => 'search_letter_limit',
841 'type' => 'number',
842 'label' => __( 'Minimum Character Limit For Search Result', 'betterdocs' ),
843 'priority' => 5,
844 'default' => 3
845 ],
846 'search_placeholder' => [
847 'name' => 'search_placeholder',
848 'type' => 'text',
849 'label' => __( 'Search Placeholder', 'betterdocs' ),
850 'default' => __( 'Search..', 'betterdocs' ),
851 'priority' => 6
852 ],
853 'search_button_text' => apply_filters( 'betterdocs_search_button_text', [
854 'name' => 'search_button_text',
855 'type' => 'text',
856 'label' => __( 'Search Button Text', 'betterdocs' ),
857 'priority' => 7,
858 'default' => __( 'Search', 'betterdocs' ),
859 'is_pro' => true
860 ] ),
861 'search_not_found_text' => [
862 'name' => 'search_not_found_text',
863 'type' => 'text',
864 'label' => __( 'Search Not Found Text', 'betterdocs' ),
865 'default' => 'Sorry, no docs were found.',
866 'priority' => 8
867 ],
868 'search_result_image' => [
869 'name' => 'search_result_image',
870 'type' => 'toggle',
871 'label' => __( 'Search Result Image', 'betterdocs' ),
872 'enable_disable_text_active' => true,
873 'default' => 1,
874 'priority' => 9
875 ],
876 'kb_based_search' => apply_filters( 'betterdocs_kb_based_search_settings', [
877 'name' => 'kb_based_search',
878 'type' => 'toggle',
879 'label' => __( 'KB Based Search', 'betterdocs' ),
880 'enable_disable_text_active' => true,
881 'default' => '',
882 'priority' => 10,
883 'is_pro' => true,
884 'rules' => Rules::is( 'multiple_kb', true )
885 ] )
886 ]
887 ],
888 'layout_documentation_page_order_by' => [
889 'id' => 'layout_documentation_page_order_by',
890 'name' => 'layout_documentation_page_order_by',
891 'type' => 'section',
892 'label' => __( 'Order By', 'betterdocs' ),
893 'priority' => 3,
894 'fields' => [
895 'terms_orderby' => [
896 'name' => 'terms_orderby',
897 'type' => 'select',
898 'label' => __( 'Terms Order By', 'betterdocs' ),
899 'default' => 'betterdocs_order',
900 'options' => $this->normalize_options(
901 apply_filters( 'betterdocs_terms_orderby_options', [
902 'none' => __( 'No order', 'betterdocs' ),
903 'name' => __( 'Name', 'betterdocs' ),
904 'slug' => __( 'Slug', 'betterdocs' ),
905 'term_group' => __( 'Term Group', 'betterdocs' ),
906 'term_id' => __( 'Term ID', 'betterdocs' ),
907 'id' => __( 'ID', 'betterdocs' ),
908 'description' => __( 'Description', 'betterdocs' ),
909 'parent' => __( 'Parent', 'betterdocs' ),
910 'betterdocs_order' => __( 'BetterDocs Order', 'betterdocs' )
911 ] )
912 ),
913 'priority' => 1
914 ],
915 'terms_order' => [
916 'name' => 'terms_order',
917 'type' => 'select',
918 'label' => __( 'Terms Order', 'betterdocs' ),
919 'default' => 'ASC',
920 'options' => $this->normalize_options( [
921 'ASC' => 'Ascending',
922 'DESC' => 'Descending'
923 ] ),
924 'priority' => 3
925 ],
926 'alphabetically_order_post' => [
927 'name' => 'alphabetically_order_post',
928 'type' => 'select',
929 'label' => __( 'Docs Order By', 'betterdocs' ),
930 'default' => 'betterdocs_order',
931 'options' => $this->normalize_options( [
932 'none' => __( 'No order', 'betterdocs' ),
933 'ID' => __( 'Docs ID', 'betterdocs' ),
934 'author' => __( 'Docs Author', 'betterdocs' ),
935 'title' => __( 'Title', 'betterdocs' ),
936 'date' => __( 'Date', 'betterdocs' ),
937 'modified' => __( 'Last Modified Date', 'betterdocs' ),
938 'parent' => __( 'Parent Id', 'betterdocs' ),
939 'rand' => __( 'Random', 'betterdocs' ),
940 'comment_count' => __( 'Comment Count', 'betterdocs' ),
941 'menu_order' => __( 'Menu Order', 'betterdocs' ),
942 'betterdocs_order' => __( 'BetterDocs Order', 'betterdocs' )
943 ] ),
944 'priority' => 4
945 ],
946 'docs_order' => [
947 'name' => 'docs_order',
948 'type' => 'select',
949 'label' => __( 'Docs Order', 'betterdocs' ),
950 'default' => 'ASC',
951 'options' => $this->normalize_options( [
952 'ASC' => 'Ascending',
953 'DESC' => 'Descending'
954 ] ),
955 'priority' => 5
956 ]
957 ]
958 ]
959 ]
960 ]
961 ]
962 ],
963 'layout_single_doc' => [
964 'id' => 'layout_single_doc',
965 'name' => 'layout_single_doc',
966 'type' => 'section',
967 'label' => __( 'Single Doc', 'betterdocs' ),
968 'priority' => 2,
969 'fields' => [
970 'tab-nested-layout-2' => [
971 'id' => 'tab-nested-layout-2',
972 'name' => 'tab_nested_layout_2',
973 'label' => __( 'Single Doc', 'betterdocs' ),
974 'classes' => 'tab-nested-layout',
975 'type' => "tab",
976 'active' => "layout_single_doc_general",
977 'completionTrack' => true,
978 'sidebar' => false,
979 'save' => false,
980 'title' => false,
981 'config' => [
982 'active' => 'layout_single_doc_general',
983 'sidebar' => false,
984 'title' => false
985 ],
986 'submit' => [
987 'show' => false
988 ],
989 'step' => [
990 'show' => false
991 ],
992 'priority' => 20,
993 'fields' => [
994 'layout_single_doc_general' => [
995 'id' => 'layout_single_doc_general',
996 'name' => 'layout_single_doc_general',
997 'type' => 'section',
998 'label' => __( 'General', 'betterdocs' ),
999 'priority' => 5,
1000 'fields' => [
1001 'enable_post_title' => [
1002 'name' => 'enable_post_title',
1003 'type' => 'toggle',
1004 'label' => __( 'Doc Title', 'betterdocs' ),
1005 'enable_disable_text_active' => true,
1006 'default' => 1,
1007 'priority' => 1
1008 ],
1009 'enable_sidebar_cat_list' => [
1010 'name' => 'enable_sidebar_cat_list',
1011 'type' => 'toggle',
1012 'label' => __( 'Sidebar Category List', 'betterdocs' ),
1013 'enable_disable_text_active' => true,
1014 'default' => 1,
1015 'priority' => 2
1016 ],
1017 'enable_print_icon' => [
1018 'name' => 'enable_print_icon',
1019 'type' => 'toggle',
1020 'label' => __( 'Print Icon', 'betterdocs' ),
1021 'enable_disable_text_active' => true,
1022 'default' => 1,
1023 'priority' => 3
1024 ],
1025 'enable_tags' => [
1026 'name' => 'enable_tags',
1027 'type' => 'toggle',
1028 'label' => __( 'Tags', 'betterdocs' ),
1029 'enable_disable_text_active' => true,
1030 'default' => 1,
1031 'priority' => 4
1032 ],
1033 'show_last_update_time' => [
1034 'name' => 'show_last_update_time',
1035 'type' => 'toggle',
1036 'label' => __( 'Last Update Time', 'betterdocs' ),
1037 'enable_disable_text_active' => true,
1038 'default' => 1,
1039 'priority' => 5
1040 ],
1041 'enable_navigation' => [
1042 'name' => 'enable_navigation',
1043 'type' => 'toggle',
1044 'label' => __( 'Navigation', 'betterdocs' ),
1045 'enable_disable_text_active' => true,
1046 'default' => 1,
1047 'priority' => 6
1048 ],
1049 'enable_comment' => [
1050 'name' => 'enable_comment',
1051 'type' => 'toggle',
1052 'label' => __( 'Comment', 'betterdocs' ),
1053 'enable_disable_text_active' => true,
1054 'default' => '',
1055 'priority' => 7
1056 ],
1057 'enable_credit' => [
1058 'name' => 'enable_credit',
1059 'type' => 'toggle',
1060 'label' => __( 'Credit', 'betterdocs' ),
1061 'enable_disable_text_active' => true,
1062 'default' => 1,
1063 'priority' => 8
1064 ]
1065 ]
1066 ],
1067 'layout_single_doc_TOC' => [
1068 'id' => 'layout_single_doc_TOC',
1069 'name' => 'layout_single_doc_TOC',
1070 'type' => 'section',
1071 'label' => __( 'TOC', 'betterdocs' ),
1072 'priority' => 5,
1073 'fields' => [
1074 'enable_toc' => [
1075 'name' => 'enable_toc',
1076 'type' => 'toggle',
1077 'label' => __( 'Table of Contents', 'betterdocs' ),
1078 'enable_disable_text_active' => true,
1079 'default' => 1,
1080 'priority' => 1
1081 ],
1082 'toc_title' => [
1083 'name' => 'toc_title',
1084 'type' => 'text',
1085 'label' => __( 'TOC Title', 'betterdocs' ),
1086 'default' => __( 'Table of Contents', 'betterdocs' ),
1087 'priority' => 2,
1088 'rules' => Rules::is( 'enable_toc', true )
1089
1090 ],
1091 'toc_hierarchy' => [
1092 'name' => 'toc_hierarchy',
1093 'type' => 'toggle',
1094 'label' => __( 'TOC Hierarchy', 'betterdocs' ),
1095 'enable_disable_text_active' => true,
1096 'default' => 1,
1097 'priority' => 3,
1098 'rules' => Rules::is( 'enable_toc', true )
1099 ],
1100 'toc_list_number' => [
1101 'name' => 'toc_list_number',
1102 'type' => 'toggle',
1103 'label' => __( 'TOC List Number', 'betterdocs' ),
1104 'enable_disable_text_active' => true,
1105 'default' => 1,
1106 'priority' => 4,
1107 'rules' => Rules::is( 'enable_toc', true )
1108 ],
1109 'toc_dynamic_title' => [
1110 'name' => 'toc_dynamic_title',
1111 'type' => 'toggle',
1112 'label' => __( 'Show TOC Title in Anchor Links', 'betterdocs' ),
1113 'enable_disable_text_active' => true,
1114 'default' => 0,
1115 'priority' => 5,
1116 'rules' => Rules::is( 'enable_toc', true )
1117 ],
1118 'enable_sticky_toc' => [
1119 'name' => 'enable_sticky_toc',
1120 'type' => 'toggle',
1121 'label' => __( 'Sticky TOC', 'betterdocs' ),
1122 'enable_disable_text_active' => true,
1123 'default' => 1,
1124 'priority' => 6,
1125 'rules' => Rules::is( 'enable_toc', true )
1126 ],
1127 'collapsible_toc_mobile' => [
1128 'name' => 'collapsible_toc_mobile',
1129 'type' => 'toggle',
1130 'label' => __( 'Collapsible TOC on small devices', 'betterdocs' ),
1131 'enable_disable_text_active' => true,
1132 'default' => '',
1133 'priority' => 7,
1134 'rules' => Rules::is( 'enable_toc', true )
1135 ],
1136 'title_link_ctc' => [
1137 'name' => 'title_link_ctc',
1138 'type' => 'toggle',
1139 'label' => __( 'Title Link Copy To Clipboard', 'betterdocs' ),
1140 'enable_disable_text_active' => true,
1141 'default' => 1,
1142 'priority' => 8
1143 ],
1144 'supported_heading_tag' => [
1145 'name' => 'supported_heading_tag',
1146 'label' => __( 'TOC Supported Heading Tag', 'betterdocs' ),
1147 'type' => 'checkbox-select',
1148 'multiple' => true,
1149 'priority' => 10,
1150 'default' => ['1', '2', '3', '4', '5', '6'],
1151 'options' => $this->normalize_options( [
1152 '1' => 'H1',
1153 '2' => 'H2',
1154 '3' => 'H3',
1155 '4' => 'H4',
1156 '5' => 'H5',
1157 '6' => 'H6'
1158 ] ),
1159 'priority' => 9,
1160 'rules' => Rules::is( 'enable_toc', true )
1161 ],
1162 'sticky_toc_offset' => [
1163 'name' => 'sticky_toc_offset',
1164 'type' => 'number',
1165 'label' => __( 'Content Offset', 'betterdocs' ),
1166 'default' => 100,
1167 'priority' => 10,
1168 'label_subtitle' => __( 'content offset from top on scroll.', 'betterdocs' ),
1169 'rules' => Rules::is( 'enable_toc', true )
1170 ]
1171 ]
1172 ],
1173 'layout_single_doc_breadcrumb' => [
1174 'id' => 'layout_single_doc_breadcrumb',
1175 'name' => 'layout_single_doc_breadcrumb',
1176 'type' => 'section',
1177 'label' => __( 'Breadcrumb', 'betterdocs' ),
1178 'priority' => 5,
1179 'fields' => [
1180 'enable_breadcrumb' => [
1181 'name' => 'enable_breadcrumb',
1182 'type' => 'toggle',
1183 'label' => __( 'Breadcrumb', 'betterdocs' ),
1184 'enable_disable_text_active' => true,
1185 'default' => 1,
1186 'priority' => 1
1187 ],
1188 'breadcrumb_home_text' => [
1189 'name' => 'breadcrumb_home_text',
1190 'type' => 'text',
1191 'label' => __( 'Breadcrumb Home Text', 'betterdocs' ),
1192 'default' => __( 'Home', 'betterdocs' ),
1193 'priority' => 2,
1194 'rules' => Rules::is( 'enable_breadcrumb', true )
1195 ],
1196 'breadcrumb_home_url' => [
1197 'name' => 'breadcrumb_home_url',
1198 'type' => 'text',
1199 'label' => __( 'Breadcrumb Home URL', 'betterdocs' ),
1200 'priority' => 3,
1201 'default' => get_home_url(),
1202 'rules' => Rules::is( 'enable_breadcrumb', true )
1203 ],
1204 'enable_breadcrumb_category' => [
1205 'name' => 'enable_breadcrumb_category',
1206 'type' => 'toggle',
1207 'label' => __( 'Category on Breadcrumb', 'betterdocs' ),
1208 'enable_disable_text_active' => true,
1209 'default' => 1,
1210 'priority' => 4,
1211 'rules' => Rules::is( 'enable_breadcrumb', true )
1212 ],
1213 'enable_breadcrumb_title' => [
1214 'name' => 'enable_breadcrumb_title',
1215 'type' => 'toggle',
1216 'label' => __( 'Title on Breadcrumb', 'betterdocs' ),
1217 'enable_disable_text_active' => true,
1218 'default' => 1,
1219 'priority' => 5,
1220 'rules' => Rules::is( 'enable_breadcrumb', true )
1221 ]
1222 ]
1223 ],
1224 'layout_single_doc_email_feedback' => [
1225 'id' => 'layout_single_doc_email_feedback',
1226 'name' => 'layout_single_doc_email_feedback',
1227 'type' => 'section',
1228 'label' => __( 'Email Feedback', 'betterdocs' ),
1229 'priority' => 5,
1230 'fields' => [
1231 'email_feedback' => [
1232 'name' => 'email_feedback',
1233 'type' => 'toggle',
1234 'label' => __( 'Email Feedback', 'betterdocs' ),
1235 'enable_disable_text_active' => true,
1236 'default' => 1,
1237 'priority' => 1
1238 ],
1239 'feedback_link_text' => [
1240 'name' => 'feedback_link_text',
1241 'type' => 'text',
1242 'label' => __( 'Feedback Link Text', 'betterdocs' ),
1243 'default' => __( 'Still stuck? How can we help?', 'betterdocs' ),
1244 'priority' => 2,
1245 'rules' => Rules::is( 'email_feedback', true )
1246 ],
1247 'feedback_form_title' => [
1248 'name' => 'feedback_form_title',
1249 'type' => 'text',
1250 'label' => __( 'Feedback Form Title', 'betterdocs' ),
1251 'default' => __( 'Still stuck? How can we help?', 'betterdocs' ),
1252 'priority' => 3,
1253 'rules' => Rules::is( 'email_feedback', true )
1254 ],
1255 'email_address' => [
1256 'name' => 'email_address',
1257 'type' => 'text',
1258 'label' => __( 'Email Address', 'betterdocs' ),
1259 'default' => get_option( 'admin_email' ),
1260 'priority' => 4,
1261 'label_subtitle' => __( 'The email address where the Feedback form will be sent', 'betterdocs' ),
1262 'rules' => Rules::is( 'email_feedback', true )
1263 ],
1264 'feedback_url' => [
1265 'name' => 'feedback_url',
1266 'type' => 'text',
1267 'label' => __( 'Feedback URL', 'betterdocs' ),
1268 'default' => '',
1269 'priority' => 5,
1270 'rules' => Rules::is( 'email_feedback', true )
1271 ]
1272 ]
1273 ]
1274 ]
1275 ]
1276 ]
1277 ],
1278 'layout_archive_page' => [
1279 'id' => 'layout_archive_page',
1280 'name' => 'layout_archive_page',
1281 'type' => 'section',
1282 'label' => __( 'Archive Page', 'betterdocs' ),
1283 'priority' => 3,
1284 'fields' => [
1285 'enable_archive_sidebar' => [
1286 'name' => 'enable_archive_sidebar',
1287 'type' => 'toggle',
1288 'label' => __( 'Sidebar Category List', 'betterdocs' ),
1289 'enable_disable_text_active' => true,
1290 'default' => 1,
1291 'priority' => 31
1292 ],
1293 'archive_nested_subcategory' => [
1294 'name' => 'archive_nested_subcategory',
1295 'type' => 'toggle',
1296 'label' => __( 'Nested Subcategory', 'betterdocs' ),
1297 'enable_disable_text_active' => true,
1298 'default' => 1,
1299 'priority' => 32
1300 ]
1301 ]
1302 ]
1303 ]
1304 ] )
1305 ]
1306 ]
1307 ]
1308 ] ),
1309 'tab-design' => apply_filters( 'betterdocs_settings_tab_design', [
1310 'id' => 'tab-design',
1311 'label' => __( 'Design', 'betterdocs' ),
1312 'priority' => 30,
1313 'fields' => [
1314 'title-design' => [
1315 'name' => 'title-design-tab',
1316 'type' => 'section',
1317 'label' => __( 'Design', 'betterdocs' ),
1318 'priority' => 30,
1319 'fields' => [
1320 'customizer_link' => [
1321 'name' => 'customizer_link',
1322 'type' => 'action',
1323 'action' => 'betterdocs_settings_customizer_link',
1324 'label' => __( 'Customize BetterDocs', 'betterdocs' ),
1325 'url' => $this->customizer_link(),
1326 'customizer_img' => betterdocs()->assets->icon( 'customizer/betterdocs-customize.png', true ),
1327 'priority' => 1
1328 ]
1329 ]
1330 ]
1331 ]
1332 ] ),
1333 'tab-shortcodes' => apply_filters( 'betterdocs_settings_tab_shortcodes', [
1334 'label' => __( 'Shortcodes', 'betterdocs' ),
1335 'id' => 'tab-shortcodes',
1336 'classes' => 'tab-shortcodes',
1337 'priority' => 40,
1338 'fields' => [
1339 'title-shortcodes' => [
1340 'name' => 'title-shortcodes-tab',
1341 'type' => 'section',
1342 'label' => __( 'Shortcodes', 'betterdocs' ),
1343 'priority' => 40,
1344 'searchable' => true,
1345 'searchPlaceholder' => __( 'Search for shortcode', 'betterdocs' ),
1346 'searchNotFoundMessage' => '<img src="' . betterdocs()->assets->icon( 'not-found.svg', true ) . '"/><p>' . __( 'No Shortcodes Found with these keywords', 'betterdocs' ) . '</p>',
1347 'fields' => apply_filters( 'betterdocs_shortcode_fields', [
1348 'search_form' => [
1349 'name' => 'search_form',
1350 'type' => 'copy-to-clipboard',
1351 'label' => __( 'Search Form', 'betterdocs' ),
1352 'default' => '[betterdocs_search_form]',
1353 'readOnly' => true,
1354 'priority' => 1,
1355 'description' => __( '[betterdocs_search_form placeholder="Search..." heading="Heading" subheading="Subheading" category_search="true" search_button="true" popular_search="true"]', 'betterdocs' ),
1356 'descriptionLabel' => __( 'Example with parameters:', 'betterdocs' ),
1357 'descriptionCopyable' => true
1358 ],
1359 'feedback_form' => [
1360 'name' => 'feedback_form',
1361 'type' => 'copy-to-clipboard',
1362 'label' => __( 'Feedback Form', 'betterdocs' ),
1363 'default' => '[betterdocs_feedback_form]',
1364 'readOnly' => true,
1365 'priority' => 2,
1366 'description' => __( '[betterdocs_feedback_form button_text="Send"]', 'betterdocs' ),
1367 'descriptionLabel' => __( 'Example with parameters:', 'betterdocs' ),
1368 'descriptionCopyable' => true
1369 ],
1370 'category_grid' => [
1371 'name' => 'category_grid',
1372 'type' => 'copy-to-clipboard',
1373 'label' => __( 'Category Grid- Layout 1', 'betterdocs' ),
1374 'default' => '[betterdocs_category_grid]',
1375 'readOnly' => true,
1376 'priority' => 3,
1377 'description' => __( '[betterdocs_category_grid post_counter="true" show_icon="true" masonry="true" column="3" posts_per_page="5" nested_subcategory="true" terms="term_ID, term_ID" terms_orderby="" terms_order="" multiple_knowledge_base="" kb_slug="" title_tag="h2" orderby="" order="" ]', 'betterdocs' ),
1378 'descriptionLabel' => __( 'Example with parameters:', 'betterdocs' ),
1379 'descriptionCopyable' => true
1380 ],
1381 'category_box' => [
1382 'name' => 'category_box',
1383 'type' => 'copy-to-clipboard',
1384 'label' => __( 'Category Box- Layout 2', 'betterdocs' ),
1385 'default' => '[betterdocs_category_box]',
1386 'readOnly' => true,
1387 'priority' => 4,
1388 'description' => __( '[betterdocs_category_box orderby="" column="" nested_subcategory="" terms="" terms_orderby="" show_icon="" kb_slug="" title_tag="h2" multiple_knowledge_base="false" border_bottom="false"]', 'betterdocs' ),
1389 'descriptionLabel' => __( 'Example with parameters:', 'betterdocs' ),
1390 'descriptionCopyable' => true
1391 ],
1392 'category_list' => [
1393 'name' => 'category_list',
1394 'type' => 'copy-to-clipboard',
1395 'label' => __( 'Category List', 'betterdocs' ),
1396 'default' => '[betterdocs_category_list]',
1397 'readOnly' => true,
1398 'priority' => 5,
1399 'description' => __( '[betterdocs_category_list orderby="" order="" posts_per_page="" nested_subcategory="" terms="" terms_orderby="" terms_order="" kb_slug="" multiple_knowledge_base="false" title_tag="h2"]', 'betterdocs' ),
1400 'descriptionLabel' => __( 'Example with parameters:', 'betterdocs' ),
1401 'descriptionCopyable' => true
1402 ],
1403 'faq_modern_layout' => [
1404 'name' => 'faq_modern_layout',
1405 'type' => 'copy-to-clipboard',
1406 'label' => __( 'FAQ Layout - 1', 'betterdocs' ),
1407 'default' => '[betterdocs_faq_list_modern]',
1408 'readOnly' => true,
1409 'priority' => 13,
1410 'description' => __( '[betterdocs_faq_list_modern groups="group_id" class="" group_exclude="group_id" faq_heading="Frequently Asked Questions"]', 'betterdocs' ),
1411 'descriptionLabel' => __( 'Example with parameters:', 'betterdocs' ),
1412 'descriptionCopyable' => true
1413 ],
1414 'faq_classic_layout' => [
1415 'name' => 'faq_classic_layout',
1416 'type' => 'copy-to-clipboard',
1417 'label' => __( 'FAQ Layout - 2', 'betterdocs' ),
1418 'default' => '[betterdocs_faq_list_classic]',
1419 'readOnly' => true,
1420 'priority' => 14,
1421 'description' => __( '[betterdocs_faq_list_classic groups="group_id" class="" group_exclude="group_id" faq_heading="Frequently Asked Questions"]', 'betterdocs' ),
1422 'descriptionLabel' => __( 'Example with parameters:', 'betterdocs' ),
1423 'descriptionCopyable' => true
1424 ]
1425 ] )
1426 ]
1427 ]
1428 ] ),
1429 'tab-advance-settings' => apply_filters( 'betterdocs_settings_tab_advance', [
1430 'id' => 'tab-advance-settings',
1431 'label' => __( 'Advanced Settings', 'betterdocs' ),
1432 'priority' => 50,
1433 'fields' => [
1434 'title-advance-settings' => [
1435 'name' => 'title-advance-settings-tab',
1436 'type' => 'section',
1437 'label' => __( 'Advanced Settings', 'betterdocs' ),
1438 'priority' => 50,
1439 'fields' => apply_filters( 'betterdocs_internal_kb_fields', [
1440 'article_roles' => [
1441 'name' => 'article_roles',
1442 'type' => 'checkbox-select',
1443 'label' => __( 'Who Can Write Docs?', 'betterdocs' ),
1444 'priority' => 1,
1445 'multiple' => true,
1446 'search' => true,
1447 'is_pro' => true,
1448 'default' => ['administrator'],
1449 'options' => $wp_roles
1450 ],
1451 'settings_roles' => [
1452 'name' => 'settings_roles',
1453 'type' => 'checkbox-select',
1454 'label' => __( 'Who Can Edit Settings?', 'betterdocs' ),
1455 'priority' => 2,
1456 'multiple' => true,
1457 'is_pro' => true,
1458 'search' => true,
1459 'default' => ['administrator'],
1460 'options' => $wp_roles
1461 ],
1462 'analytics_roles' => [
1463 'name' => 'analytics_roles',
1464 'type' => 'checkbox-select',
1465 'label' => __( 'Who Can Check Analytics?', 'betterdocs' ),
1466 'priority' => 3,
1467 'multiple' => true,
1468 'is_pro' => true,
1469 'search' => true,
1470 'default' => ['administrator'],
1471 'options' => $wp_roles
1472 ],
1473 'enable_content_restriction' => [
1474 'name' => 'enable_content_restriction',
1475 'type' => 'toggle',
1476 'is_pro' => true,
1477 'priority' => 4,
1478 'label' => __( 'Internal Knowledge Base', 'betterdocs' ),
1479 'enable_disable_text_active' => true,
1480 'default' => ['all']
1481 ],
1482 'content_visibility' => [
1483 'name' => 'content_visibility',
1484 'type' => 'checkbox-select',
1485 'label' => __( 'Restrict Access to', 'betterdocs' ),
1486 'label_subtitle' => __( 'Only selected User Roles will be able to view your Knowledge Base', 'betterdocs' ),
1487 'is_pro' => true,
1488 'priority' => 5,
1489 'multiple' => true,
1490 'search' => true,
1491 'default' => ['all'],
1492 'placeholder' => __( 'Select any', 'betterdocs' ),
1493 'options' => $this->normalize_options( array_merge( [
1494 'all' => __( 'All logged in users', 'betterdocs' )
1495 ], wp_roles()->role_names ) ),
1496 'rules' => Rules::is( 'enable_content_restriction', true ),
1497 'filterValue' => 'all'
1498 ],
1499 'restrict_template' => [
1500 'name' => 'restrict_template',
1501 'type' => 'checkbox-select',
1502 'label' => __( 'Restriction on Docs', 'betterdocs' ),
1503 'label_subtitle' => __( 'Selected Docs pages will be restricted', 'betterdocs' ),
1504 'is_pro' => true,
1505 'priority' => 6,
1506 'multiple' => true,
1507 'search' => true,
1508 'default' => ['all'],
1509 'placeholder' => __( 'Select any', 'betterdocs' ),
1510 'options' => $this->get_texanomy(),
1511 'rules' => Rules::is( 'enable_content_restriction', true ),
1512 'filterValue' => 'all'
1513 ],
1514 'restrict_category' => [
1515 'name' => 'restrict_category',
1516 'type' => 'checkbox-select',
1517 'label' => __( 'Restriction on Docs Categories', 'betterdocs' ),
1518 'label_subtitle' => __( 'Selected Docs categories will be restricted', 'betterdocs' ),
1519 'is_pro' => true,
1520 'priority' => 7,
1521 'multiple' => true,
1522 'search' => true,
1523 'default' => ['all'],
1524 'placeholder' => __( 'Select any', 'betterdocs' ),
1525 'options' => $this->get_terms( 'doc_category' ),
1526 'rules' => Rules::is( 'enable_content_restriction', true ),
1527 'filterValue' => 'all'
1528 ],
1529 'restricted_redirect_url' => [
1530 'name' => 'restricted_redirect_url',
1531 'type' => 'text',
1532 'label' => __( 'Redirect URL', 'betterdocs' ),
1533 'label_subtitle' => __( 'Set a custom URL to redirect users without permissions when they try to access internal knowledge base. By default, restricted content will redirect to the "404 not found" page', 'betterdocs' ),
1534 'default' => '',
1535 'placeholder' => 'https://',
1536 'is_pro' => true,
1537 'priority' => 9,
1538 'rules' => Rules::is( 'enable_content_restriction', true )
1539 ]
1540 ] )
1541 ]
1542 ]
1543 ] ),
1544 'tab-email-reporting' => apply_filters( 'betterdocs_settings_tab_email_reporting', [
1545 'id' => 'tab-email-reporting',
1546 'label' => __( 'Email Reporting', 'betterdocs' ),
1547 'priority' => 60,
1548 'fields' => [
1549 'title-email-reporting' => [
1550 'name' => 'title-email-reporting-tab',
1551 'type' => 'section',
1552 'label' => __( 'Email Reporting', 'betterdocs' ),
1553 'priority' => 60,
1554 'fields' => [
1555 'enable_reporting' => [
1556 'name' => 'enable_reporting',
1557 'label' => __( 'Email Reporting', 'betterdocs' ),
1558 'enable_disable_text_active' => true,
1559 'type' => 'toggle',
1560 'priority' => 1,
1561 'default' => 0
1562 ],
1563 'reporting_frequency' => apply_filters( 'betterdocs_reporting_frequency_settings', [
1564 'name' => 'reporting_frequency',
1565 'type' => 'select',
1566 'label' => __( 'Reporting Frequency', 'betterdocs' ),
1567 'default' => 'betterdocs_weekly',
1568 'priority' => 2,
1569 'is_pro' => true,
1570 'options' => $this->normalize_options( [
1571 'betterdocs_daily' => __( 'Once Daily', 'betterdocs' ),
1572 'betterdocs_weekly' => __( 'Once Weekly', 'betterdocs' ),
1573 'betterdocs_monthly' => __( 'Once Monthly', 'betterdocs' )
1574 ] ),
1575 'rules' => Rules::is( 'enable_reporting', true )
1576 ] ),
1577 'reporting_day' => [
1578 'name' => 'reporting_day',
1579 'type' => 'select',
1580 'label' => __( 'Reporting Day', 'betterdocs' ),
1581 'default' => 'monday',
1582 'rules' => Rules::logicalRule( [
1583 Rules::is( 'enable_reporting', true ),
1584 Rules::is( 'reporting_frequency', 'betterdocs_weekly' )
1585 ], 'and' ),
1586 'priority' => 3,
1587 'options' => $this->normalize_options( [
1588 'sunday' => __( 'Sunday', 'betterdocs' ),
1589 'monday' => __( 'Monday', 'betterdocs' ),
1590 'tuesday' => __( 'Tuesday', 'betterdocs' ),
1591 'wednesday' => __( 'Wednesday', 'betterdocs' ),
1592 'thursday' => __( 'Thursday', 'betterdocs' ),
1593 'friday' => __( 'Friday', 'betterdocs' ),
1594 'saturday' => __( 'Saturday', 'betterdocs' )
1595 ] ),
1596 'label_subtitle' => __( 'This is only applicable for the “Weekly” report', 'betterdocs' )
1597 ],
1598 'select_reporting_data' => apply_filters( 'betterdocs_select_reporting_data_settings', [
1599 'name' => 'select_reporting_data',
1600 'type' => 'checkbox-select',
1601 'label' => __( 'Select Reporting Data', 'betterdocs' ),
1602 'priority' => 4,
1603 'multiple' => true,
1604 'options' => $this->normalize_options( [
1605 'overview' => 'Overview',
1606 'top-docs' => 'Top Docs',
1607 'most-search' => 'Most Searched Keywords'
1608 ] ),
1609 'default' => ['overview', 'top-docs', 'most-search'],
1610 'is_pro' => true,
1611 'rules' => Rules::is( 'enable_reporting', true )
1612 ] ),
1613 'reporting_email' => [
1614 'name' => 'reporting_email',
1615 'type' => 'text',
1616 'label' => __( 'Reporting Email', 'betterdocs' ),
1617 'default' => get_option( 'admin_email' ),
1618 'priority' => 5,
1619 'rules' => Rules::is( 'enable_reporting', true )
1620 ],
1621 'reporting_subject' => apply_filters( 'betterdocs_reporting_subject_settings', [
1622 'name' => 'reporting_subject',
1623 'type' => 'textarea',
1624 'label' => __( 'Reporting Email Subject', 'betterdocs' ),
1625 'default' => wp_sprintf( __( 'Your Documentation Performance of %s Website', 'betterdocs' ), get_bloginfo( 'name' ) ),
1626 'priority' => 6,
1627 'is_pro' => true,
1628 'rules' => Rules::is( 'enable_reporting', true )
1629 ] ),
1630 'test_report' => [
1631 'name' => 'test_report',
1632 'label' => __( 'Reporting Test', 'betterdocs' ),
1633 'text' => __( 'Test Report', 'betterdocs' ),
1634 'type' => 'button',
1635 'priority' => 7,
1636 'rules' => Rules::is( 'enable_reporting', true ),
1637 'ajax' => [
1638 'on' => 'click',
1639 'api' => '/betterdocs/v1/reporting-test',
1640 'data' => [
1641 'enable_reporting' => '@enable_reporting',
1642 'select_reporting_data' => '@select_reporting_data',
1643 'reporting_subject' => '@reporting_subject',
1644 'reporting_email' => '@reporting_email',
1645 'reporting_day' => '@reporting_day',
1646 'reporting_frequency' => '@reporting_frequency'
1647 ],
1648 'swal' => [
1649 'text' => __( 'Successfully Sent a Test Report in Your Email.', 'betterdocs' ),
1650 'icon' => 'success',
1651 'autoClose' => 2000
1652 ]
1653 ]
1654 ]
1655 ]
1656 ]
1657 ]
1658 ] ),
1659 'tab-instant-answer' => apply_filters( 'betterdocs_settings_tab_instant_answer', [
1660 'id' => 'tab-instant-answer',
1661 'name' => 'tab-instant-answer',
1662 'type' => 'section',
1663 'label' => __( 'Instant Answer', 'betterdocs' ),
1664 'save' => false,
1665 'priority' => 70,
1666 'fields' => [
1667 'title-instant-answer' => [
1668 'name' => 'title-instant-answer-tab',
1669 'type' => 'section',
1670 'label' => __( 'Instant Answer', 'betterdocs' ),
1671 'priority' => 80,
1672 'save' => false,
1673 'showSubmit' => false,
1674 'fields' => apply_filters( 'betterdocs_instant_answer_fields', [
1675 'enable_disable_wrapper' => [
1676 'name' => 'enable_disable_wrapper',
1677 'type' => 'section',
1678 'priority' => 0,
1679 'save' => false,
1680 'fields' => [
1681 'enable_disable' => [
1682 'name' => 'enable_disable',
1683 'type' => 'toggle',
1684 'priority' => 100,
1685 'description' => __( 'Enable Instant Answer', 'betterdocs' ),
1686 'enable_disable_text_active' => false,
1687 'default' => true,
1688 'is_pro' => true
1689 ]
1690 ]
1691 ]
1692 ] )
1693 ]
1694 ]
1695 ] ),
1696 'tab-import-export' => apply_filters( 'betterdocs_settings_tab_import_export', [
1697 'id' => 'tab-import-export',
1698 'name' => 'tab-import-export',
1699 'classes' => 'tab-import-export',
1700 'label' => __( 'Import / Export', 'betterdocs' ),
1701 'priority' => 80,
1702 'fields' => [
1703 'sections-import-export' => [
1704 'name' => 'sections-import-export',
1705 'type' => 'section',
1706 'label' => __( 'Import / Export', 'betterdocs' ),
1707 'priority' => 30,
1708 'fields' => [
1709 'all-tab-import-export' => [
1710 'id' => 'all-tab-import-export',
1711 'name' => 'all-tab-import-export',
1712 'label' => __( 'Import Export Settings', 'betterdocs' ),
1713 'classes' => 'tab-layout',
1714 'type' => "tab",
1715 'active' => "import",
1716 'completionTrack' => true,
1717 'sidebar' => false,
1718 'save' => false,
1719 'title' => false,
1720 'config' => [
1721 'active' => 'import',
1722 'sidebar' => false,
1723 'title' => false
1724 ],
1725 'submit' => [
1726 'show' => false
1727 ],
1728 'step' => [
1729 'show' => false
1730 ],
1731 'priority' => 20,
1732 'fields' => [
1733 'import' => [
1734 'id' => 'import',
1735 'name' => 'import',
1736 'type' => 'section',
1737 'label' => __( 'Import', 'betterdocs' ),
1738 'priority' => 1,
1739 'fields' => [
1740 'import_tab_nested' => [
1741 'id' => 'import_tab_nested',
1742 'name' => 'import_tab_nested',
1743 'label' => __( 'Import', 'betterdocs' ),
1744 'classes' => 'tab-nested-layout',
1745 'type' => "tab",
1746 'active' => "import_docs_nested",
1747 'completionTrack' => true,
1748 'sidebar' => false,
1749 'save' => false,
1750 'title' => false,
1751 'config' => [
1752 'active' => 'import_docs_nested',
1753 'sidebar' => false,
1754 'title' => false
1755 ],
1756 'submit' => [
1757 'show' => false
1758 ],
1759 'step' => [
1760 'show' => false
1761 ],
1762 'priority' => 1,
1763 'fields' => [
1764 'import_docs_nested' => [
1765 'id' => 'import_docs_nested',
1766 'name' => 'import_docs_nested',
1767 'type' => 'section',
1768 'label' => __( 'Import Docs', 'betterdocs' ),
1769 'priority' => 1,
1770 'fields' => [
1771 'import_docs' => [
1772 'name' => 'import_docs',
1773 'type' => 'importerupload',
1774 'label' => __('Import Docs', 'betterdocs'),
1775 'label_subtitle' => wp_sprintf(
1776 __( 'To import your Docs, please upload the .xml / .csv file here. <a href="%1$s">Download sample csv file</a>', 'betterdocs' ),
1777 betterdocs()->assets->icon( 'BetterDocs-sample-data.csv', true )
1778 ),
1779 'text' => [
1780 'normal' => __('Proceed', 'betterdocs'),
1781 'saved' => __('Proceed', 'betterdocs'),
1782 'loading' => __('Importing...', 'betterdocs'),
1783 'exists_notice' => __('It seems like documentations with same slugs already exist on your website. What would you like to do?', 'betterdocs'),
1784 ],
1785 'ajax' => [
1786 'on' => 'click',
1787 'api' => '/betterdocs/v1/import-docs',
1788 'swal' => [
1789 'text' => __( 'Import completed successfully.', 'betterdocs' ),
1790 'icon' => 'success',
1791 'autoClose' => 2000
1792 ]
1793 ],
1794 'file_type' => '.xml, .csv',
1795 'priority' => 1
1796 ]
1797 ]
1798 ],
1799
1800 'import_settings_nested' => [
1801 'id' => 'import_settings_nested',
1802 'name' => 'import_settings_nested',
1803 'type' => 'section',
1804 'label' => __( 'Import Settings', 'betterdocs' ),
1805 'priority' => 1,
1806 'fields' => [
1807 'settings_importer' => [
1808 'name' => 'settings_importer',
1809 'type' => 'settingsuploader',
1810 'label' => __( 'Import Settings', 'notificationx' ),
1811 'label_subtitle' => __( 'To import BetterDocs Settings, please upload BetterDocs settings you have exported from another website in .json format', 'betterdocs' ),
1812 'reset' => __( 'Change', 'notificationx' ),
1813 'priority' => 1
1814 ],
1815 'import_settings' => [
1816 'name' => 'import_settings',
1817 'type' => 'button',
1818 'rules' => Rules::is( 'settings_importer', null, true ),
1819 'text' => [
1820 'normal' => __( 'Proceed', 'betterdocs' ),
1821 'saved' => __( 'Proceed', 'betterdocs' ),
1822 'loading' => __( 'Importing...', 'betterdocs' )
1823 ],
1824 'ajax' => [
1825 'on' => 'click',
1826 'api' => '/betterdocs/v1/import-settings',
1827 'data' => [
1828 'settings' => '@settings_importer'
1829 ],
1830 'swal' => [
1831 'text' => __( 'Import completed successfully.', 'betterdocs' ),
1832 'icon' => 'success',
1833 'autoClose' => 1000
1834 ],
1835 'reload' => true
1836 ],
1837 'priority' => 2
1838 ]
1839 ]
1840 ]
1841 ]
1842 ]
1843 ]
1844 ],
1845 'export' => [
1846 'id' => 'export',
1847 'name' => 'export',
1848 'type' => 'section',
1849 'label' => __( 'Export', 'betterdocs' ),
1850 'priority' => 1,
1851 'fields' => [
1852 'export_tab_nested' => [
1853 'id' => 'export_tab_nested',
1854 'name' => 'export_tab_nested',
1855 'label' => __( 'Export', 'betterdocs' ),
1856 'classes' => 'tab-nested-layout',
1857 'type' => "tab",
1858 'active' => "export_docs_nested",
1859 'completionTrack' => true,
1860 'sidebar' => false,
1861 'save' => false,
1862 'title' => false,
1863 'config' => [
1864 'active' => 'export_docs_nested',
1865 'sidebar' => false,
1866 'title' => false
1867 ],
1868 'submit' => [
1869 'show' => false
1870 ],
1871 'step' => [
1872 'show' => false
1873 ],
1874 'priority' => 1,
1875 'fields' => [
1876 'export_docs_nested' => [
1877 'id' => 'export_docs_nested',
1878 'name' => 'export_docs_nested',
1879 'type' => 'section',
1880 'label' => __( 'Export Docs', 'betterdocs' ),
1881 'priority' => 1,
1882 'fields' => apply_filters( 'betterdocs_export_fields', [
1883 'export_type' => [
1884 'name' => 'export_type',
1885 'label' => __( 'Select Docs Type', 'betterdocs' ),
1886 'label_subtitle' => __( 'Choose an export type: All Docs, a specific Knowledge Base, or a Doc Category', 'betterdocs' ),
1887 'type' => 'select',
1888 'default' => 'docs',
1889 'priority' => 3,
1890 'search' => true,
1891 'options' => $this->normalize_options(
1892 apply_filters( 'betterdocs_export_type_options', [
1893 'docs' => __( 'Docs', 'betterdocs' ),
1894 'doc_category' => __( 'Docs Category', 'betterdocs' )
1895 ] )
1896 )
1897 ],
1898 'export_docs' => [
1899 'name' => 'export_docs',
1900 'type' => 'checkbox-select',
1901 'label' => __( 'Select Docs', 'betterdocs' ),
1902 'label_subtitle' => __( 'Selected docs will be included in the export.', 'betterdocs' ),
1903 'priority' => 4,
1904 'multiple' => true,
1905 'search' => true,
1906 'default' => ['all'],
1907 'placeholder' => __( 'Select any', 'betterdocs' ),
1908 'options' => array_merge( [['value' => 'all', 'label' => 'All']], $this->docs() ),
1909 'filterValue' => 'all',
1910 'rules' => Rules::is( 'export_type', 'docs' )
1911 ],
1912 'export_categories' => [
1913 'name' => 'export_categories',
1914 'type' => 'checkbox-select',
1915 'label' => __( 'Select Categories', 'betterdocs' ),
1916 'label_subtitle' => __( 'Selected categories and its docs will be included in the export.', 'betterdocs' ),
1917 'priority' => 6,
1918 'multiple' => true,
1919 'search' => true,
1920 'default' => ['all'],
1921 'placeholder' => __( 'Select any', 'betterdocs' ),
1922 'options' => $this->get_terms( 'doc_category' ),
1923 'filterValue' => 'all',
1924 'rules' => Rules::is( 'export_type', 'doc_category' )
1925 ],
1926 'file_type' => [
1927 'name' => 'file_type',
1928 'label' => __( 'Select File Type', 'betterdocs' ),
1929 'label_subtitle' => __( 'Choose a file type', 'betterdocs' ),
1930 'type' => 'select',
1931 'default' => 'xml',
1932 'priority' => 7,
1933 'search' => true,
1934 'options' => $this->normalize_options(
1935 apply_filters( 'betterdocs_export_file_type_options', [
1936 'xml' => __( '.xml', 'betterdocs' ),
1937 'csv' => __( '.csv', 'betterdocs' )
1938 ] )
1939 )
1940 ],
1941 'export_docs_btn' => [
1942 'name' => 'export_docs_btn',
1943 'text' => [
1944 'normal' => __( 'Proceed', 'betterdocs' ),
1945 'saved' => __( 'Proceed', 'betterdocs' ),
1946 'loading' => __( 'Exporting...', 'betterdocs' )
1947 ],
1948 'type' => 'button',
1949 'priority' => 8,
1950 'ajax' => [
1951 'on' => 'click',
1952 'api' => '/betterdocs/v1/export-docs',
1953 'data' => [
1954 'export_type' => '@export_type',
1955 'export_docs' => '@export_docs',
1956 'export_kbs' => '@export_kbs',
1957 'export_categories' => '@export_categories',
1958 'file_type' => '@file_type'
1959 ],
1960 'swal' => [
1961 'text' => __( 'Exported Successfully.', 'betterdocs' ),
1962 'icon' => 'success',
1963 'autoClose' => 2000
1964 ]
1965 ]
1966 ]
1967 ] )
1968 ],
1969
1970 'export_settings_nested' => [
1971 'id' => 'export_settings_nested',
1972 'name' => 'export_settings_nested',
1973 'type' => 'section',
1974 'label' => __( 'Export Settings', 'betterdocs' ),
1975 'priority' => 1,
1976 'fields' => [
1977 'export_settings' => [
1978 'name' => 'export_settings',
1979 'label' => __( 'Export Settings', 'betterdocs' ),
1980 'label_subtitle' => __( 'Simply click on “Export Settings” button to download your BetterDocs settings in .json format', 'betterdocs' ),
1981 'text' => [
1982 'normal' => __( 'Export Settings', 'betterdocs' ),
1983 'saved' => __( 'Export Settings', 'betterdocs' ),
1984 'loading' => __( 'Exporting...', 'betterdocs' )
1985 ],
1986 'type' => 'button',
1987 'priority' => 8,
1988 'ajax' => [
1989 'on' => 'click',
1990 'api' => '/betterdocs/v1/export-settings',
1991 'data' => [
1992 'betterdocs_settings' => get_option( 'betterdocs_settings' )
1993 ],
1994 'swal' => [
1995 'text' => __( 'File downloaded successfully.', 'betterdocs' ),
1996 'icon' => 'success',
1997 'autoClose' => 2000
1998 ]
1999 ]
2000 ]
2001 ]
2002 ]
2003 ]
2004 ]
2005 ]
2006 ]
2007 ]
2008 ]
2009 ]
2010 ]
2011 ]
2012 ] ),
2013 'tab-ai-autowrite' => [
2014 'id' => 'tab-ai-autowrite',
2015 'name' => 'tab-ai-autowrite',
2016 'type' => 'section',
2017 'label' => __( 'Write with AI', 'betterdocs' ),
2018 'priority' => 75,
2019 'fields' => [
2020 'title-ai-autowrite' => apply_filters( 'betterdocs_settings_ai_autowrite_fields', [
2021 'name' => 'title-ai-autowrite-tab',
2022 'type' => 'section',
2023 'label' => __( 'Write with AI', 'betterdocs' ),
2024 'priority' => 60,
2025 'fields' => [
2026 'enable_write_with_ai' => [
2027 'name' => 'enable_write_with_ai',
2028 'type' => 'toggle',
2029 'priority' => 0,
2030 'label' => __( 'Write Docs with AI', 'betterdocs' ),
2031 'label_subtitle' => __( 'Generate AI based Documentation in your Gutenberg Editor', 'betterdocs' ),
2032 'enable_disable_text_active' => true,
2033 'default' => true
2034 ],
2035 'enable_faq_write_with_ai' => [
2036 'name' => 'enable_faq_write_with_ai',
2037 'type' => 'toggle',
2038 'priority' => 5,
2039 'label' => __( 'Write FAQ with AI', 'betterdocs' ),
2040 'label_subtitle' => __( 'Generate AI based FAQ in your Editor', 'betterdocs' ),
2041 'enable_disable_text_active' => true,
2042 'default' => true
2043 ],
2044 'ai_autowrite_api_key' => [
2045 'name' => 'ai_autowrite_api_key',
2046 'type' => 'text',
2047 'label' => __('API Key', 'betterdocs'),
2048 'label_subtitle' => __('Check out this <a target="_blank" href="'.esc_url('https://betterdocs.co/docs/write-with-ai/').'">documentation</a> to find out to generate your OpenAI API Key', 'betterdocs'),
2049 'default' => '',
2050 'priority' =>10,
2051 ],
2052 'ai_autowrite_max_token' => [
2053 'name' => 'ai_autowrite_max_token',
2054 'type' => 'number',
2055 'label' => __('Set Max Tokens', 'betterdocs'),
2056 'label_subtitle' => __('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="'.esc_url('https://platform.openai.com/account/limits').'">link</a>.', 'betterdocs'),
2057 'default' => 1000,
2058 'priority' => 15,
2059 ],
2060 'ai_autowrite_max_token' => [
2061 'name' => 'ai_autowrite_max_token',
2062 'type' => 'number',
2063 'label' => __( 'Set Max Tokens', 'betterdocs' ),
2064 'label_subtitle' => __( '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="' . esc_url( 'https://platform.openai.com/account/limits' ) . '">link</a>.', 'betterdocs' ),
2065 'default' => 1500,
2066 'priority' => 15
2067 ]
2068 ]
2069 ] )
2070 ]
2071 ]
2072 ] )
2073 ];
2074
2075 return apply_filters( 'betterdocs_settings_args', $settings );
2076 }
2077
2078 public function normalize_options( $options ) {
2079 return GlobalFields::normalize_fields( $options );
2080 }
2081
2082 public function get_texanomy() {
2083 $docs_tax = $this->database->get_cache( 'betterdocs::settings::taxonomies' );
2084
2085 if ( $docs_tax ) {
2086 return $docs_tax;
2087 }
2088
2089 $taxonomies = get_taxonomies( [
2090 'object_type' => ['docs']
2091 ], 'objects' );
2092
2093 $docs_tax = [
2094 'all' => 'All Docs Archive',
2095 'docs' => 'Docs Page'
2096 ];
2097 foreach ( $taxonomies as $key => $value ) {
2098 $docs_tax[$key] = $value->label;
2099 }
2100 unset( $docs_tax['doc_tag'] );
2101
2102 $docs_tax = $this->normalize_options( $docs_tax );
2103 if ( count( $docs_tax ) > 2 ) {
2104 $this->database->set_cache( 'betterdocs::settings::taxonomies', $docs_tax );
2105 }
2106
2107 return $docs_tax;
2108 }
2109
2110 public function get_terms( $taxonomy ) {
2111 $_cache_key = 'betterdocs::settings::terms::' . trim( $taxonomy );
2112 $docs_tax = $this->database->get_cache( $_cache_key );
2113
2114 if ( $docs_tax ) {
2115 return $docs_tax;
2116 }
2117
2118 $get_terms = get_terms( [
2119 'taxonomy' => $taxonomy,
2120 'hide_empty' => false
2121 ] );
2122
2123 $terms = [
2124 'all' => 'All'
2125 ];
2126
2127 if ( ! empty( $get_terms ) && ! is_wp_error( $get_terms ) ) {
2128 foreach ( $get_terms as $value ) {
2129 if ( isset( $value->slug ) && isset( $value->name ) ) {
2130 $terms[$value->slug] = $value->name;
2131 }
2132 }
2133 }
2134
2135 $terms = $this->normalize_options( $terms );
2136 if ( count( $terms ) > 1 ) {
2137 $this->database->set_cache( $_cache_key, $terms );
2138 }
2139
2140 return $terms;
2141 }
2142
2143 /**
2144 * Get all docs
2145 */
2146 public function docs() {
2147 $docs = $this->database->get_cache( 'betterdocs::settings::all_docs' );
2148
2149 if ( $docs ) {
2150 return $docs;
2151 }
2152
2153 $docs = [];
2154
2155 $_docs = get_posts( [
2156 'post_type' => 'docs',
2157 'numberposts' => -1,
2158 'posts_per_page' => -1
2159 ] );
2160
2161 if ( ! empty( $_docs ) ) {
2162 foreach ( $_docs as $doc ) {
2163 $docs[$doc->ID] = betterdocs()->template_helper->kses( $doc->post_title );
2164 }
2165 $docs = GlobalFields::normalize_fields( $docs );
2166 $this->database->set_cache( 'betterdocs::settings::all_docs', $docs );
2167 }
2168
2169 return $docs;
2170 }
2171
2172 public function hide_roles_management( $tabData = [] ) {
2173 global $current_user;
2174
2175 if ( $current_user instanceof WP_User && ! in_array( 'administrator', $current_user->roles ) ) {
2176 unset( $tabData['fields']['title-advance-settings']['fields']['article_roles'] );
2177 unset( $tabData['fields']['title-advance-settings']['fields']['settings_roles'] );
2178 unset( $tabData['fields']['title-advance-settings']['fields']['analytics_roles'] );
2179 }
2180
2181 return $tabData;
2182 }
2183 }
2184