Knowledge Base

July 16, 2024

Knowledge Base Plugin

Fastest way to create a highly-flexible multi-product knowledge base on you WordPress site.

Knowledge Base is an easy to use WordPress plugin that allows you to create a knowledge base / FAQ section on your WordPress blog.

This is perfect if you have single or multiple products and want a single knowledge base with little effort.

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.

You can view a live demo of my own knowledge base.

Terminology

  • Articles: A custom post type wz_knowledgebase is used to store all the knowledge base articles
  • Sections: A custom taxonomy ( kbcategory ) used to create the knowledge base. You will need at least one category in order to display the knowledge base. These categories can be added under Knowledge Base > Sections
  • Tags: Additionally you can use tags ( kbtags ) can also be used for each knowledge base article.

Main features

  • Supports unlimited knowledge bases using different sections with unlimited nested levels
  • Inbuilt styles that display the knowledge beautifully and are fully responsive – Uses the Responsive Grid System
  • 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
  • Shortcode: [knowledgebase] will allow you to display the knowledge base on any page of your choosing. For other shortcodes, check the FAQ
  • Gutenberg block: You can display the knowledge base using a block. Find it by typing kb or knowledge base when adding a new block
  • Breadcrumbs: Default templates include breadcrumbs. Alternatively, use functions or shortcode to display this where you want
  • Widgets: WZKB Articles, WZKB Sections and WZKB Breadcrumbs
  • Inbuilt cache to speed up the display of your knowledge base articles

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.

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

  1. Download the plugin
  2. Extract the contents of knowledgebase.zip to wp-content/plugins/ folder. You should get a folder called knowledgebase.
  3. Activate or Network activate the Plugin in WP-Admin under the Plugins screen

Usage

  1. Visit Knowledge Base » Sections to add new categories to the knowledge base
  2. Visit Knowledge Base » Add New to add new Articles to the knowledge base. You can select a section from there while adding
  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

The plugin supports unlimited levels of category hierarchy. To build a multiple product knowledge base:

  1. Set the First section level under the Output tab to 2
  2. Create a set of top level sections for each product
  3. Create sub-sections for each of the products

This live demo is a working example of a multi-product knowledge base.

Screenshots

  1. Knowledge Base Menu in the WordPress Admin

    Knowledge Base Menu in the WordPress Admin

  2. Knowledge Base Viewer Facing with Default styles

    Knowledge Base Viewer Facing with Default styles

  3. Knowledge Base alerts

    Knowledge Base alerts

  4. Settings » General

    Settings » General

  5. Settings » Output

    Settings » Output

  6. Settings » Styles

    Settings » Styles

  7. Knowledge Base widgets

    Knowledge Base widgets

FAQ

If your answer to your question isn’t listed here or the Knowledge Base, 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.

Shortcodes

Refer to this Knowledge Base article to details of all the shortcodes included in the plugin.

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 or in wp-content/knowledgebase/templates

  1. Article view: single-wz_knowledgebase.php
  2. Articles archive: archive-wz_knowledgebase.php
  3. Category archive: taxonomy-wzkb_category.php
  4. 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.

Changelog

2.2.0

Release post: https://webberzone.com/blog/knowledge-base-v2-2-0/

  • Enhancements:
    • The plugin will now look for templates within wp-content/knowledgebase/templates folder if it is not found within the existing theme before using the plugin’s included templates
    • Alerts block now shows a preview and the Default style is inserted correctly
    • Upgrade settings handling to use the WebberZone Settings_API class
    • Knowledge Base block is wrapped in the <Disabled> component which prevent any accidental clicking when you’re using it in the block editor (Gutenberg)

2.1.2

  • Security fix in block

2.1.1

Release post: https://webberzone.com/blog/knowledge-base-v2-1-0/

  • Enhancements:

    • New options to set number of articles and to show excerpt in the widget
  • Bug fixes:

    • Update activation on multisite when a new blog is added
    • PHP errors when using the widget

2.1.0

  • Features:

    • New related articles module. Enable/disable in the settings page
    • New Gutenberg block for alerts. Original knowledge base block has been upgraded to use block.json
  • Enhancements:

    • wzkb_knowledge function takes additional parameters that override global settings if passed
    • Additional settings added for Knowledge Base block
  • Bug fixes:

    • Fixed Custom CSS loaded incorrectly with a 0 on install/reset
    • Dashicons were not properly loaded on frontend

Earlier versions

For the changelog of earlier versions, please refer to the separate changelog.txt file or the Github releases page

Details

  • Version: 2.2.0
  • Active installations: 100
  • WordPress Version: 6.0
  • Tested up to: 6.6.1
  • PHP Version: 7.4

Ratings


5 Stars
4 Stars
3 Stars
2 Stars
1 Stars