79% helppress

Code Review | HelpPress Knowledge Base

WordPress plugin HelpPress Knowledge Base scored79%from 54 tests.

About plugin

  • Plugin page: helppress
  • Plugin version: 3.1.4
  • PHP version: 7.4.16
  • WordPress compatibility: 4.4-5.6
  • WordPress version: 6.3.1
  • First release: Sep 7, 2017
  • Latest release: Nov 24, 2020
  • Number of updates: 25
  • Update frequency: every 47.0 days
  • Top authors: helppresswp (60%)GalenGidman (44%)

Code review

54 tests

User reviews

3 reviews

Install metrics

100+ active /3,358 total downloads

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | All plugins must install correctly, without throwing any errors, warnings, or notices
The plugin installed successfully, without throwing any errors or notices

Server metrics [RAM: ▲1.00MB] [CPU: ▲1.28ms] Passed 4 tests

Server-side resources used by HelpPress Knowledge Base
No issues were detected with server-side resource usage
PageMemory (MB)CPU Time (ms)
Home /4.20 ▲0.7350.13 ▼3.96
Dashboard /wp-admin4.43 ▲1.1261.90 ▲9.51
Posts /wp-admin/edit.php4.46 ▲1.1058.00 ▲4.07
Add New Post /wp-admin/post-new.php7.11 ▲1.2296.36 ▼4.50
Media Library /wp-admin/upload.php4.29 ▲1.0650.14 ▲12.56
All Articles /wp-admin/edit.php?post_type=hp_article4.4149.53
Add New /wp-admin/post-new.php?post_type=hp_article7.12104.21
Settings /wp-admin/edit.php?post_type=hp_article&page=helppress_options4.7855.44
Article Categories /wp-admin/edit-tags.php?taxonomy=hp_category&post_type=hp_article4.2946.11
Article Tags /wp-admin/edit-tags.php?taxonomy=hp_tag&post_type=hp_article4.2947.58

Server storage [IO: ▲3.76MB] [DB: ▲0.00MB] Passed 3 tests

Filesystem and database footprint
No storage issues were detected
Filesystem: 494 new files
Database: no new tables, 7 new options
New WordPress options
can_compress_scripts
theysaidso_admin_options
db_upgraded
widget_recent-comments
helppress_version
widget_recent-posts
widget_theysaidso_widget

Browser metrics Passed 4 tests

This is an overview of browser requirements for HelpPress Knowledge Base
This plugin has a minimal impact on browser resources
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,934 ▲17313.51 ▼0.8410.73 ▲8.0539.90 ▼6.64
Dashboard /wp-admin2,249 ▲725.72 ▲0.0692.89 ▼1.0542.31 ▲1.31
Posts /wp-admin/edit.php2,157 ▲572.07 ▲0.0937.86 ▼2.0033.88 ▼3.58
Add New Post /wp-admin/post-new.php1,575 ▲4923.09 ▼0.50678.93 ▲45.5854.12 ▲1.08
Media Library /wp-admin/upload.php1,457 ▲574.25 ▲0.0497.85 ▼10.7842.92 ▲1.04
All Articles /wp-admin/edit.php?post_type=hp_article1,2042.0537.9132.07
Add New /wp-admin/post-new.php?post_type=hp_article6,34223.74944.0433.20
Settings /wp-admin/edit.php?post_type=hp_article&page=helppress_options1,3902.4332.6749.36
Article Categories /wp-admin/edit-tags.php?taxonomy=hp_category&post_type=hp_article1,3332.2035.6541.13
Article Tags /wp-admin/edit-tags.php?taxonomy=hp_tag&post_type=hp_article1,2992.2329.4932.26

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

🔸 Tests weight: 35 | All plugins must uninstall correctly, removing their source code and extra database tables they might have created
Please fix the following items
  • This plugin did not uninstall successfully, leaving 7 options in the database
    • widget_recent-comments
    • widget_recent-posts
    • can_compress_scripts
    • widget_theysaidso_widget
    • theysaidso_admin_options
    • helppress_version
    • db_upgraded

Smoke tests 50% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | This is a shallow check for server-side errors
Good news, no errors were detected

SRP 0% from 2 tests

🔹 Tests weight: 20 | The single-responsibility principle applies for WordPress plugins as well - please make sure your PHP files perform no actions when accessed directly
Almost there! Just fix the following items
  • 1× GET requests to PHP files return non-empty strings:
    • > /wp-content/plugins/helppress/includes/vendor/cmb2/cmb2/apigen/hook-docs.php
  • 68× PHP files trigger server errors when accessed directly (only 10 are shown):
    • > PHP Fatal error
      Uncaught Error: Class 'CMB2_Type_Taxonomy_Base' not found in wp-content/plugins/helppress/includes/vendor/cmb2/cmb2/includes/types/CMB2_Type_Taxonomy_Radio.php:13
    • > PHP Fatal error
      Uncaught Error: Call to undefined function helppress_get_option() in wp-content/plugins/helppress/templates/parts/helppress-breadcrumb.php:3
    • > PHP Fatal error
      Uncaught Error: Call to undefined function add_action() in wp-content/plugins/helppress/includes/vendor/cmb2/cmb2/includes/helper-functions.php:131
    • > PHP Fatal error
      Uncaught Error: Class 'CMB2_Base' not found in wp-content/plugins/helppress/includes/vendor/cmb2/cmb2/includes/CMB2.php:21
    • > PHP Fatal error
      Uncaught Error: Call to undefined function do_action() in wp-content/plugins/helppress/templates/parts/helppress-open-content.php:1
    • > PHP Fatal error
      Uncaught Error: Call to undefined function get_header() in wp-content/plugins/helppress/templates/helppress-search.php:3
    • > PHP Fatal error
      Uncaught Error: Class 'CMB2_Type_Picker_Base' not found in wp-content/plugins/helppress/includes/vendor/cmb2/cmb2/includes/types/CMB2_Type_Text_Datetime_Timestamp.php:13
    • > PHP Fatal error
      Uncaught Error: Class 'CMB2_REST_Controller' not found in wp-content/plugins/helppress/includes/vendor/cmb2/cmb2/includes/rest-api/CMB2_REST_Controller_Boxes.php:17
    • > PHP Warning
      file_put_contents(/Users/JT/Sites/wpengine/api/hook-docs.html): failed to open stream: No such file or directory in wp-content/plugins/helppress/includes/vendor/cmb2/cmb2/apigen/hook-docs.php on line 229
    • > PHP Fatal error
      Uncaught Error: Class 'CMB2_Base' not found in wp-content/plugins/helppress/includes/vendor/cmb2/cmb2/includes/CMB2_Field.php:17

User-side errors Passed 1 test

🔹 Test weight: 20 | Just a short smoke test targeting errors on the browser (console and network errors and warnings)
No browser issues were found

Optimizations

Plugin configuration Passed 29 tests

readme.txt Passed 16 tests

Don't ignore readme.txt as it is the file that instructs WordPress.org on how to present your plugin to the world
5 plugin tags: helpdesk, knowledgebase, help desk, knowledge base, wiki

helppress/helppress.php Passed 13 tests

The entry point to "HelpPress Knowledge Base" version 3.1.4 is a PHP file that has certain tags in its header comment area
94 characters long description:
A powerful and easy-to-use knowledge base plugin for WordPress, compatible with 99% of themes.

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | Executable files are not allowed as they can serve as attack vectors
No dangerous file extensions were detected58,974 lines of code in 308 files:
LanguageFilesBlank linesComment linesLines of code
PO File12014,31518,50232,323
PHP1083,2458,10810,745
CSS163941,2025,163
JSON7004,478
JavaScript186898013,325
Sass26335291,590
Markdown736501,079
SVG100104
Bourne Shell121899
XML261434
YAML17023
HTML16011

PHP code Passed 2 tests

A brief analysis of cyclomatic complexity and code structure for this plugin
There were no cyclomatic complexity issued detected
Cyclomatic complexity
Average complexity per logical line of code0.44
Average class complexity19.45
▷ Minimum class complexity1.00
▷ Maximum class complexity186.00
Average method complexity3.20
▷ Minimum method complexity1.00
▷ Maximum method complexity31.00
Code structure
Namespaces3
Interfaces0
Traits0
Classes86
▷ Abstract classes910.47%
▷ Concrete classes7789.53%
▷ Final classes11.30%
Methods724
▷ Static methods12116.71%
▷ Public methods59982.73%
▷ Protected methods11816.30%
▷ Private methods70.97%
Functions79
▷ Named functions7898.73%
▷ Anonymous functions11.27%
Constants26
▷ Global constants1038.46%
▷ Class constants1661.54%
▷ Public constants16100.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

It is recommended to compress PNG files in your plugin to minimize bandwidth usage
22 compressed PNG files occupy 0.02MB
Potential savings
Compression of 5 random PNG files using pngquant
FileSize - originalSize - compressedSavings
includes/vendor/cmb2/cmb2/images/ui-icons_888888_256x240.png5.23KB4.11KB▼ 21.49%
includes/vendor/cmb2/cmb2/apigen/theme-bootstrap/src/resources/tree-last.png0.17KB0.11KB▼ 36.05%
includes/vendor/cmb2/cmb2/images/ui-icons_454545_256x240.png4.27KB4.11KB▼ 3.78%
includes/vendor/cmb2/cmb2/images/ui-bg_glass_75_e6e6e6_1x400.png0.11KB0.14KB0.00%
includes/vendor/cmb2/cmb2/images/ui-bg_highlight-soft_75_cccccc_1x100.png0.10KB0.17KB0.00%