78% custom-welcome-guide

Code Review | Custom Welcome Guide

WordPress plugin Custom Welcome Guide scored 78% from 54 tests.

About plugin

  • Plugin page: custom-welcome-guide
  • Plugin version: 1.0.3
  • PHP compatiblity: 5.6+
  • PHP version: 7.4.16
  • WordPress compatibility: 5.4-5.8
  • WordPress version: 5.8.1
  • First release: Sep 14, 2021
  • Latest release: Oct 26, 2021
  • Number of updates: 18
  • Update frequency: every 2.3 days
  • Top authors: nravota12 (100%)

Code review

54 tests

User reviews

1 review

Install metrics

10+ active / 165 total downloads

Benchmarks

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 successfully, without throwing any errors or notices

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

An overview of server-side resources used by Custom Welcome Guide
This plugin has minimal impact on server resources
PageMemory (MB)CPU Time (ms)
Home /2.89 ▲0.1736.04 ▲13.76
Dashboard /wp-admin3.13 ▲0.0748.63 ▼2.95
Posts /wp-admin/edit.php3.22 ▲0.1053.61 ▲16.96
Add New Post /wp-admin/post-new.php5.56 ▲0.13107.47 ▼540.65
Media Library /wp-admin/upload.php3.08 ▲0.0635.86 ▼10.31
Settings /wp-admin/edit.php?post_type=guides&page=custom_welcome_guide3.0530.55
All Guides /wp-admin/edit.php?post_type=guides3.1134.85
Add New /wp-admin/post-new.php?post_type=guides5.5493.84

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

Analyzing filesystem and database footprints of this plugin
This plugin installed successfully
Filesystem: 25 new files
Database: no new tables, 1 new option
New WordPress options
cwg_options

Browser metrics Passed 4 tests

Checking browser requirements for Custom Welcome Guide
There were no issues detected in relation to browser resource usage
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /3,806 ▲22420.19 ▲4.6811.55 ▲2.4054.34 ▲0.41
Dashboard /wp-admin3,093 ▲1599.61 ▲3.51237.14 ▲82.22124.57 ▲5.67
Posts /wp-admin/edit.php2,893 ▲1547.25 ▲4.56137.84 ▲73.58105.15 ▲11.08
Add New Post /wp-admin/post-new.php1,756 ▲7318.35 ▼0.11354.26 ▼38.88133.02 ▲14.13
Media Library /wp-admin/upload.php1,948 ▲1419.00 ▲3.99197.33 ▲39.90144.58 ▲9.92
Settings /wp-admin/edit.php?post_type=guides&page=custom_welcome_guide1,2637.42143.2488.41
All Guides /wp-admin/edit.php?post_type=guides1,5807.02133.1780.49
Add New /wp-admin/post-new.php?post_type=guides5,70116.73474.05112.11

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

🔸 Tests weight: 35 | Checking the uninstaller removed all traces of the plugin
The following items require your attention
  • This plugin did not uninstall successfully, leaving 1 option in the database
    • cwg_options

Smoke tests 50% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | A shallow check that no server-side errors were triggered
Even though no errors were found, this is by no means an exhaustive test

SRP 0% from 2 tests

🔹 Tests weight: 20 | It is important to ensure that your PHP files perform no action when accessed directly, respecting the single-responsibility principle
Please fix the following
  • 1× PHP files perform the action of outputting non-empty strings when accessed directly:
    • > /wp-content/plugins/custom-welcome-guide/index.php
  • 1× PHP files trigger server-side errors or warnings when accessed directly:
    • > PHP Fatal error
      Uncaught Error: Call to undefined function add_action() in wp-content/plugins/custom-welcome-guide/inc/guide.php:49

User-side errors Passed 1 test

🔹 Test weight: 20 | This is a smoke test targeting browser errors/issues
There were no browser issues found

Optimizations

Plugin configuration 93% from 29 tests

readme.txt Passed 16 tests

The readme.txt file uses markdown syntax to describe your plugin to the world
5 plugin tags: tour, introduction, walkthrough, block-editor, user-onboarding

custom-welcome-guide/index.php 85% from 13 tests

The entry point to "Custom Welcome Guide" version 1.0.3 is a PHP file that has certain tags in its header comment area
It is important to fix the following:
  • Main file name: The principal plugin file should be the same as the plugin slug ("custom-welcome-guide.php" instead of "index.php")
  • Description: Keep the plugin description shorter than 140 characters (currently 221 characters long)

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | This is an overview of file extensions present in this plugin and a short test that no dangerous files are bundled with this plugin
Success! There were no dangerous files found in this plugin37,404 lines of code in 22 files:
LanguageFilesBlank linesComment linesLines of code
JSON20036,586
JavaScript117493495
PHP43158201
Sass212498
Markdown116022
CSS2002

PHP code Passed 2 tests

This is a very shot review of cyclomatic complexity and code structure
No complexity issues detected
Cyclomatic complexity
Average complexity per logical line of code0.19
Average class complexity0.00
▷ Minimum class complexity0.00
▷ Maximum class complexity0.00
Average method complexity0.00
▷ Minimum method complexity0.00
▷ Maximum method complexity0.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes0
▷ Abstract classes00.00%
▷ Concrete classes00.00%
▷ Final classes00.00%
Methods0
▷ Static methods00.00%
▷ Public methods00.00%
▷ Protected methods00.00%
▷ Private methods00.00%
Functions13
▷ Named functions13100.00%
▷ Anonymous functions00.00%
Constants0
▷ 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