Knowledge Base

Description

As the name suggests, Knowledge Base will allow you to create a knowledge base / FAQ section on your WordPress blog.

The plugin was born after I tried several free plugins and themes out there and that couldn’t fit my purpose. It’s designed to be very easy to install and use out of the box and I’ll be adding more features into the core and as addons.

The plugin uses a custom post in conjunction with custom taxonomies to create and display your knowledge base.

Main features:

  • Uses a custom post type wz_knowledgebase with a slug of wzkb ensuring your data always stays even if you choose to delete this plugin
  • Customizable permalinks: Archives are enabled so your knowledge base can be viewed at /knowledgebase/ automatically on activation. You can change this in the Settings page
  • Uses Categories ( kbcategory ) to automatically draw up the knowledge base. You will need at least one category in order to display the knowledge base
  • Additionally tags ( kbtags ) can also be used for each knowledge base article
  • Shortcode [knowledgebase] will allow you to display the knowledge base on any page of your choosing
  • Breadcrumbs: Default templates include breadcrumbs. Alternatively, use functions or shortcode to display this where you want
  • Inbuilt styles that display the knowledge beautifully and are fully responsive – Uses the Responsive Grid System
  • Supports unlimited nested of categories

Contribute

If you have an idea, I’d love to hear it. WebberZone Knowledge Base is also available on Github. You can create an issue on the Github page or, better yet, fork the plugin, add a new feature and send me a pull request.

Screenshots

  • Knowledge Base Menu in the WordPress Admin
  • Knowledge Base Viewer Facing with Default styles
  • Knowledge Base Category view in the WordPress Admin
  • Settings » General
  • Settings » Output
  • Settings » Styles

Installation

WordPress install (The easy way)

  1. Navigate to “Plugins” within your WordPress Admin Area
  2. Click “Add new” and in the search box enter “Knowledgebase” or “Knowledge Base”
  3. Find the plugin in the list (usually the first result) and click “Install Now”
  4. Activate or Network activate the Plugin in WP-Admin under the Plugins screen

Manual install

Download the plugin
1. Extract the contents of knowledgebase.zip to wp-content/plugins/ folder. You should get a folder called knowledgebase.
2. Activate or Network activate the Plugin in WP-Admin under the Plugins screen
3. Create a new page or edit an existing one and add the shortcode [knowledgebase] to set up this page to display the knowledgebase
4. Visit Knowledge Base » Add New to add new Articles to the knowledge base
5. Visit Knowledge Base » Sections to add new categories to the knowledge base. Alternatively, you can add new categories from the meta box in the Add New page

The plugin supports unlimited levels of category hierarchy, however, the recommended setting for creating the knowledge base is to create a top level category with the name of the knowledge base and sub-level categories for each section of this knowledge base.

FAQ

If your question isn’t listed here, please create a new post at the WordPress.org support forum. It is the fastest way to get support as I monitor the forums regularly. I also provide premium paid support via email.

404 errors on the knowledge base

This is usually because of outdated permalinks. To flush the existing permalinks rules simply visit Settings » Permalinks in your WordPress admin area.

Shortcode

You can display the knowledge base anywhere in your blog using the [knowledgebase] shortcode. The shortcode takes one optional attribute category:

[knowledgebase category="92"]

category : Category ID for which you want to display the knowledge base. You can find the ID in the Sections listing under the Knowledge Base menu in the WordPress Admin.

You can also display the search form using [kbsearch]

Using your own templates for archives and search

WebberZone Knowledge Base comes inbuilt with a set of custom templates to display archives of the articles, category archives as well as search results. You can easily override any of these templates by creating your own template in your theme’s folder

  1. Articles archive: archive-wz_knowledgebase.php
  2. Category archive: taxonomy-wzkb_category.php
  3. Search results: search-wz_knowledgebase.php
How do I sort the posts or sections?

The plugin doesn’t have an inbuilt feature to sort posts or sections. You will need an external plugin like Intuitive Custom Post Order which allows you to easily drag and drop posts, sections or tags to display them in a custom order.

Contributors & Developers

“Knowledge Base” is open source software. The following people have contributed to this plugin.

Contributors

Translate “Knowledge Base” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

1.6.0 – 5 December 2018

  • Features:

    • New functions to add breadcrumbs – Use wzkb_breadcrumb to display the breadcrumb. wzkb_get_breadcrumb returns the breadcrumb and [kbbreadcrumb] is the corresponding shortcode
    • The default category and archive templates now display the breadcrumb below the search bar
    • New option to set the title of the knowledge base. Find it under the Options tab under Settings
  • Enhancements:

    • Support for Gutenberg/Block Editor in WordPress 5.0

1.5.0 – 6 August 2017

  • Features:

    • New option to set the number of columns to display the knowledge base archives
    • New option to set what section level should the knowledge base start from. Ideal if you want to have separate knowledge bases for multiple products
    • New option to show excerpt below the link. Contributed by @border0464111
    • New option to turn off the section link. Contributed by @border0464111
    • New option to show the number of articles in an orange circle next to the header. You can override the color by styling wzkb_section_count
    • New function wzkb_get_default_option() to retrieve the default setting
  • Enhancements:

    • Make nested wrapper. Contributed by @border0464111
    • Settings page is now a tabbed interface using jQuery without needing to reload the page
    • Modified checkbox settings are indicated in the Settings page
    • Added the number of articles in “At a Glance” widget in the WordPress Dashboard
  • Bug fixes:

    • Fixed several settings API functions

1.4.0 – 22 April 2017

  • Features:
    • New options to disable the KB feeds and include articles in the main feed
  • Enchancements:
    • Force the two column layout and prevent overlaps

1.3.0 – 4 December 2016

  • Enhancements:

    • Articles now support comments
    • Two new settings to delete all settings and Knowledge base content when deleting the plugin.
  • Bug fixes:

    • Fixed labels where Section was still called Category

1.2.0 – 24 January 2016

  • Features:

    • Settings page: Customize the slugs, disable styles, etc. Change in base slug from kb-articles to knowledgebase. If you’re upgrading this plugin, and have previously used knowledgebase as the slug for the page you created, then either change the slug for the knowledge base in the Settings page or delete the page you created.
    • Shortcode to display the Knowledge base search form – Use [kbsearch] for this purpose
  • Enhancements:

    • Merged archive stylesheet with the main stylesheet
    • Hide the first level header when displaying archives
  • Bug fixes:

    • Undefined index notice on Search results pages outside of the knowledge base

1.1.0 – 29 June 2015

  • Features:

    • Network activate now works on multisite
    • Main archive displays the knowledge base. You can override the default template by adding a file archive-wz_knowledgebase.php in your theme folder
    • Category archive displays the knowledge base for the specific category. You can override the default template by adding a file taxonomy-wzkb_category.php in your theme folder
    • Major rewrite of knowledge base HTML markup and default styles. If you’re using your own custom styles, then you will need to remove
  • Enhancements:

    • Custom post type slug changed to knowledgebase from wzkb
    • Custom post type archives and category archives changed to kb-articles. Tag archives changed to kb-tags
    • Duplicate code cleanup
  • Bug fixes:

    • If term has no children terms, then directly display the articles under it

1.0.0 – 17 May 2015

  • Initial release