84% gravity-forms-help-scout-search

Code Review | Gravity Forms - Help Scout Docs Search Field

WordPress plugin Gravity Forms - Help Scout Docs Search Field scored 84% from 54 tests.

About plugin

  • Plugin page: gravity-forms-hel...
  • Plugin version: 3.0.2
  • PHP version: 7.4.16
  • WordPress compatibility: 3.6-4.6
  • WordPress version: 5.8.1
  • First release: Jun 28, 2016
  • Latest release: Jul 8, 2016
  • Number of updates: 8
  • Update frequency: every 1.3 days
  • Top authors: mordauk (100%)

Code review

54 tests

User reviews

2 reviews

Install metrics

40+ active / 1,110 total downloads

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | The install procedure must perform silently
Installer ran successfully

Server metrics [RAM: ▼1.76MB] [CPU: ▼185.49ms] Passed 4 tests

This is a short check of server-side resources used by Gravity Forms - Help Scout Docs Search Field
Normal server usage
PageMemory (MB)CPU Time (ms)
Home /1.87 ▼0.975.35 ▼28.71
Dashboard /wp-admin1.89 ▼1.175.74 ▼37.60
Posts /wp-admin/edit.php1.89 ▼1.226.22 ▼38.77
Add New Post /wp-admin/post-new.php1.89 ▼3.556.10 ▼636.88
Media Library /wp-admin/upload.php1.89 ▼1.125.76 ▼26.89

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

How much does this plugin use your filesystem and database?
There were no storage issued detected upon installing this plugin
Filesystem: 5 new files
Database: no new tables, no new options

Browser metrics Passed 4 tests

Gravity Forms - Help Scout Docs Search Field: an overview of browser usage
There were no issues detected in relation to browser resource usage
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /3,679 ▲10715.94 ▲0.288.16 ▼2.6143.89 ▼3.28
Dashboard /wp-admin2,973 ▲396.11 ▲0.15135.05 ▼11.20102.09 ▼6.07
Posts /wp-admin/edit.php2,739 ▼02.72 ▲0.0171.27 ▲5.1288.47 ▼6.40
Add New Post /wp-admin/post-new.php1,672 ▼20018.83 ▼0.33341.96 ▼40.13107.51 ▼1.26
Media Library /wp-admin/upload.php1,810 ▲35.02 ▼0.03144.04 ▼1.18117.84 ▼1.01

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

🔸 Tests weight: 35 | Verifying that this plugin uninstalls completely without leaving any traces
It is recommended to fix the following
  • Uninstall procedure validation failed for this plugin
    • > User notice in wp-includes/functions.php+5663
    PW_GF_HS_Search::__construct was called incorrectly. The Help Scout Docs Search Field plugin requires a base URL. Define it using the `HELPSCOUT_DOCS_BASE_URL` constant, or set it using the `gf_helpscout_docs_base_url` filter Please see Debugging in WordPress for more information. (This message was added in version 3.0.2.)

Smoke tests 75% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | A smoke test targeting server-side errors
The smoke test was a success, however most plugin functionality was not tested

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
Please fix the following
  • 1× GET requests to PHP files trigger server-side errors or Error 500 responses:
    • > PHP Fatal error
      Uncaught Error: Call to undefined function add_action() in wp-content/plugins/gravity-forms-help-scout-search/gravity-forms-help-scout-search.php:184

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

Often overlooked, readme.txt is one of the most important files in your plugin
4 plugin tags: help scout, gravity forms, helpscout, documentation

gravity-forms-help-scout-search/gravity-forms-help-scout-search.php Passed 13 tests

"Gravity Forms - Help Scout Docs Search Field" version 3.0.2's primary PHP file adds more information about the plugin and serves as the entry point for WordPress
55 characters long description:
Adds a special text field for searching Help Scout docs

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
Good job! No executable or dangerous file extensions detected256 lines of code in 3 files:
LanguageFilesBlank linesComment linesLines of code
JavaScript28550164
PHP1335992

PHP code Passed 2 tests

A brief analysis of cyclomatic complexity and code structure for this plugin
This plugin has no cyclomatic complexity issues
Cyclomatic complexity
Average complexity per logical line of code0.33
Average class complexity10.00
▷ Minimum class complexity10.00
▷ Maximum class complexity10.00
Average method complexity2.29
▷ Minimum method complexity1.00
▷ Maximum method complexity4.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes1
▷ Abstract classes00.00%
▷ Concrete classes1100.00%
▷ Final classes00.00%
Methods7
▷ Static methods00.00%
▷ Public methods685.71%
▷ Protected methods00.00%
▷ Private methods114.29%
Functions1
▷ Named functions1100.00%
▷ Anonymous functions00.00%
Constants2
▷ Global constants00.00%
▷ Class constants2100.00%
▷ Public constants2100.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

Often times overlooked, PNG files can occupy unnecessary space in your plugin
There were not PNG files found in your plugin