90% wp-help

Code Review | WP Help

WordPress plugin WP Help scored 90% from 54 tests.

About plugin

  • Plugin page: wp-help
  • Plugin version: 1.7.4
  • PHP version: 7.4.16
  • WordPress compatibility: 4.9-6.3
  • WordPress version: 6.3.1
  • First release: May 18, 2011
  • Latest release: Aug 10, 2023
  • Number of updates: 190
  • Update frequency: every 23.5 days
  • Top authors: markjaquith (100%)

Code review

54 tests

User reviews

49 reviews

Install metrics

10,000+ active / 200,525 total downloads

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | Checking the installer triggered no errors
The plugin installed successfully, without throwing any errors or notices

Server metrics [RAM: ▲0.09MB] [CPU: ▼5.30ms] Passed 4 tests

Analyzing server-side resources used by WP Help
Normal server usage
PageMemory (MB)CPU Time (ms)
Home /3.54 ▲0.0838.06 ▼4.64
Dashboard /wp-admin3.38 ▲0.0846.55 ▼2.29
Posts /wp-admin/edit.php3.49 ▲0.1347.73 ▼2.55
Add New Post /wp-admin/post-new.php6.04 ▲0.1588.40 ▼11.72
Media Library /wp-admin/upload.php3.30 ▲0.0739.08 ▲2.44

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

Filesystem and database footprint
This plugin was installed successfully
Filesystem: 18 new files
Database: no new tables, 7 new options
New WordPress options
theysaidso_admin_options
db_upgraded
can_compress_scripts
widget_theysaidso_widget
widget_recent-posts
widget_recent-comments
cws_wp_help

Browser metrics Passed 4 tests

A check of browser resources used by WP Help
Normal browser usage
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,818 ▲8314.80 ▲0.561.71 ▼0.2539.46 ▼15.78
Dashboard /wp-admin2,221 ▲334.88 ▼0.18106.68 ▼12.8542.54 ▼4.49
Posts /wp-admin/edit.php2,107 ▲152.06 ▲0.0638.64 ▼3.5037.08 ▲5.80
Add New Post /wp-admin/post-new.php1,555 ▲1323.07 ▲4.81651.05 ▲35.3658.02 ▲8.32
Media Library /wp-admin/upload.php1,403 ▲124.19 ▲0.0193.35 ▲0.4245.00 ▲2.24

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
It is recommended to fix the following
  • Zombie WordPress options were found after uninstall: 7 options
    • cws_wp_help
    • can_compress_scripts
    • widget_recent-posts
    • widget_recent-comments
    • widget_theysaidso_widget
    • db_upgraded
    • theysaidso_admin_options

Smoke tests Passed 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | Just a short smoke test targeting errors on the server (in the Apache logs)
Everything seems fine, however 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
Everything seems fine, however this is by no means an exhaustive test

User-side errors Passed 1 test

🔹 Test weight: 20 | A shallow check that no browser errors were triggered
No browser errors were detected

Optimizations

Plugin configuration Passed 29 tests

readme.txt Passed 16 tests

The readme.txt file is important because it is parsed by WordPress.org for the public listing of your plugin
5 plugin tags: client sites, docs, help, documentation, clients

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

The main PHP script in "WP Help" version 1.7.4 is automatically included on every request by WordPress
131 characters long description:
Administrators can create detailed, hierarchical documentation for the site's authors and editors, viewable in the WordPress admin.

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
Everything looks great! No dangerous files found in this plugin964 lines of code in 15 files:
LanguageFilesBlank linesComment linesLines of code
PHP11130118960
CSS2002
JavaScript2002

PHP code Passed 2 tests

A brief analysis of cyclomatic complexity and code structure for this plugin
There are no cyclomatic complexity problems detected for this plugin
Cyclomatic complexity
Average complexity per logical line of code0.40
Average class complexity44.67
▷ Minimum class complexity6.00
▷ Maximum class complexity120.00
Average method complexity2.66
▷ Minimum method complexity1.00
▷ Maximum method complexity23.00
Code structure
Namespaces0
Interfaces0
Traits1
Classes2
▷ Abstract classes00.00%
▷ Concrete classes2100.00%
▷ Final classes00.00%
Methods78
▷ Static methods56.41%
▷ Public methods5266.67%
▷ Protected methods2126.92%
▷ Private methods56.41%
Functions2
▷ Named functions00.00%
▷ Anonymous functions2100.00%
Constants7
▷ Global constants00.00%
▷ Class constants7100.00%
▷ Public constants7100.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
1 PNG file occupies 0.00MB with 0.00MB in potential savings
Potential savings
Compression of 1 random PNG file using pngquant
FileSize - originalSize - compressedSavings
images/sort.png0.22KB0.16KB▼ 27.39%