Skip to content

Commit c5a2464

Browse files
authored
Merge pull request #59 from WebberZone/oops
Implementation of classes
2 parents c5aa912 + a772f2f commit c5a2464

File tree

94 files changed

+6731
-4484
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+6731
-4484
lines changed

README.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,32 +16,32 @@ __License:__ [GPL-2.0+](http://www.gnu.org/licenses/gpl-2.0.html)
1616

1717
__Plugin page:__ [Knowledge Base](https://webberzone.com/plugins/knowledgebase/) | [WordPress.org Plugin page](https://wordpress.org/plugins/knowledgebase/)
1818

19-
Fastest way to create a highly-flexible multi-product knowledge base on you WordPress site.
19+
Effortlessly build a comprehensive knowledge base for unlimited products on your WordPress site and elevate your customer support experience.
2020

2121
## Description
2222

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 WordPress blog.
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.
2424

25-
This is perfect if you have single or multiple products and want a single knowledge base with little effort.
25+
You can use it to create a single or multi-product knowledge base with little effort.
2626

27-
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.
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.
2828

29-
You can view a [live demo of my own knowledge base](https://webberzone.com/support/knowledgebase/).
29+
You can view a [live demo of my knowledge base](https://webberzone.com/support/knowledgebase/).
3030

3131
### Terminology
3232

3333
* __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* in order to display the knowledge base. These categories can be added under *Knowledge Base > Sections*
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*
3535
* __Tags__: Additionally you can use tags ( `kbtags` ) can also be used for each knowledge base article.
3636

3737
### Main features
3838

3939
* Supports unlimited knowledge bases using different sections with unlimited nested levels
40-
* Inbuilt styles that display the knowledge 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 at `/knowledgebase/` automatically on activation. You can change this in the Settings page
42-
* Shortcode: `[knowledgebase]` will allow you to display the knowledge base on any page of your choosing. For other shortcodes, check the FAQ
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
4343
* 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 functions or shortcode to display this where you want
44+
* Breadcrumbs: Default templates include breadcrumbs. Alternatively, use the function or shortcode to display this where you want
4545
* Widgets: WZKB Articles, WZKB Sections and WZKB Breadcrumbs
4646
* Inbuilt cache to speed up the display of your knowledge base articles
4747

@@ -54,15 +54,15 @@ If you have an idea, I'd love to hear it. WebberZone Knowledge Base is also avai
5454
![Knowledge Base Menu in the WordPress Admin](https://raw.githubusercontent.com/WebberZone/knowledgebase/master/wporg-assets/screenshot-1.png)
5555
*Knowledge Base Menu in the WordPress Admin*
5656

57-
For more screenshots visit the [WordPress plugin page](http://wordpress.org/plugins/knowledgebase/screenshots/)
57+
For more screenshots, visit the [WordPress plugin page](http://wordpress.org/plugins/knowledgebase/screenshots/)
5858

5959
## Installation
6060

6161
### WordPress install (The easy way)
6262

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
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"
6666
4. Activate or Network activate the Plugin in WP-Admin under the Plugins screen
6767

6868
### Manual install
@@ -77,10 +77,10 @@ For more screenshots visit the [WordPress plugin page](http://wordpress.org/plug
7777
2. Visit `Knowledge Base » Add New` to add new Articles to the knowledge base. You can select a section from there while adding
7878
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
7979

80-
The plugin supports unlimited levels of category hierarchy. To build a multiple product knowledge base:
80+
The plugin supports unlimited levels of category hierarchy. To build a multi-product knowledge base:
8181

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

8686
[This live demo](https://webberzone.com/support/knowledgebase/) is a working example of a multi-product knowledge base.
@@ -89,19 +89,19 @@ The plugin supports unlimited levels of category hierarchy. To build a multiple
8989

9090
Check out the [FAQ on the plugin page](http://wordpress.org/plugins/knowledgebase/faq/) and the [Knowledge Base](https://webberzone.com/support/section/knowledgebase/).
9191

92-
If your question isn't listed there, 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/).
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/).
9393

9494
### 404 errors on the knowledge base
9595

96-
This is usually because of outdated permalinks. To flush the existing permalinks rules simply visit Settings » Permalinks in your WordPress admin area.
96+
This is usually due to outdated permalinks. To flush the existing permalink rules, visit Settings > Permalinks in your WordPress admin area.
9797

9898
### Shortcodes
9999

100-
Refer to [this Knowledge Base article](https://webberzone.com/support/knowledgebase/knowledge-base-shortcodes/) to details of all the shortcodes included in the plugin.
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/).
101101

102-
### Using your own templates for archives and search
102+
### Using your templates for archives and search
103103

104-
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`
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`
105105

106106
1. Article view: single-wz_knowledgebase.php or single-wz_knowledgebase.html
107107
2. Articles archive: archive-wz_knowledgebase.php or archive-wz_knowledgebase.html
@@ -118,4 +118,4 @@ You can report security bugs through the Patchstack Vulnerability Disclosure Pro
118118

119119
## About this repository
120120

121-
This GitHub repository always holds the latest development version of the plugin. If you're looking for an official WordPress release, you can find this on the [WordPress.org repository](http://wordpress.org/plugins/knowledgebase). In addition to stable releases, latest beta versions are made available under [releases](https://github.com/WebberZone/knowledgebase/releases).
121+
This GitHub repository always holds the latest development version of the plugin. If you're looking for an official WordPress release, you can find this on the [WordPress.org repository](http://wordpress.org/plugins/knowledgebase). In addition to stable releases, the latest beta versions are made available under [releases](https://github.com/WebberZone/knowledgebase/releases).

composer.json

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"name": "webberzone/knowledgebase",
33
"description": "Fastest way to create a highly-flexible multi-product knowledge base.",
4+
"version": "2.3.0",
45
"type": "wordpress-plugin",
56
"keywords": [
67
"knowledge base",
@@ -21,14 +22,14 @@
2122
"php": ">=7.4"
2223
},
2324
"require-dev": {
24-
"szepeviktor/phpstan-wordpress": "^1.3",
25-
"phpstan/extension-installer": "^1.3",
26-
"phpstan/phpstan": "^1.10",
27-
"php-stubs/wordpress-stubs": "^6.5",
28-
"wp-coding-standards/wpcs": "^3.0",
29-
"dealerdirect/phpcodesniffer-composer-installer": "^0.7",
30-
"phpcompatibility/phpcompatibility-wp": "^2.1",
31-
"yoast/phpunit-polyfills": "^1.0",
25+
"szepeviktor/phpstan-wordpress": "^1",
26+
"phpstan/extension-installer": "^1",
27+
"phpstan/phpstan": "^1",
28+
"php-stubs/wordpress-stubs": "^6",
29+
"wp-coding-standards/wpcs": "^3",
30+
"dealerdirect/phpcodesniffer-composer-installer": "^1",
31+
"phpcompatibility/phpcompatibility-wp": "^2",
32+
"yoast/phpunit-polyfills": "^3",
3233
"phpunit/phpunit": "^5.7.21 || ^6.5 || ^7.5"
3334
},
3435
"config": {

includes/activate-deactivate.php

Lines changed: 0 additions & 132 deletions
This file was deleted.

0 commit comments

Comments
 (0)