78% echo-knowledge-base

Code Review | Knowledge Base for Documentation, FAQs with AI Assistance

WordPress plugin Knowledge Base for Documentation, FAQs with AI Assistance scored78%from 54 tests.

About plugin

  • Plugin page: echo-knowledge-base
  • Plugin version: 11.1.0
  • PHP compatiblity: 5.6+
  • PHP version: 7.4.16
  • WordPress compatibility: 5.2-6.4
  • WordPress version: 6.3.1
  • First release: Jan 10, 2017
  • Latest release: Nov 11, 2023
  • Number of updates: 226
  • Update frequency: every 11.0 days
  • Top authors: echoplugins (100%)

Code review

54 tests

User reviews

94 reviews

Install metrics

10,000+ active /605,728 total downloads

Benchmarks

Plugin footprint 82% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | It is important to correctly install your plugin, without throwing errors or notices
This plugin's installer ran successfully

Server metrics [RAM: ▲3.10MB] [CPU: ▲9.36ms] 75% from 4 tests

A check of server-side resources used by Knowledge Base for Documentation, FAQs with AI Assistance
The following require your attention
  • CPU: The total CPU usage must kept under 500.00ms (currently 2,580.27ms on /wp-admin/edit.php?post_type=epkb_post_type_1&page=epkb-add-ons)
PageMemory (MB)CPU Time (ms)
Home /6.44 ▲2.9850.78 ▲10.32
Dashboard /wp-admin6.46 ▲3.1263.44 ▲1.94
Posts /wp-admin/edit.php6.52 ▲3.1668.56 ▲26.16
Add New Post /wp-admin/post-new.php9.20 ▲3.3299.45 ▲6.60
Media Library /wp-admin/upload.php6.39 ▲3.1655.92 ▲18.58
Analytics /wp-admin/edit.php?post_type=epkb_post_type_1&page=epkb-plugin-analytics7.1162.51
All Articles /wp-admin/edit.php?post_type=epkb_post_type_17.1361.95
Add-ons / News /wp-admin/edit.php?post_type=epkb_post_type_1&page=epkb-add-ons7.292,580.27
Categories /wp-admin/edit-tags.php?taxonomy=epkb_post_type_1_category&post_type=epkb_post_type_17.6188.83
Tags /wp-admin/edit-tags.php?taxonomy=epkb_post_type_1_tag&post_type=epkb_post_type_17.1662.77
Configuration /wp-admin/edit.php?post_type=epkb_post_type_1&page=epkb-kb-configuration7.1858.27
Add New Article /wp-admin/post-new.php?post_type=epkb_post_type_19.59113.87
Get Started /wp-admin/edit.php?post_type=epkb_post_type_1&page=epkb-kb-need-help7.4178.79

Server storage [IO: ▲16.29MB] [DB: ▲0.03MB] Passed 3 tests

Input-output and database impact of this plugin
There were no storage issued detected upon installing this plugin
Filesystem: 387 new files
Database: no new tables, 6 new options
New WordPress options
theysaidso_admin_options
widget_recent-posts
can_compress_scripts
widget_theysaidso_widget
db_upgraded
widget_recent-comments

Browser metrics Passed 4 tests

This is an overview of browser requirements for Knowledge Base for Documentation, FAQs with AI Assistance
Minimal impact on browser resources
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,845 ▲8314.43 ▲0.192.02 ▲0.3841.18 ▼3.55
Dashboard /wp-admin2,244 ▲735.61 ▲0.0196.95 ▼0.2242.00 ▲0.82
Posts /wp-admin/edit.php2,149 ▲491.97 ▲0.0340.08 ▲0.8835.85 ▼1.30
Add New Post /wp-admin/post-new.php1,568 ▲4223.19 ▲0.16600.41 ▼82.7951.39 ▲0.29
Media Library /wp-admin/upload.php1,455 ▲584.18 ▼0.0098.12 ▼0.8845.63 ▲3.74
Analytics /wp-admin/edit.php?post_type=epkb_post_type_1&page=epkb-plugin-analytics1,8373.0365.1476.71
All Articles /wp-admin/edit.php?post_type=epkb_post_type_11,8892.4355.7350.96
Add-ons / News /wp-admin/edit.php?post_type=epkb_post_type_1&page=epkb-add-ons5,48916.33542.4977.61
Categories /wp-admin/edit-tags.php?taxonomy=epkb_post_type_1_category&post_type=epkb_post_type_16,8844.0673.14118.57
Tags /wp-admin/edit-tags.php?taxonomy=epkb_post_type_1_tag&post_type=epkb_post_type_12,1593.9762.1890.45
Configuration /wp-admin/edit.php?post_type=epkb_post_type_1&page=epkb-kb-configuration1,6812.2741.8445.58
Add New Article /wp-admin/post-new.php?post_type=epkb_post_type_16,89320.37945.5954.59
Get Started /wp-admin/edit.php?post_type=epkb_post_type_1&page=epkb-kb-need-help4,7312.3244.4248.96

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

🔸 Tests weight: 35 | It is important to correctly uninstall your plugin, without leaving any traces
The following items require your attention
  • This plugin did not uninstall successfully, leaving 6 options in the database
    • can_compress_scripts
    • widget_recent-posts
    • widget_recent-comments
    • db_upgraded
    • theysaidso_admin_options
    • widget_theysaidso_widget

Smoke tests 50% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | This is a shallow check for server-side errors
Everything seems fine, however this is by no means an exhaustive test

SRP 50% from 2 tests

🔹 Tests weight: 20 | It is important to ensure that your PHP files perform no action when accessed directly, respecting the single-responsibility principle
Please take a closer look at the following
  • 26× GET requests to PHP files trigger server-side errors or Error 500 responses (only 10 are shown):
    • > PHP Fatal error
      Uncaught Error: Call to undefined function epkb_get_instance() in wp-content/plugins/echo-knowledge-base/templates/layout-categories.php:11
    • > PHP Fatal error
      Uncaught Error: Class 'EPKB_Editor_KB_Base_Config' not found in wp-content/plugins/echo-knowledge-base/includes/admin/editor/class-epkb-editor-search-page-config.php:7
    • > PHP Fatal error
      Uncaught Error: Call to undefined function epkb_get_instance() in wp-content/plugins/echo-knowledge-base/templates/layout-basic.php:11
    • > PHP Fatal error
      Uncaught Error: Call to undefined function add_filter() in wp-content/plugins/echo-knowledge-base/includes/system/plugin-links.php:24
    • > PHP Fatal error
      Uncaught Error: Class 'EPKB_Editor_KB_Base_Config' not found in wp-content/plugins/echo-knowledge-base/includes/admin/editor/class-epkb-editor-archive-page-config.php:7
    • > PHP Fatal error
      Uncaught Error: Call to undefined function add_action() in wp-content/plugins/echo-knowledge-base/includes/system/class-epkb-help-pointers.php:171
    • > PHP Fatal error
      Uncaught Error: Call to undefined function add_action() in wp-content/plugins/echo-knowledge-base/includes/admin/admin-functions.php:74
    • > PHP Fatal error
      Uncaught Error: Call to undefined function post_password_required() in wp-content/plugins/echo-knowledge-base/templates/feature-comments.php:18
    • > PHP Fatal error
      Uncaught Error: Class 'EPKB_Layout' not found in wp-content/plugins/echo-knowledge-base/includes/features/layouts/class-epkb-layout-basic.php:8
    • > PHP Fatal error
      Uncaught Error: Class 'EPKB_Utilities' not found in wp-content/plugins/echo-knowledge-base/templates/feature-navigation-back.php:20

User-side errors 0% from 1 test

🔹 Test weight: 20 | Just a short smoke test targeting errors on the browser (console and network errors and warnings)
Please fix the following user-side errors
    • > GET request to /wp-admin/edit.php?post_type=epkb_post_type_1&page=epkb-plugin-analytics
    • > Console-api (warning) in unknown
    /wp-admin/load-scripts.php?c=0&load%5Bchunk_0%5D=jquery-core,jquery-migrate,utils,jquery-ui-core,jquery-ui-mouse,jquery-ui-resizable,jquery-ui-draggable,jquery-ui-controlgroup,j&load%5Bchunk_1%5D=query-ui-checkboxradio,jquery-ui-button,jquery-ui-dialog,jquery-effects-core,jquery-effects-bounce,jquery-ui-sortable&ver=6.3.1 1:28609 "jQuery.Deferred exception: Cannot read properties of null (reading 'getContext')" "TypeError: Cannot read properties of null (reading 'getContext')\n at e (/wp-content/plugins/echo-knowledge-base/js/admin-analytics.min.js?ver=11.1.0:1:906)\n at HTMLDocument.\u003Canonymous> (/wp-content/plugins/echo-knowledge-base/js/admin-analytics.min.js?ver=11.1.0:1:1189)\n at e (/wp-admin/load-scripts.php?c=0&load%5Bchunk_0%5D=jquery-core,jquery-migrate,utils,jquery-ui-core,jquery-ui-mouse,jquery-ui-resizable,jquery-ui-draggable,jquery-ui-controlgroup,j&load%5Bchunk_1%5D=query-ui-checkboxradio,jquery-ui-button,jquery-ui-dialog,jquery-effects-core,jquery-effects-bounce,jquery-ui-sortable&ver=6.3.1:2:26990)\n at t (/wp-admin/load-scripts.php?c=0&load%5Bchunk_0%5D=jquery-core,jquery-migrate,utils,jquery-ui-core,jquery-ui-mouse,jquery-ui-resizable,jquery-ui-draggable,jquery-ui-controlgroup,j&load%5Bchunk_1%5D=query-ui-checkboxradio,jquery-ui-button,jquery-ui-dialog,jquery-effects-core,jquery-effects-bounce,jquery-ui-sortable&ver=6.3.1:2:27292)" undefined
    • > GET request to /wp-admin/edit.php?post_type=epkb_post_type_1&page=epkb-plugin-analytics
    • > Javascript (severe) in unknown
    /wp-admin/load-scripts.php?c=0&load%5Bchunk_0%5D=jquery-core,jquery-migrate,utils,jquery-ui-core,jquery-ui-mouse,jquery-ui-resizable,jquery-ui-draggable,jquery-ui-controlgroup,j&load%5Bchunk_1%5D=query-ui-checkboxradio,jquery-ui-button,jquery-ui-dialog,jquery-effects-core,jquery-effects-bounce,jquery-ui-sortable&ver=6.3.1 1:28721 Uncaught TypeError: Cannot read properties of null (reading 'getContext')
    • > GET request to /wp-admin/post-new.php?post_type=epkb_post_type_1
    • > Console-api (warning) in wp-includes/js/dist/deprecated.min.js?ver=73ad3591e7bc95f4777a+1:627
    Using custom components as toolbar controls is deprecated since version 5.6. Please use ToolbarItem, ToolbarButton or ToolbarDropdownMenu components instead. See: https://developer.wordpress.org/block-editor/components/toolbar-button/#inside-blockcontrols

Optimizations

Plugin configuration 97% from 29 tests

readme.txt 94% from 16 tests

The readme.txt file describes your plugin functionality and requirements and it is parsed to prepare the your plugin's listing
Attributes that need to be fixed:
  • Tags: Too many tags (15 tag instead of maximum 10); only the first 5 tags are used in your directory listing
You can take inspiration from this readme.txt

echo-knowledge-base/echo-knowledge-base.php Passed 13 tests

"Knowledge Base for Documentation, FAQs with AI Assistance" version 11.1.0's primary PHP file adds more information about the plugin and serves as the entry point for WordPress
51 characters long description:
Create Echo Knowledge Base articles, docs and FAQs.

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | A short check of programming languages and file extensions; no executable files are allowed
Success! There were no dangerous files found in this plugin100,034 lines of code in 216 files:
LanguageFilesBlank linesComment linesLines of code
CSS674,8481,66049,877
PHP1137,6458,67138,846
JavaScript332,5461,3187,857
SVG2002,746
XML100708

PHP code Passed 2 tests

This is a short overview of cyclomatic complexity and code structure for this plugin
This plugin has no cyclomatic complexity problems
Cyclomatic complexity
Average complexity per logical line of code0.50
Average class complexity50.92
▷ Minimum class complexity1.00
▷ Maximum class complexity358.00
Average method complexity5.77
▷ Minimum method complexity1.00
▷ Maximum method complexity70.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes96
▷ Abstract classes44.17%
▷ Concrete classes9295.83%
▷ Final classes11.09%
Methods1,007
▷ Static methods62361.87%
▷ Public methods62562.07%
▷ Protected methods131.29%
▷ Private methods36936.64%
Functions57
▷ Named functions5291.23%
▷ Anonymous functions58.77%
Constants88
▷ Global constants22.27%
▷ Class constants8697.73%
▷ Public constants86100.00%

Plugin size 50% from 2 tests

Image compression 50% from 2 tests

Using a strong compression for your PNG files is a great way to speed-up your plugin
58 PNG files occupy 1.38MB with 0.83MB in potential savings
Potential savings
Compression of 5 random PNG files using pngquant
FileSize - originalSize - compressedSavings
img/demo-icons/icons/mouse-icon.png50.67KB21.74KB▼ 57.10%
img/demo-icons/icons/document-pencil-icon.png44.41KB17.95KB▼ 59.59%
img/demo-icons/icons/operations.png48.88KB20.64KB▼ 57.77%
img/demo-icons/icons/globe-icon.png62.33KB26.89KB▼ 56.85%
img/setting-icons/search-box-icon-active.png1.43KB0.46KB▼ 67.85%