90% dashboard-instruction-guide

Code Review | Dashboard Instruction Guide

WordPress plugin Dashboard Instruction Guide scored90%from 54 tests.

About plugin

  • Plugin page: dashboard-instruc...
  • Plugin version: 1.0.0
  • PHP compatiblity: 5.6+
  • PHP version: 7.4.16
  • WordPress compatibility: 4.4-5.8.1
  • WordPress version: 6.3.1
  • First release: Oct 14, 2021
  • Latest release: Oct 14, 2021
  • Number of updates: 2
  • Update frequency: N/A
  • Top authors: sajidulislam0 (100%)

Code review

54 tests

User reviews

1 review

Install metrics

10+ active /298 total downloads

Benchmarks

Plugin footprint 83% from 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.03MB] [CPU: ▼8.36ms] Passed 4 tests

An overview of server-side resources used by Dashboard Instruction Guide
Normal server usage
PageMemory (MB)CPU Time (ms)
Home /3.51 ▲0.0533.90 ▼5.45
Dashboard /wp-admin3.35 ▲0.0044.46 ▼17.07
Posts /wp-admin/edit.php3.40 ▲0.0443.80 ▼0.36
Add New Post /wp-admin/post-new.php5.95 ▲0.0781.26 ▼10.55
Media Library /wp-admin/upload.php3.27 ▲0.0437.22 ▲6.62
All Instructions /wp-admin/admin.php?page=all-instruction3.2431.58
Dashboard Instruction Guide /wp-admin/admin.php?page=dashboard-instruction-guide3.3036.35

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

Filesystem and database footprint
The plugin installed successfully
Filesystem: 8 new files
Database: no new tables, 6 new options
New WordPress options
widget_recent-comments
theysaidso_admin_options
can_compress_scripts
widget_theysaidso_widget
db_upgraded
widget_recent-posts

Browser metrics Passed 4 tests

A check of browser resources used by Dashboard Instruction Guide
Normal browser usage
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,819 ▲5814.28 ▼0.451.71 ▼0.0339.90 ▼8.03
Dashboard /wp-admin2,228 ▲485.64 ▲0.0390.27 ▲1.2438.45 ▲1.26
Posts /wp-admin/edit.php2,130 ▲302.02 ▼0.1136.20 ▲0.8031.19 ▼3.67
Add New Post /wp-admin/post-new.php1,410 ▼11621.50 ▼1.39501.35 ▼100.7542.99 ▼32.36
Media Library /wp-admin/upload.php1,430 ▲304.21 ▼0.0599.39 ▼6.2442.78 ▼4.18
All Instructions /wp-admin/admin.php?page=all-instruction8362.0023.0624.67
Dashboard Instruction Guide /wp-admin/admin.php?page=dashboard-instruction-guide1,6206.55141.9756.85

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

🔸 Tests weight: 35 | Checking the uninstaller removed all traces of the plugin
It is recommended to fix the following
  • Zombie WordPress options were found after uninstall: 6 options
    • widget_theysaidso_widget
    • theysaidso_admin_options
    • can_compress_scripts
    • widget_recent-comments
    • db_upgraded
    • widget_recent-posts

Smoke tests Passed 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | This is a short smoke test looking for server-side errors
Everything seems fine, however this is by no means an exhaustive test

SRP Passed 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
Everything seems fine, however this is by no means an exhaustive test

User-side errors Passed 1 test

🔹 Test weight: 20 | A shallow check that no browser errors were triggered
Everything seems fine on the user side

Optimizations

Plugin configuration Passed 29 tests

readme.txt Passed 16 tests

The readme.txt file is undoubtedly the most important file in your plugin, preparing it for public listing on WordPress.org
3 plugin tags: document, helper, dashboard

dashboard-instruction-guide/dashboard-instruction-guide.php Passed 13 tests

The primary PHP file in "Dashboard Instruction Guide" version 1.0.0 is used by WordPress to initiate all plugin functionality
82 characters long description:
This plugin will help you to add documents/instructions for individual post types.

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
No dangerous file extensions were detected553 lines of code in 5 files:
LanguageFilesBlank linesComment linesLines of code
PHP312574412
CSS18076
JavaScript120565

PHP code Passed 2 tests

Cyclomatic complexity and code structure are the fingerprint of this plugin
Great job! No cyclomatic complexity issues were detected in this plugin
Cyclomatic complexity
Average complexity per logical line of code0.20
Average class complexity7.00
▷ Minimum class complexity7.00
▷ Maximum class complexity7.00
Average method complexity1.50
▷ Minimum method complexity1.00
▷ Maximum method complexity3.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes1
▷ Abstract classes00.00%
▷ Concrete classes1100.00%
▷ Final classes00.00%
Methods12
▷ Static methods00.00%
▷ Public methods12100.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 2 tests

Image compression Passed 2 tests

Using a strong compression for your PNG files is a great way to speed-up your plugin
There are no PNG files in this plugin