94% wp-contextual-help

Code Review | WP Contextual Help

WordPress plugin WP Contextual Help scored 94% from 53 tests.

About plugin

  • Plugin page: wp-contextual-help
  • Plugin version: 1.0.2
  • PHP version: 7.4.16
  • WordPress compatibility: 3.3-4.1
  • WordPress version: 5.8.1
  • First release: Jul 22, 2014
  • Latest release: Jan 5, 2015
  • Number of updates: 19
  • Update frequency: every 8.8 days
  • Top authors: kevinlangleyjr (89.47%)csloisel (15.79%)

Code review

53 tests

User reviews

1 review

Install metrics

10+ active / 664 total downloads
Download (27.75 KB)

Benchmarks

Plugin footprint Passed 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | Checking the installer triggered no errors
This plugin's installer ran successfully

Server metrics [RAM: ▲0.00MB] [CPU: ▼870.83ms] Passed 4 tests

Server-side resources used by WP Contextual Help
Server-side resource usage in normal parameters
PageMemory (MB)CPU Time (ms)
Home /2.71 ▼0.0126.06 ▲3.98
Dashboard /wp-admin3.06 ▲0.0146.86 ▼6.52
Posts /wp-admin/edit.php3.11 ▲0.0143.42 ▲0.66
Add New Post /wp-admin/post-new.php5.43 ▲0.111,609.31 ▼3,481.44
Media Library /wp-admin/upload.php3.00 ▲0.0040.15 ▲7.37

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

Analyzing filesystem and database footprints of this plugin
This plugin installed successfully
Filesystem: 3 new files
Database: no new tables, no new options

Browser metrics Passed 4 tests

This is an overview of browser requirements for WP Contextual Help
This plugin renders optimally with no browser resource issues detected
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /3,647 ▲4115.86 ▲0.4218.38 ▲9.1858.55 ▲8.90
Dashboard /wp-admin2,922 ▲696.06 ▲0.03171.58 ▲22.88105.82 ▼2.82
Posts /wp-admin/edit.php2,706 ▼02.69 ▲0.0284.69 ▲13.24102.99 ▲15.74
Add New Post /wp-admin/post-new.php1,656 ▲315.92 ▼2.71408.29 ▲31.66113.70 ▼6.12
Media Library /wp-admin/upload.php1,775 ▲35.02 ▼0.06172.31 ▲24.00135.09 ▲24.20

Uninstaller [IO: ▲0.00MB] [DB: ▲0.71MB] Passed 4 tests

🔸 Tests weight: 35 | It is important to correctly uninstall your plugin, without leaving any traces
Uninstaller ran successfully

Smoke tests 75% 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 50% from 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
The following issues need your attention
  • 1× PHP files trigger errors when accessed directly with GET requests:
    • > PHP Fatal error
      Uncaught Error: Call to undefined function add_action() in wp-content/plugins/wp-contextual-help/wp-contextual-help.php:141

User-side errors Passed 1 test

🔹 Test weight: 20 | This is just a short smoke test looking for browser issues
Everything seems fine, but this is not an exhaustive test

Optimizations

Plugin configuration 97% from 29 tests

readme.txt 94% from 16 tests

Perhaps the most important file in your plugin readme.txt gets parsed in order to generate the public listing of your plugin
Attributes that need to be fixed:
  • Screenshots: Screenshot #1 (Example display of a custom help tab) image not found
You can look at the official readme.txt

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

The entry point to "WP Contextual Help" version 1.0.2 is a PHP file that has certain tags in its header comment area
90 characters long description:
Allows a developer to easily extend the contextual help dropdown content area in WordPress

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
There were no executable files found in this plugin88 lines of code in 1 file:
LanguageFilesBlank linesComment linesLines of code
PHP1203588

PHP code Passed 2 tests

A short review of cyclomatic complexity and code structure
This plugin has no cyclomatic complexity problems
Cyclomatic complexity
Average complexity per logical line of code0.47
Average class complexity18.00
▷ Minimum class complexity18.00
▷ Maximum class complexity18.00
Average method complexity4.40
▷ Minimum method complexity2.00
▷ Maximum method complexity6.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes1
▷ Abstract classes00.00%
▷ Concrete classes1100.00%
▷ Final classes00.00%
Methods5
▷ Static methods5100.00%
▷ Public methods5100.00%
▷ Protected methods00.00%
▷ Private methods00.00%
Functions0
▷ Named functions00.00%
▷ Anonymous functions00.00%
Constants0
▷ Global constants00.00%
▷ Class constants00.00%
▷ Public constants00.00%

Plugin size Passed 1 test

Image compression Passed 1 test

Using a strong compression for your PNG files is a great way to speed-up your plugin
1 PNG file occupies 0.03MB with 0.01MB in potential savings
Potential savings
Compression of 1 random PNG file using pngquant
FileSize - originalSize - compressedSavings
assets/screenshot-1.png26.52KB11.41KB▼ 57.00%