90% beacon-for-helpscout

Code Review | Beacon For Help Scout

WordPress plugin Beacon For Help Scout scored90%from 54 tests.

About plugin

  • Plugin page: beacon-for-helpscout
  • Plugin version: 1.3.0
  • PHP version: 7.4.16
  • WordPress compatibility: 3.0-4.7.3
  • WordPress version: 6.3.1
  • First release: Sep 25, 2015
  • Latest release: Apr 10, 2017
  • Number of updates: 18
  • Update frequency: every 42.4 days
  • Top authors: section214 (94.44%)evertiro (11.11%)

Code review

54 tests

User reviews

12 reviews

Install metrics

30+ active /2,754 total downloads


Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | All plugins must install correctly, without throwing any errors, warnings, or notices
The plugin installed gracefully, with no errors

Server metrics [RAM: ▲0.46MB] [CPU: ▼4.03ms] Passed 4 tests

An overview of server-side resources used by Beacon For Help Scout
No issues were detected with server-side resource usage
PageMemory (MB)CPU Time (ms)
Home /3.84 ▲0.3841.01 ▲2.14
Dashboard /wp-admin3.82 ▲0.4849.34 ▼9.30
Posts /wp-admin/edit.php3.90 ▲0.5448.30 ▲0.28
Add New Post /wp-admin/post-new.php6.38 ▲0.5087.06 ▼9.23
Media Library /wp-admin/upload.php3.71 ▲0.4837.51 ▲3.10
Beacon /wp-admin/options-general.php?page=beacon-settings3.7340.34

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

Input-output and database impact of this plugin
There were no storage issued detected upon installing this plugin
Filesystem: 89 new files
Database: no new tables, 7 new options
New WordPress options

Browser metrics Passed 4 tests

Checking browser requirements for Beacon For Help Scout
This plugin renders optimally with no browser resource issues detected
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,886 ▲14013.88 ▼0.349.21 ▲7.3742.61 ▲4.17
Dashboard /wp-admin2,207 ▲265.59 ▼0.1484.63 ▼18.6438.28 ▼1.66
Posts /wp-admin/edit.php2,112 ▲152.04 ▲0.0335.18 ▼0.4433.62 ▼2.85
Add New Post /wp-admin/post-new.php1,537 ▼223.32 ▲4.83625.04 ▼36.5649.89 ▼25.96
Media Library /wp-admin/upload.php1,415 ▲154.23 ▼0.0095.86 ▲0.7341.27 ▼1.47
Beacon /wp-admin/options-general.php?page=beacon-settings1,1754.1562.8935.95

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

🔸 Tests weight: 35 | It is important to correctly uninstall your plugin, without leaving any traces
You still need to fix the following
  • Zombie WordPress options detected upon uninstall: 7 options
    • theysaidso_admin_options
    • beacon_settings
    • widget_recent-posts
    • widget_theysaidso_widget
    • widget_recent-comments
    • can_compress_scripts
    • db_upgraded

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)
Even though no errors were found, this is by no means an exhaustive test

SRP Passed 2 tests

🔹 Tests weight: 20 | The single-responsibility principle applies for WordPress plugins as well - please make sure your PHP files perform no actions when accessed directly
No output text or server-side errors detected on direct access of PHP files

User-side errors Passed 1 test

🔹 Test weight: 20 | Just a short smoke test targeting errors on the browser (console and network errors and warnings)
Everything seems fine on the user side


Plugin configuration 96% from 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
3 plugin tags: help scout, helpscout, beacon

beacon-for-helpscout/beacon-for-helpscout.php 92% from 13 tests

"Beacon For Help Scout" version 1.3.0's main PHP file describes plugin functionality and also serves as the entry point to any WordPress functionality
You should first fix the following items:
  • Text Domain: Since WordPress version 4.6 the text domain is optional; if specified, it must be the same as the plugin slug

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | Executable files are not allowed as they can serve as attack vectors
No dangerous file extensions were detected6,167 lines of code in 51 files:
LanguageFilesBlank linesComment linesLines of code

PHP code Passed 2 tests

An overview of cyclomatic complexity and code structure
This plugin has no cyclomatic complexity problems
Cyclomatic complexity
Average complexity per logical line of code0.44
Average class complexity72.50
▷ Minimum class complexity5.00
▷ Maximum class complexity165.00
Average method complexity4.46
▷ Minimum method complexity1.00
▷ Maximum method complexity35.00
Code structure
▷ Abstract classes00.00%
▷ Concrete classes6100.00%
▷ Final classes00.00%
▷ Static methods10.81%
▷ Public methods11693.55%
▷ Protected methods00.00%
▷ Private methods86.45%
▷ Named functions11100.00%
▷ Anonymous functions00.00%
▷ Global constants3100.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
7 PNG files occupy 0.44MB with 0.30MB in potential savings
Potential savings
Compression of 5 random PNG files using pngquant
FileSize - originalSize - compressedSavings
assets/banner-772x250.png38.57KB9.96KB▼ 74.18%
assets/icon-256x256.png34.37KB8.58KB▼ 75.02%
assets/img/collection-id.png160.33KB44.42KB▼ 72.29%
assets/banner-1544x500.png76.16KB29.34KB▼ 61.47%
assets/banner-1544x500-rtl.png77.86KB29.49KB▼ 62.13%