You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Effortlessly build a comprehensive knowledge base for unlimited products on your WordPress site and elevate your customer support experience.
19
+
Effortlessly create a powerful, multi-product knowledge base. Boost your support, reduce tickets, scale your documentation and make customers happy!
20
20
21
21
## Description
22
22
23
-
[Knowledge Base](https://webberzone.com/plugins/knowledgebase/)is an easy-to-use WordPress plugin that allows you to create a knowledge base / FAQ section on your site.
23
+
[Knowledge Base](https://webberzone.com/plugins/knowledgebase/)makes building a knowledge base or FAQ for your WordPress site easy, fast, and scalable.
24
24
25
-
You can use it to create a single or multi-product knowledge base with little effort.
25
+
🎯 Perfect for:
26
+
✅ Multi-product companies
27
+
✅ SaaS platforms
28
+
✅ Ecommerce support centres
29
+
✅ Documentation hubs
26
30
27
-
The plugin was born after I tried several free plugins and themes that didn't fit my purpose. It's designed to be very easy to install and use out of the box.
You can view a [live demo of my knowledge base](https://webberzone.com/support/knowledgebase/).
30
-
31
-
### Terminology
33
+
### Main features
32
34
33
-
*__Articles__: A custom post type `wz_knowledgebase` is used to store all the knowledge base articles
34
-
*__Sections__: A custom taxonomy ( `kbcategory` ) used to create the knowledge base. You will need *at least one category* to display the knowledge base. Add these categories under *Knowledge Base > Sections*
35
-
*__Tags__: Additionally you can use tags ( `kbtags` ) can also be used for each knowledge base article.
35
+
🚀 Unlimited Knowledge Bases — Support as many products as you like, with unlimited sections and sub-sections.
36
+
🎨 Beautiful, Responsive Layouts — Ships with clean templates powered by the Responsive Grid System.
37
+
🔗 Customisable Permalinks — View your KB at /knowledgebase/ by default or change it easily.
38
+
✨ Shortcodes + Gutenberg Blocks — Add KB listings anywhere using [knowledgebase] or use the Knowledge Base block.
39
+
🧭 Built-in Breadcrumbs — Improve UX and SEO with breadcrumb navigation.
40
+
🧩 Widgets Included — WZKB Articles, WZKB Sections, and WZKB Breadcrumbs widgets.
41
+
⚡ Built-in Caching — Speed up your Knowledge Base without extra plugins.
36
42
37
-
### Main features
43
+
### Key Concepts
38
44
39
-
* Supports unlimited knowledge bases using different sections with unlimited nested levels
40
-
* Inbuilt styles that display the Knowledge Base beautifully and are fully responsive - Uses the [Responsive Grid System](http://www.responsivegridsystem.com/)
41
-
* Customizable permalinks: Archives are enabled so your knowledge base can be viewed automatically at `/knowledgebase/` upon activation. You can change this on the Settings page
42
-
* Shortcode: `[knowledgebase]` will allow you to display the knowledge base on any page you choose. For other shortcodes, check the FAQ
43
-
* Gutenberg block: You can display the knowledge base using a block. Find it by typing `kb` or `knowledge base` when adding a new block
44
-
* Breadcrumbs: Default templates include breadcrumbs. Alternatively, use the function or shortcode to display this where you want
45
-
* Widgets: WZKB Articles, WZKB Sections and WZKB Breadcrumbs
46
-
* Inbuilt cache to speed up the display of your knowledge base articles
45
+
*__Articles:__ Custom post type `wz_knowledgebase` — your FAQs, how-to guides, and documentation.
46
+
*__Products:__ Custom taxonomy `wzkb_product` — link articles to one or more products.
47
+
*__Sections:__ Custom taxonomy `wzkb_category` — organize content neatly into categories.
48
+
*__Tags:__ Optional `wzkb_tag` taxonomy — make finding content even easier.
47
49
48
-
## Contribute
50
+
###Contribute
49
51
50
52
If you have an idea, I'd love to hear it. WebberZone Knowledge Base is also available on [Github](https://github.com/WebberZone/knowledgebase). You can [create an issue on the Github page](https://github.com/WebberZone/knowledgebase/issues) or, better yet, fork the plugin, add a new feature and send me a pull request.
51
53
@@ -60,9 +62,9 @@ For more screenshots, visit the [WordPress plugin page](http://wordpress.org/plu
60
62
61
63
### WordPress install (The easy way)
62
64
63
-
1. Navigate to "Plugins" within your WordPress Admin Area
64
-
2. Click "Add new" and in the search box enter "Knowledgebase" or "Knowledge Base"
65
-
3. Find the plugin in the list (usually the first result) and click "Install Now"
65
+
1. Navigate to “Plugins” within your WordPress Admin Area
66
+
2. Click “Add new” and in the search box enter “Knowledgebase” or "Knowledge Base"
67
+
3. Find the plugin in the list (usually the first result) and click “Install Now”
66
68
4. Activate or Network activate the Plugin in WP-Admin under the Plugins screen
67
69
68
70
### Manual install
@@ -71,48 +73,31 @@ For more screenshots, visit the [WordPress plugin page](http://wordpress.org/plu
71
73
2. Extract the contents of knowledgebase.zip to wp-content/plugins/ folder. You should get a folder called knowledgebase.
72
74
3. Activate or Network activate the Plugin in WP-Admin under the Plugins screen
73
75
74
-
### Usage
76
+
### Quick Start
77
+
78
+
When you Activate the plugin for the first time, you will be taken to the Setup Wizard. Follow the instructions to set up your knowledge base.
75
79
76
-
1. Visit `Knowledge Base » Sections` to add new categories to the knowledge base
77
-
2. Visit `Knowledge Base » Add New` to add new Articles to the knowledge base. You can select a section from there while adding
78
-
3. Optionally, create a new page or edit an existing one and add the shortcode `[knowledgebase]` or use the block to set up this page to display the knowledgebase
80
+
After the Setup Wizard, you can:
79
81
80
-
The plugin supports unlimited levels of category hierarchy. To build a multi-product knowledge base:
82
+
1. Go to __Knowledge Base » Products__ — add your first Products if you've selected Multi-Product mode.
83
+
2. Go to __Knowledge Base » Sections__ — add your first categories.
84
+
3. Go to __Knowledge Base » Add New__— create articles and assign them to sections.
85
+
86
+
__Want a multi-product Knowledge Base only with Sections?__
81
87
82
88
1. Set the *First section level* under the Output tab to 2
83
89
2. Create a set of top-level sections for each product
84
90
3. Create sub-sections for each of the products
85
91
86
-
[This live demo](https://webberzone.com/support/knowledgebase/) is a working example of a multi-product knowledge base.
92
+
See a live example: [WebberZone Knowledge Base Demo](https://webberzone.com/support/knowledgebase/).
87
93
88
94
## Frequently Asked Questions
89
95
90
96
Check out the [FAQ on the plugin page](http://wordpress.org/plugins/knowledgebase/faq/) and the [Knowledge Base](https://webberzone.com/support/section/knowledgebase/).
91
97
92
-
If your question is not listed below, please create a new post at the [WordPress.org support forum](http://wordpress.org/support/plugin/knowledgebase). It is the fastest way to get support, as I monitor the forums regularly. I also provide [premium *paid* support via email](https://webberzone.com/support/).
93
-
94
-
### 404 errors on the knowledge base
95
-
96
-
This is usually due to outdated permalinks. To flush the existing permalink rules, visit Settings > Permalinks in your WordPress admin area.
97
-
98
-
### Shortcodes
99
-
100
-
For details on all the shortcodes included in the plugin, refer to [this Knowledge Base article](https://webberzone.com/support/knowledgebase/knowledge-base-shortcodes/).
101
-
102
-
### Using your templates for archives and search
103
-
104
-
WebberZone Knowledge Base comes built with custom templates to display archives of the articles, category archives, and search results. You can easily override any of these templates by creating your template in your theme's folder or in `wp-content/knowledgebase/templates`
105
-
106
-
1. Article view: single-wz_knowledgebase.php or single-wz_knowledgebase.html
107
-
2. Articles archive: archive-wz_knowledgebase.php or archive-wz_knowledgebase.html
108
-
3. Category archive: taxonomy-wzkb_category.php or taxonomy-wzkb_category.html
109
-
4. Search results: wzkb-search.php or wzkb-search.html
110
-
111
-
### How do I sort the posts or sections
112
-
113
-
The plugin doesn't have an inbuilt feature to sort posts or sections. You will need an external plugin like [Intuitive Custom Post Order](https://wordpress.org/plugins/intuitive-custom-post-order/) which allows you to easily drag and drop posts, sections or tags to display them in a custom order.
98
+
If you don't see your question answered in the FAQ and Knowledge Base, please post it on the [WordPress.org support forum](http://wordpress.org/support/plugin/knowledgebase). This is the quickest way to get help, as I check the forums daily. For more personalized assistance, I also offer [premium *paid* support via email](https://webberzone.com/support/).
114
99
115
-
###How can I report security bugs?
100
+
## How can I report security bugs?
116
101
117
102
You can report security bugs through the Patchstack Vulnerability Disclosure Program. The Patchstack team help validate, triage and handle any security vulnerabilities. [Report a security vulnerability.](https://patchstack.com/database/vdp/knowledgebase)
Effortlessly build a comprehensive knowledge base for unlimited products on your WordPress site and elevate your customer support experience.
12
+
Effortlessly create a powerful, multi-product knowledge base. Boost your support, reduce tickets, scale your documentation and make customers happy!
13
13
14
14
== Description ==
15
15
16
-
[Knowledge Base](https://webberzone.com/plugins/knowledgebase/) is an easy-to-use WordPress plugin that allows you to create a knowledge base / FAQ section on your site.
16
+
[Knowledge Base](https://webberzone.com/plugins/knowledgebase/) makes building a knowledge base or FAQ for your WordPress site easy, fast, and scalable.
17
17
18
-
You can use it to create a single or multi-product knowledge base with little effort.
18
+
🎯 Perfect for:
19
+
✅ Multi-product companies
20
+
✅ SaaS platforms
21
+
✅ Ecommerce support centres
22
+
✅ Documentation hubs
19
23
20
-
The plugin was born after I tried several free plugins and themes that didn't fit my purpose. It's designed to be very easy to install and use out of the box.
You can view a [live demo of my knowledge base](https://webberzone.com/support/knowledgebase/).
26
+
### Main features
23
27
24
-
= Terminology =
28
+
🚀 Unlimited Knowledge Bases — Support as many products as you like, with unlimited sections and sub-sections.
29
+
🎨 Beautiful, Responsive Layouts — Ships with clean templates powered by the Responsive Grid System.
30
+
🔗 Customisable Permalinks — View your KB at /knowledgebase/ by default or change it easily.
31
+
✨ Shortcodes + Gutenberg Blocks — Add KB listings anywhere using [knowledgebase] or use the Knowledge Base block.
32
+
🧭 Built-in Breadcrumbs — Improve UX and SEO with breadcrumb navigation.
33
+
🧩 Widgets Included — WZKB Articles, WZKB Sections, and WZKB Breadcrumbs widgets.
34
+
⚡ Built-in Caching — Speed up your Knowledge Base without extra plugins.
25
35
26
-
* __Articles__: A custom post type `wz_knowledgebase` is used to store all the knowledge base articles
27
-
* __Sections__: A custom taxonomy ( `kbcategory` ) used to create the knowledge base. You will need *at least one category* to display the knowledge base. Add these categories under *Knowledge Base > Sections*
28
-
* __Tags__: Additionally you can use tags ( `kbtags` ) can also be used for each knowledge base article.
36
+
### Key Concepts
29
37
30
-
= Main features =
38
+
* __Articles:__ Custom post type `wz_knowledgebase` — your FAQs, how-to guides, and documentation.
39
+
* __Products:__ Custom taxonomy `wzkb_product` — link articles to one or more products.
40
+
* __Sections:__ Custom taxonomy `wzkb_category` — organize content neatly into categories.
41
+
* __Tags:__ Optional `wzkb_tag` taxonomy — make finding content even easier.
31
42
32
-
* Supports unlimited knowledge bases using different sections with unlimited nested levels
33
-
* Inbuilt styles that display the Knowledge Base beautifully and are fully responsive - Uses the [Responsive Grid System](http://www.responsivegridsystem.com/)
34
-
* Customizable permalinks: Archives are enabled so your knowledge base can be viewed automatically at `/knowledgebase/` upon activation. You can change this on the Settings page
35
-
* Shortcode: `[knowledgebase]` will allow you to display the knowledge base on any page you choose. For other shortcodes, check the FAQ
36
-
* Gutenberg block: You can display the knowledge base using a block. Find it by typing `kb` or `knowledge base` when adding a new block
37
-
* Breadcrumbs: Default templates include breadcrumbs. Alternatively, use the function or shortcode to display this where you want
38
-
* Widgets: WZKB Articles, WZKB Sections and WZKB Breadcrumbs
39
-
* Inbuilt cache to speed up the display of your knowledge base articles
40
-
41
-
= Contribute =
43
+
### Contribute
42
44
43
45
If you have an idea, I'd love to hear it. WebberZone Knowledge Base is also available on [Github](https://github.com/WebberZone/knowledgebase). You can [create an issue on the Github page](https://github.com/WebberZone/knowledgebase/issues) or, better yet, fork the plugin, add a new feature and send me a pull request.
44
46
45
47
== Installation ==
46
48
47
-
= WordPress install (The easy way) =
49
+
### WordPress install (The easy way)
48
50
49
51
1. Navigate to “Plugins” within your WordPress Admin Area
50
52
2. Click “Add new” and in the search box enter “Knowledgebase” or "Knowledge Base"
51
53
3. Find the plugin in the list (usually the first result) and click “Install Now”
52
54
4. Activate or Network activate the Plugin in WP-Admin under the Plugins screen
53
55
54
-
= Manual install =
56
+
### Manual install
55
57
56
58
1. Download the plugin
57
59
2. Extract the contents of knowledgebase.zip to wp-content/plugins/ folder. You should get a folder called knowledgebase.
58
60
3. Activate or Network activate the Plugin in WP-Admin under the Plugins screen
59
61
60
-
= Usage =
62
+
### Quick Start
63
+
64
+
When you Activate the plugin for the first time, you will be taken to the Setup Wizard. Follow the instructions to set up your knowledge base.
61
65
62
-
1. Visit `Knowledge Base » Sections` to add new categories to the knowledge base
63
-
2. Visit `Knowledge Base » Add New` to add new Articles to the knowledge base. You can select a section from there while adding
64
-
3. Optionally, create a new page or edit an existing one and add the shortcode `[knowledgebase]` or use the block to set up this page to display the knowledgebase
66
+
After the Setup Wizard, you can:
65
67
66
-
The plugin supports unlimited levels of category hierarchy. To build a multi-product knowledge base:
68
+
1. Go to __Knowledge Base » Products__ — add your first Products if you've selected Multi-Product mode.
69
+
2. Go to __Knowledge Base » Sections__ — add your first categories.
70
+
3. Go to __Knowledge Base » Add New__— create articles and assign them to sections.
71
+
72
+
__Want a multi-product Knowledge Base only with Sections?__
67
73
68
74
1. Set the *First section level* under the Output tab to 2
69
75
2. Create a set of top-level sections for each product
70
76
3. Create sub-sections for each of the products
71
77
72
-
[This live demo](https://webberzone.com/support/knowledgebase/) is a working example of a multi-product knowledge base.
78
+
See a live example: [WebberZone Knowledge Base Demo](https://webberzone.com/support/knowledgebase/).
73
79
74
80
== Frequently Asked Questions ==
75
81
76
-
If your question is not listed below, please create a new post at the [WordPress.org support forum](http://wordpress.org/support/plugin/knowledgebase). It is the fastest way to get support, as I monitor the forums regularly. I also provide [premium *paid* support via email](https://webberzone.com/support/).
82
+
If you don't see your question answered below, please post it on the [WordPress.org support forum](http://wordpress.org/support/plugin/knowledgebase). This is the quickest way to get help, as I check the forums daily. For more personalized assistance, I also offer [premium *paid* support via email](https://webberzone.com/support/).
83
+
84
+
= Why are Knowledge Base pages giving 404 errors? =
77
85
78
-
= 404 errors on the knowledge base =
86
+
Flush permalinks! Go to __Settings > Permalinks__ and just click __Save Changes__.
79
87
80
-
This is usually due to outdated permalinks. To flush the existing permalink rules, visit Settings > Permalinks in your WordPress admin area.
88
+
= What shortcodes are available? =
81
89
82
-
= Shortcodes =
90
+
Check the full shortcode guide here: [Knowledge Base Shortcodes](https://webberzone.com/support/knowledgebase/knowledge-base-shortcodes/).
83
91
84
-
For details on all the shortcodes included in the plugin, refer to [this Knowledge Base article](https://webberzone.com/support/knowledgebase/knowledge-base-shortcodes/).
92
+
= Can I override templates? =
85
93
86
-
= Using your own templates for archives and search =
94
+
Absolutely! Copy these files into your theme or `wp-content/knowledgebase/templates/`:
87
95
88
-
WebberZone Knowledge Base comes built with custom templates to display archives of the articles, category archives, and search results. You can easily override any of these templates by creating your template in your theme's folder or in `wp-content/knowledgebase/templates`
96
+
* `single-wz_knowledgebase.php`
97
+
* `archive-wz_knowledgebase.php`
98
+
* `taxonomy-wzkb_category.php`
99
+
* `wzkb-search.php`
89
100
90
-
1. Article view: single-wz_knowledgebase.php or single-wz_knowledgebase.html
91
-
2. Articles archive: archive-wz_knowledgebase.php or archive-wz_knowledgebase.html
92
-
3. Category archive: taxonomy-wzkb_category.php or taxonomy-wzkb_category.html
93
-
4. Search results: wzkb-search.php or wzkb-search.html
101
+
Or .html versions if you are using a block theme.
94
102
95
-
= How do I sort the posts or sections? =
103
+
= How do I change the article or section order? =
96
104
97
-
The plugin doesn't have an inbuilt feature to sort posts or sections. You will need an external plugin like [Intuitive Custom Post Order](https://wordpress.org/plugins/intuitive-custom-post-order/) which allows you to easily drag and drop posts, sections or tags to display them in a custom order.
105
+
Use a plugin like [Intuitive Custom Post Order](https://wordpress.org/plugins/intuitive-custom-post-order/) to easily drag and drop posts, sections or tags to display them in a custom order.
98
106
99
107
= How can I report security bugs? =
100
108
@@ -125,9 +133,11 @@ Completely rewritten. Several new features and enhancements.
125
133
* Migration wizard to map existing sections and articles to products, with dry-run and batch processing.
126
134
* Product-based frontend templates that preserve section hierarchy.
127
135
* Admin UI enhancements for managing products, sections, and migration.
136
+
* Setup Wizard to guide users through the initial setup process.
128
137
129
138
* Modifications:
130
139
* Standardized CSS class names to use consistent hyphenation (e.g., `wzkb_section` is now `wzkb-section`). If you have custom CSS targeting the old class names, you'll need to update your stylesheets.
140
+
* New Hooks_Registry class added to handle hooks in a more organized way and prevents accidental duplicate hooks.
0 commit comments