84% custom-help

Code Review | Custom Help

WordPress plugin Custom Help scored 84% from 54 tests.

About plugin

  • Plugin page: custom-help
  • Plugin version: 1.0.1
  • PHP compatiblity: 5.5+
  • PHP version: 7.4.16
  • WordPress compatibility: 3.0.1-6.0.1
  • WordPress version: 6.3.1
  • First release: Feb 18, 2022
  • Latest release: Jul 27, 2022
  • Number of updates: 12
  • Update frequency: every 13.3 days
  • Top authors: codents (100%)

Code review

54 tests

User reviews

4 reviews

Install metrics

10+ active / 318 total downloads

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | Checking the installer triggered no errors
Install script ran successfully

Server metrics [RAM: ▲0.07MB] [CPU: ▼11.55ms] Passed 4 tests

A check of server-side resources used by Custom Help
This plugin does not affect your website's performance
PageMemory (MB)CPU Time (ms)
Home /3.72 ▲0.2636.48 ▼5.32
Dashboard /wp-admin3.43 ▲0.1333.71 ▼13.41
Posts /wp-admin/edit.php3.50 ▲0.1438.88 ▼6.77
Add New Post /wp-admin/post-new.php5.68 ▼0.2077.57 ▼20.70
Media Library /wp-admin/upload.php3.44 ▲0.2132.38 ▼1.61

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

How much does this plugin use your filesystem and database?
The plugin installed successfully
Filesystem: 19 new files
Database: 1 new table, 7 new options
New tables
wp_customhelp
New WordPress options
widget_recent-posts
can_compress_scripts
theysaidso_admin_options
customhelp_version
widget_recent-comments
widget_theysaidso_widget
db_upgraded

Browser metrics Passed 4 tests

This is an overview of browser requirements for Custom Help
This plugin renders optimally with no browser resource issues detected
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,917 ▲16014.82 ▲0.261.74 ▼0.2739.82 ▲0.45
Dashboard /wp-admin2,326 ▲1354.87 ▼0.0196.63 ▼6.3966.33 ▲23.48
Posts /wp-admin/edit.php2,206 ▲1142.00 ▲0.0037.61 ▲2.2335.26 ▲4.00
Add New Post /wp-admin/post-new.php1,645 ▲13123.19 ▲5.65701.97 ▲48.9654.73 ▲2.62
Media Library /wp-admin/upload.php1,499 ▲1084.21 ▲0.02104.73 ▲7.2174.43 ▲28.40

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
The following items require your attention
  • Zombie WordPress options detected upon uninstall: 6 options
    • can_compress_scripts
    • widget_recent-posts
    • widget_recent-comments
    • widget_theysaidso_widget
    • theysaidso_admin_options
    • db_upgraded

Smoke tests 75% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | A smoke test targeting server-side errors
Even though no errors were found, this is by no means an exhaustive test

SRP 50% from 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
The following issues need your attention
  • 1× GET requests to PHP files have triggered server-side errors or warnings:
    • > PHP Fatal error
      Uncaught Error: Call to undefined function esc_attr() in wp-content/plugins/custom-help/templates/help_tab_content.php:4

User-side errors Passed 1 test

🔹 Test weight: 20 | This is a smoke test targeting browser errors/issues
There were no browser issues 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
4 plugin tags: management, documentation, help, support

custom-help/custom-help.php Passed 13 tests

The primary PHP file in "Custom Help" version 1.0.1 is used by WordPress to initiate all plugin functionality
54 characters long description:
Plugin to add custom documentation to all admin pages.

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | A short review of files and their extensions; it is not recommended to include executable files
No dangerous file extensions were detected1,773 lines of code in 13 files:
LanguageFilesBlank linesComment linesLines of code
PHP94653591,609
CSS210108
JavaScript28056

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.47
Average class complexity44.50
▷ Minimum class complexity1.00
▷ Maximum class complexity230.00
Average method complexity3.87
▷ Minimum method complexity1.00
▷ Maximum method complexity24.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes6
▷ Abstract classes00.00%
▷ Concrete classes6100.00%
▷ Final classes00.00%
Methods91
▷ Static methods44.40%
▷ Public methods2426.37%
▷ Protected methods5863.74%
▷ Private methods99.89%
Functions3
▷ Named functions3100.00%
▷ Anonymous functions00.00%
Constants5
▷ Global constants480.00%
▷ Class constants120.00%
▷ Public constants1100.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

Using a strong compression for your PNG files is a great way to speed-up your plugin
2 PNG files occupy 0.01MB with 0.01MB in potential savings
Potential savings
Compression of 2 random PNG files using pngquant
FileSize - originalSize - compressedSavings
assets/images/header-background.png3.33KB0.13KB▼ 95.99%
assets/images/custom-help.png8.11KB2.42KB▼ 70.10%