79% better-contextual-help

Code Review | Better Contextual Help

WordPress plugin Better Contextual Help scored79%from 54 tests.

About plugin

  • Plugin page: better-contextual...
  • Plugin version: 1.0
  • PHP version: 7.4.16
  • WordPress compatibility: 3.8-4.1
  • WordPress version: 6.3.1
  • First release: Dec 29, 2014
  • Latest release: Dec 30, 2014
  • Number of updates: 6
  • Update frequency: every 8.7 days
  • Top authors: potreb (100%)

Code review

54 tests

User reviews

1 review

Install metrics

10+ active /732 total downloads


Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | It is important to correctly install your plugin, without throwing errors or notices
The plugin installed gracefully, with no errors

Server metrics [RAM: ▼0.11MB] [CPU: ▼15.45ms] Passed 4 tests

A check of server-side resources used by Better Contextual Help
This plugin has minimal impact on server resources
PageMemory (MB)CPU Time (ms)
Home /3.53 ▲0.0744.60 ▲5.14
Dashboard /wp-admin3.25 ▼0.0529.93 ▼19.53
Posts /wp-admin/edit.php3.31 ▼0.0434.83 ▼6.69
Add New Post /wp-admin/post-new.php5.50 ▼0.3877.26 ▼27.93
Media Library /wp-admin/upload.php3.26 ▲0.0329.10 ▼7.63
Contextual Help /wp-admin/edit.php?post_type=wp_help3.2932.49

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

Analyzing filesystem and database footprints of this plugin
The plugin installed successfully
Filesystem: 4 new files
Database: no new tables, 6 new options
New WordPress options

Browser metrics Passed 4 tests

Better Contextual Help: an overview of browser usage
Minimal impact on browser resources
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,810 ▲7513.20 ▼1.212.19 ▲0.2641.77 ▼3.59
Dashboard /wp-admin2,216 ▲314.86 ▼1.0098.76 ▲0.5936.57 ▼1.03
Posts /wp-admin/edit.php2,093 ▲42.00 ▲0.0135.46 ▼6.5434.87 ▼0.16
Add New Post /wp-admin/post-new.php1,550 ▲818.57 ▲0.19587.29 ▼27.3952.63 ▼3.91
Media Library /wp-admin/upload.php1,398 ▲104.23 ▲0.0498.26 ▼12.2341.36 ▼1.88
Contextual Help /wp-admin/edit.php?post_type=wp_help1,0841.9633.5729.45

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
The following items require your attention
  • This plugin does not fully uninstall, leaving 6 options in the database
    • widget_recent-comments
    • widget_theysaidso_widget
    • theysaidso_admin_options
    • can_compress_scripts
    • db_upgraded
    • widget_recent-posts

Smoke tests 50% from 4 tests

Server-side errors 0% from 1 test

🔹 Test weight: 20 | This is a shallow check for server-side errors
Smoke test failed, please fix the following
    • > GET request to /wp-admin/edit.php?post_type=wp_help
    • > User deprecated in wp-includes/functions.php+5828
    Hook contextual_help is deprecated since version 3.3.0! Use get_current_screen()->add_help_tab(), get_current_screen()->remove_help_tab() instead.

SRP 50% from 2 tests

🔹 Tests weight: 20 | The single-responsibility principle: PHP files have to remain inert when accessed directly, throwing no errors and performing no actions
Almost there! Just fix the following items
  • 1× GET requests to PHP files trigger server-side errors or Error 500 responses:
    • > PHP Fatal error
      Uncaught Error: Call to undefined function load_plugin_textdomain() in wp-content/plugins/better-contextual-help/better-contextual-help.php:13

User-side errors Passed 1 test

🔹 Test weight: 20 | A shallow check that no browser errors were triggered
There were no browser issues found


Plugin configuration Passed 29 tests

readme.txt Passed 16 tests

Perhaps the most important file in your plugin readme.txt gets parsed in order to generate the public listing of your plugin
5 plugin tags: contextual help, user help, documentation, help, docs

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

The primary PHP file in "Better Contextual Help" version 1.0 is used by WordPress to initiate all plugin functionality
109 characters long description:
Extend your Wordpress Help by add new tabs or replacing old. You can add tabs for specific roles and screens.

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | Executable files are considered dangerous and should not be included with any WordPress plugin
Success! There were no dangerous files found in this plugin231 lines of code in 2 files:
LanguageFilesBlank linesComment linesLines of code
PO File16910977

PHP code Passed 2 tests

Cyclomatic complexity and code structure are the fingerprint of this plugin
No cyclomatic complexity issues were detected for this plugin
Cyclomatic complexity
Average complexity per logical line of code0.35
Average class complexity24.00
▷ Minimum class complexity24.00
▷ Maximum class complexity24.00
Average method complexity3.56
▷ Minimum method complexity1.00
▷ Maximum method complexity10.00
Code structure
▷ Abstract classes00.00%
▷ Concrete classes1100.00%
▷ Final classes00.00%
▷ Static methods00.00%
▷ Public methods9100.00%
▷ Protected methods00.00%
▷ Private methods00.00%
▷ Named functions00.00%
▷ Anonymous functions00.00%
▷ Global constants00.00%
▷ Class constants00.00%
▷ Public constants00.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

All PNG images should be compressed to minimize bandwidth usage for end users
No PNG images were found in this plugin