84% help-manager

Code Review | Help Manager

WordPress plugin Help Manager scored84%from 54 tests.

About plugin

  • Plugin page: help-manager
  • Plugin version: 1.0.0
  • PHP compatiblity: 5.6+
  • PHP version: 7.4.16
  • WordPress compatibility: 4.9-5.9
  • WordPress version: 6.3.1
  • First release: Jan 26, 2022
  • Latest release: Jan 26, 2022
  • Number of updates: 4
  • Update frequency: every 4.0 days
  • Top authors: bohemiaplugins (100%)

Code review

54 tests

User reviews

2 reviews

Install metrics

20+ active /977 total downloads

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | Verifying that this plugin installs correctly without errors
Install script ran successfully

Server metrics [RAM: ▲0.45MB] [CPU: ▼1.62ms] Passed 4 tests

An overview of server-side resources used by Help Manager
Server-side resource usage in normal parameters
PageMemory (MB)CPU Time (ms)
Home /3.86 ▲0.4047.40 ▲5.76
Dashboard /wp-admin3.79 ▲0.4864.47 ▲16.60
Posts /wp-admin/edit.php3.84 ▲0.4863.53 ▲13.66
Add New Post /wp-admin/post-new.php6.39 ▲0.5088.24 ▼25.48
Media Library /wp-admin/upload.php3.65 ▲0.4238.09 ▼0.41
Settings /wp-admin/admin.php?page=help-manager-settings3.8739.40
Documents /wp-admin/admin.php?page=help-manager-documents3.6944.37
Tools /wp-admin/admin.php?page=help-manager-tools3.6437.32
Manage /wp-admin/edit.php?post_type=help-docs3.8142.86
Add New /wp-admin/post-new.php?post_type=help-docs6.1780.99

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

A short overview of filesystem and database impact
The plugin installed successfully
Filesystem: 36 new files
Database: no new tables, 7 new options
New WordPress options
can_compress_scripts
db_upgraded
theysaidso_admin_options
widget_recent-comments
help-manager-permissions
widget_theysaidso_widget
widget_recent-posts

Browser metrics Passed 4 tests

Help Manager: an overview of browser usage
This plugin renders optimally with no browser resource issues detected
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,965 ▲21913.23 ▼1.355.56 ▲3.8849.59 ▲9.27
Dashboard /wp-admin2,331 ▲1435.86 ▼0.02109.73 ▲12.9484.10 ▲41.57
Posts /wp-admin/edit.php2,148 ▲592.06 ▲0.0537.87 ▲1.5933.00 ▼4.86
Add New Post /wp-admin/post-new.php1,556 ▲3223.42 ▲0.46708.98 ▲33.5348.06 ▼8.96
Media Library /wp-admin/upload.php1,444 ▲564.23 ▲0.0898.26 ▼18.6043.17 ▼6.32
Settings /wp-admin/admin.php?page=help-manager-settings1,1333.5471.1733.17
Documents /wp-admin/admin.php?page=help-manager-documents1,1582.1440.8943.49
Tools /wp-admin/admin.php?page=help-manager-tools1,0183.2260.6923.67
Manage /wp-admin/edit.php?post_type=help-docs1,7932.0032.6632.83
Add New /wp-admin/post-new.php?post_type=help-docs6,20724.18796.8833.02

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

🔸 Tests weight: 35 | The uninstall procedure must remove all plugin files and extra database tables
Please fix the following items
  • This plugin did not uninstall successfully, leaving 6 options in the database
    • can_compress_scripts
    • db_upgraded
    • widget_theysaidso_widget
    • widget_recent-posts
    • theysaidso_admin_options
    • widget_recent-comments

Smoke tests 75% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | This is a shallow check for server-side errors
Even though everything seems fine, this is not an exhaustive test

SRP Passed 2 tests

🔹 Tests weight: 20 | SRP (Single-Responsibility Principle) - PHP files must act as libraries and never output text or perform any action when accessed directly in a browser
Everything seems fine, however this is by no means an exhaustive test

User-side errors 0% from 1 test

🔹 Test weight: 20 | This is a smoke test targeting browser errors/issues
Please fix the following browser errors
    • > GET request to /wp-admin/post-new.php?post_type=help-docs
    • > Console-api (warning) in unknown
    /wp-includes/js/dist/block-editor.min.js?ver=0cd49e3f951fc97cabb7 25:219944 "help-manager-gutenberg-css was added to the iframe incorrectly. Please use block.json or enqueue_block_assets to add styles to the iframe." link#help-manager-gutenberg-css

Optimizations

Plugin configuration 96% from 29 tests

readme.txt Passed 16 tests

You should put a lot of thought into formatting readme.txt as it is used by WordPress.org to prepare the public listing of your plugin
5 plugin tags: documentation, clients, help, docs, client sites

help-manager/help-manager.php 92% from 13 tests

The main PHP file in "Help Manager" ver. 1.0.0 adds more information about the plugin and also serves as the entry point for this plugin
Please take the time to fix the following:
  • Description: Please keep the plugin description shorter than 140 characters (currently 141 characters long)

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | This is an overview of programming languages used in this plugin; dangerous file extensions are not allowed
No dangerous file extensions were detected2,229 lines of code in 29 files:
LanguageFilesBlank linesComment linesLines of code
PHP166039622,212
CSS7007
JavaScript5005
XML1005

PHP code Passed 2 tests

This is a very shot review of cyclomatic complexity and code structure
There were no cyclomatic complexity issued detected
Cyclomatic complexity
Average complexity per logical line of code0.41
Average class complexity31.86
▷ Minimum class complexity1.00
▷ Maximum class complexity207.00
Average method complexity3.78
▷ Minimum method complexity1.00
▷ Maximum method complexity27.00
Code structure
Namespaces1
Interfaces0
Traits0
Classes7
▷ Abstract classes00.00%
▷ Concrete classes7100.00%
▷ Final classes00.00%
Methods78
▷ Static methods56.41%
▷ Public methods7494.87%
▷ Protected methods00.00%
▷ Private methods45.13%
Functions4
▷ Named functions125.00%
▷ Anonymous functions375.00%
Constants1
▷ Global constants1100.00%
▷ Class constants00.00%
▷ Public constants00.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

Often times overlooked, PNG files can occupy unnecessary space in your plugin
2 PNG files occupy 0.00MB with 0.00MB in potential savings
Potential savings
Compression of 2 random PNG files using pngquant
FileSize - originalSize - compressedSavings
admin/assets/img/document.png1.22KB0.44KB▼ 63.91%
admin/assets/img/handle.png1.00KB0.16KB▼ 84.36%