VS Knowledge Base

Description

About

With this lightweight plugin you can create a knowledge base that contains your categories and posts.

To display your knowledge base you can use a block, a shortcode or a widget.

You can customize your knowledge base by adding attributes to the block, the shortcode or the widget.

It’s also possible to display categories and posts from a custom post type (such as WooCommerce product categories and products).

This plugin can also be used to create a FAQ or wiki.

How to use

After installation add the VS Knowledge Base block or the shortcode [knowledgebase] to a page to display your knowledge base.

You can also go to Appearance > Widgets and use the VS Knowledge Base widget.

Default settings categories:

  • 4 columns when using block or shortode
  • 1 column when using widget
  • Order by name
  • Ascending order (A-Z)
  • Empty categories are hidden
  • Parent and subcategories are displayed separately

Default settings posts:

  • Order by date
  • Descending order (new to old)
  • All posts are displayed

Attributes

You can customize your knowledge base by adding attributes to the block, the shortcode or the widget.

  • Add custom CSS class to knowledge base: class="your-class-here"
  • Change the number of columns: columns="3"
  • Include certain categories: include="1,3,5"
  • Exclude certain categories: exclude="8,10,12"
  • Display empty categories too: hide_empty="0"
  • Display category description: category_description="true"
  • Change the number of posts per category: posts_per_category="5"
  • Reverse the order of posts: order="ASC"
  • Display posts by title: orderby="title"
  • Display posts in random order: orderby="rand"
  • Display post counter: post_count="true"
  • Display post meta (date and author): post_meta="true"
  • Display View All link: view_all_link="true"
  • Change label of View All link: view_all_link_label="your label here"
  • Change label of post without title: no_post_title_label="your label here"
  • Change the “no categories are found” text: no_categories_text="your text here"

Example: [knowledgebase include="1,3,5" hide_empty="0" post_meta="true"]

When using the block or the widget, don’t add the main shortcode tag or the brackets.

Example: include="1,3,5" hide_empty="0" post_meta="true"

The columns attribute will be ignored when using the block or widget. Set your number of columns via the block or widget settings.

With the columns attribute you can set the number of columns between 1 and 4. In mobile screens 2 columns (except the 1 column knowledge base).

You can disable the columns with columns="0". This can be handy if you only want to use your own styling.

Post tags

Besides displaying posts by category you can also display posts by tag: taxonomy="post_tag"

Custom post types

It’s also possible to display categories and posts from a custom post type (such as WooCommerce product categories and products).

To display these categories and posts you should add 2 attributes: “taxonomy” and “post_type”

WooCommerce:

  • Product categories and products: taxonomy="product_cat" post_type="product"
  • Include product category image: taxonomy="product_cat" post_type="product" woo_image="true"
  • Display by tag instead of category: taxonomy="product_tag" post_type="product"

Have a question?

Please take a look at the FAQ section.

Пераклад

Translations are not included, but the plugin supports WordPress language packs.

More translations are very welcome!

The translation folder inside this plugin is redundant, but kept for reference.

Credits

Without the WordPress codex and help from the WordPress community I was not able to develop this plugin, so: thank you!

Enjoy!

Screenshots

  • Knowledge Base (GeneratePress theme)
  • Knowledge Base WooCommerce products (GeneratePress theme)
  • Block (dashboard)
  • Widget (dashboard)

Blocks

This plugin provides 1 block.

  • VS Knowledge Base

FAQ

Where is the settings page?

Plugin has no settings page. Use the block, shortcode or widget with attributes to make it work.

Does this plugin have its own knowledge base post type?

No, this plugin is build to create a knowledge base that contains the default categories and posts.

It’s also possible to display categories and posts from a custom post type (such as WooCommerce product categories and products).

How can I change the layout or colors?

You can use an attribute to set the number of columns between 1 and 4 or to disable the columns. But you should use custom CSS for making other changes.

If you disable the columns CSS class “vskb-custom” is added to the knowledge base. This can be handy if you only want to use your own styling.

Where to find the category ID?

Every category URL contains an unique ID. You will find this ID when hovering the category title in your dashboard or when editing the category.

It’s the number that comes after: tag_ID=

Where to find the tag ID?

Every tag URL contains an unique ID. You will find this ID when hovering the tag title in your dashboard or when editing the tag.

It’s the number that comes after: tag_ID=

Is it possible to display a subcategory underneath its parent?

No, this is not possible. Parent and subcategories are displayed separately.

Is a post without a title also displayed?

Yes, it will be displayed in the frontend of your website with a default label. You can change this label by using an attribute.

Why is there no semantic versioning?

The version number won’t give you info about the type of update (major, minor, patch). You should check the changelog to see whether or not the update is a major or minor one.

How can I make a donation?

You like my plugin and want to make a donation? There’s a PayPal donate link at my website. Thank you!

Other questions or comments?

Please open a topic in the WordPress.org support forum for this plugin.

Reviews

23 чэрвеня, 2019
This is a lightweight plugin but it has a power feature. It is easy to configure and display posts. If you have a good understanding of css, it will be much better. In addition to that, the creator is very helpful and supportive.
24 верасня, 2018
A quick and simple way to get up and running with a kb. Perfect for understanding what you need without feature clutter of “advanced” plugins. Good support also.
29 сакавіка, 2018
Super straight forward and easy to use knowledge base plugin for posts. There isn’t a search bar though. Otherwise this is very nice.
Read all 16 reviews

Contributors & Developers

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

Contributors

“VS Knowledge Base” has been translated into 6 locales. Thank you to the translators for their contributions.

Translate “VS 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

Version 7.5

  • New: set number of columns via the block settings, instead of using an attribute

Version 7.4

  • Changed several attribute names, to make it more clear for users
  • This means you might have to update your attributes
  • Attribute posts_per_page becomes posts_per_category
  • Attribute description becomes category_description
  • Attribute count becomes post_count
  • Attribute meta becomes post_meta
  • Attribute no_title_label becomes no_post_title_label
  • Attribute all_link becomes view_all_link
  • Attribute all_link_label becomes view_all_link_label
  • Minor changes in code

Version 7.3

  • Changed plugin description

Version 7.2

  • New: VS Knowledge Base block
  • Block editor users can now replace their shortcode block with the VS Knowledge Base block

Version 7.1

  • Minor changes in code

Version 7.0

  • Added extra validation for category query
  • Minor changes in code

Version 6.9

  • Bumped the “requires PHP” version to 7.0
  • Bumped the “requires at least” version to 5.0

Version 6.8

  • New: disable columns in widget
  • This can be useful for your own styling
  • Was already possible when using the shortcode
  • Minor changes in code

Version 6.7

  • Minor changes in code

Version 6.6

  • Minor changes in code

For all versions please check file changelog.