90% wp-knowledgebase

Code Review | WordPress Knowledge base & Documentation Plugin - WP Knowledgebase

WordPress plugin WordPress Knowledge base & Documentation Plugin - WP Knowledgebase scored90%from 54 tests.

About plugin

  • Plugin page: wp-knowledgebase
  • Plugin version: 1.3.4
  • PHP version: 7.4.16
  • WordPress compatibility: 4.7-5.5.1
  • WordPress version: 6.3.1
  • First release: Dec 5, 2014
  • Latest release: Nov 9, 2020
  • Number of updates: 89
  • Update frequency: every 24.3 days
  • Top authors: EnigmaWeb (75.28%)iova.mihai (25.84%)

Code review

54 tests

User reviews

45 reviews

Install metrics

2,000+ active /95,319 total downloads

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | Checking the installer triggered no errors
This plugin's installer ran successfully

Server metrics [RAM: ▲0.89MB] [CPU: ▼0.80ms] Passed 4 tests

Server-side resources used by WordPress Knowledge base & Documentation Plugin - WP Knowledgebase
Normal server usage
PageMemory (MB)CPU Time (ms)
Home /4.22 ▲0.7645.37 ▲4.66
Dashboard /wp-admin4.22 ▲0.8857.85 ▼4.68
Posts /wp-admin/edit.php4.34 ▲0.9958.07 ▲10.78
Add New Post /wp-admin/post-new.php6.98 ▲1.1092.46 ▼11.52
Media Library /wp-admin/upload.php4.14 ▲0.9242.79 ▲8.34
Categories /wp-admin/edit-tags.php?taxonomy=kbe_taxonomy&post_type=kbe_knowledgebase4.1440.48
Search Analytics /wp-admin/edit.php?post_type=kbe_knowledgebase&page=kbe-search-analytics4.1239.61
Article Feedback /wp-admin/edit.php?post_type=kbe_knowledgebase&page=kbe-article-feedback4.1237.03
Getting Started /wp-admin/edit.php?post_type=kbe_knowledgebase&page=kbe-getting-started4.1538.75
Settings /wp-admin/edit.php?post_type=kbe_knowledgebase&page=kbe-settings4.2739.53
Articles /wp-admin/edit.php?post_type=kbe_knowledgebase4.2042.80
Order /wp-admin/edit.php?post_type=kbe_knowledgebase&page=kbe-order4.1542.18
New Article /wp-admin/post-new.php?post_type=kbe_knowledgebase7.0187.09
Tags /wp-admin/edit-tags.php?taxonomy=kbe_tags&post_type=kbe_knowledgebase4.1440.32

Server storage [IO: ▲2.12MB] [DB: ▲0.01MB] Passed 3 tests

Filesystem and database footprint
There were no storage issued detected upon installing this plugin
Filesystem: 154 new files
Database: no new tables, 26 new options
New WordPress options
widget_recent-comments
db_upgraded
kbe_search_setting
kbe_show_page_getting_started
widget_kbe_search_widget
kbe_bgcolor
kbe_breadcrumbs_separator
kbe_version
kbe_search_no_results_message
kbe_article_qty
...

Browser metrics Passed 4 tests

An overview of browser requirements for WordPress Knowledge base & Documentation Plugin - WP Knowledgebase
This plugin has a minimal impact on browser resources
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,988 ▲21714.01 ▼0.378.21 ▲6.4243.93 ▲0.48
Dashboard /wp-admin2,283 ▲954.84 ▼0.03114.20 ▼2.9447.92 ▲0.36
Posts /wp-admin/edit.php2,165 ▲762.02 ▼0.0136.57 ▲2.3736.00 ▲3.21
Add New Post /wp-admin/post-new.php1,607 ▲7818.71 ▲0.31658.79 ▲9.6955.09 ▲0.46
Media Library /wp-admin/upload.php1,468 ▲774.29 ▲0.10102.02 ▼1.5146.47 ▲2.76
Categories /wp-admin/edit-tags.php?taxonomy=kbe_taxonomy&post_type=kbe_knowledgebase1,3392.3227.8232.23
Search Analytics /wp-admin/edit.php?post_type=kbe_knowledgebase&page=kbe-search-analytics9862.2329.8350.39
Article Feedback /wp-admin/edit.php?post_type=kbe_knowledgebase&page=kbe-article-feedback9752.3935.1241.12
Getting Started /wp-admin/edit.php?post_type=kbe_knowledgebase&page=kbe-getting-started1,5542.2529.7560.83
Settings /wp-admin/edit.php?post_type=kbe_knowledgebase&page=kbe-settings2,0162.8959.4845.07
Articles /wp-admin/edit.php?post_type=kbe_knowledgebase1,3022.3736.5842.16
Order /wp-admin/edit.php?post_type=kbe_knowledgebase&page=kbe-order9972.3530.7940.18
New Article /wp-admin/post-new.php?post_type=kbe_knowledgebase6,34423.53888.3833.21
Tags /wp-admin/edit-tags.php?taxonomy=kbe_tags&post_type=kbe_knowledgebase1,3082.3227.7031.70

Uninstaller [IO: ▲0.00MB] [DB: ▲0.01MB] 75% from 4 tests

🔸 Tests weight: 35 | Verifying that this plugin uninstalls completely without leaving any traces
These items require your attention
  • Zombie WordPress options were found after uninstall: 26 options
    • kbe_search_no_results_message
    • kbe_breadcrumbs_setting
    • db_upgraded
    • kbe_bgcolor
    • widget_recent-comments
    • kbe_show_page_getting_started
    • kbe_sidebar_inner
    • kbe_plugin_slug
    • widget_theysaidso_widget
    • kbe_breadcrumbs_separator
    • ...

Smoke tests Passed 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | This is a shallow check for server-side errors
Even though no errors were found, this is by no means an exhaustive test

SRP Passed 2 tests

🔹 Tests weight: 20 | A shallow check of the single-responsibility principle; PHP files should perform no action - including output of placeholder text - and trigger no errors when accessed directly
Looking good! No server-side errors or output on direct access of PHP files

User-side errors Passed 1 test

🔹 Test weight: 20 | This is a shallow check for browser errors
Everything seems fine, but this is not an exhaustive test

Optimizations

Plugin configuration Passed 29 tests

readme.txt Passed 16 tests

Often overlooked, readme.txt is one of the most important files in your plugin
5 plugin tags: knowledge base, wiki, faqs, knowledgebase, wp knowledgebase

wp-knowledgebase/wp-knowledgebase.php Passed 13 tests

The principal PHP file in "WordPress Knowledge base & Documentation Plugin - WP Knowledgebase" v. 1.3.4 is loaded by WordPress automatically on each request
54 characters long description:
Simple and flexible knowledgebase plugin for WordPress

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | There should be no dangerous file extensions present in any WordPress plugin
Everything looks great! No dangerous files found in this plugin13,659 lines of code in 112 files:
LanguageFilesBlank linesComment linesLines of code
PHP792,5722,9925,619
CSS93482243,031
PO File131,1921,3162,805
JavaScript74004702,162
YAML10039
SVG3003

PHP code Passed 2 tests

An short overview of logical lines of code, cyclomatic complexity, and other code metrics
Great job! No cyclomatic complexity issues were detected in this plugin
Cyclomatic complexity
Average complexity per logical line of code0.33
Average class complexity10.86
▷ Minimum class complexity1.00
▷ Maximum class complexity124.00
Average method complexity2.66
▷ Minimum method complexity1.00
▷ Maximum method complexity19.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes28
▷ Abstract classes621.43%
▷ Concrete classes2278.57%
▷ Final classes00.00%
Methods167
▷ Static methods63.59%
▷ Public methods13580.84%
▷ Protected methods3118.56%
▷ Private methods10.60%
Functions120
▷ Named functions120100.00%
▷ Anonymous functions00.00%
Constants19
▷ Global constants19100.00%
▷ Class constants00.00%
▷ Public constants00.00%

Plugin size 50% from 2 tests

Image compression 50% from 2 tests

Often times overlooked, PNG files can occupy unnecessary space in your plugin
25 PNG files occupy 1.25MB with 0.49MB in potential savings
Potential savings
Compression of 5 random PNG files using pngquant
FileSize - originalSize - compressedSavings
assets/images/doc-kb-main-page.png106.77KB41.16KB▼ 61.45%
screenshot-2.png416.23KB109.49KB▼ 73.69%
assets/images/doc-kb-main-page-admin-notice.png38.10KB14.92KB▼ 60.84%
template-legacy/images/kbe_icon_arrow.png0.09KB0.15KB0.00%
template/images/kbe_icon-plus.png0.17KB0.22KB0.00%