100% dashboard-instruction-guide

Code Review | Dashboard Instruction Guide

WordPress plugin Dashboard Instruction Guide scored 100% 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: 5.8.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 / 99 total downloads

Benchmarks

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

Server metrics [RAM: ▲0.04MB] [CPU: ▼144.74ms] Passed 4 tests

Analyzing server-side resources used by Dashboard Instruction Guide
No issues were detected with server-side resource usage
PageMemory (MB)CPU Time (ms)
Home /2.88 ▲0.0426.51 ▲2.36
Dashboard /wp-admin3.11 ▲0.0442.95 ▼1.89
Posts /wp-admin/edit.php3.16 ▲0.0537.90 ▲3.45
Add New Post /wp-admin/post-new.php5.47 ▲0.0376.87 ▼582.87
Media Library /wp-admin/upload.php3.05 ▲0.0427.28 ▲5.92
Dashboard Instruction Guide /wp-admin/admin.php?page=dashboard-instruction-guide3.0826.73
All Instructions /wp-admin/admin.php?page=all-instruction3.0220.90

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

Input-output and database impact of this plugin
This plugin was installed successfully
Filesystem: 8 new files
Database: no new tables, no new options

Browser metrics Passed 4 tests

Dashboard Instruction Guide: an overview of browser usage
There were no issues detected in relation to browser resource usage
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /3,704 ▲9815.67 ▲0.025.31 ▼0.3875.95 ▲0.18
Dashboard /wp-admin2,970 ▲745.99 ▼0.12115.61 ▼17.67173.94 ▼0.65
Posts /wp-admin/edit.php2,779 ▲393.37 ▲0.1366.91 ▲2.64133.19 ▼1.06
Add New Post /wp-admin/post-new.php2,342 ▼1,35619.43 ▲0.66369.66 ▼100.55209.21 ▲39.96
Media Library /wp-admin/upload.php1,785 ▲335.53 ▼0.02134.42 ▼7.17186.24 ▼0.07
Dashboard Instruction Guide /wp-admin/admin.php?page=dashboard-instruction-guide2,0828.77158.86185.30
All Instructions /wp-admin/admin.php?page=all-instruction1,1292.3856.15102.17

Uninstaller [IO: ▲0.00MB] [DB: ▲0.00MB] Passed 4 tests

🔸 Tests weight: 35 | Checking the uninstaller removed all traces of the plugin
The plugin uninstalled successfully, without leaving any zombie files or tables

Smoke tests Passed 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | A shallow check that no server-side errors were triggered
Everything seems fine, however this is by no means an exhaustive test

SRP Passed 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
Looking good! No server-side errors or output on direct access of PHP files

User-side errors Passed 1 test

🔹 Test weight: 20 | This is a shallow check for browser errors
Everything seems fine on the user side

Optimizations

Plugin configuration Passed 29 tests

readme.txt Passed 16 tests

It's important to format your readme.txt file correctly as it is parsed for the public listing of your plugin
3 plugin tags: dashboard, document, helper

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 | A short check of programming languages and file extensions; no executable files are allowed
Success! There were no dangerous files found in this plugin553 lines of code in 5 files:
LanguageFilesBlank linesComment linesLines of code
PHP312574412
CSS18076
JavaScript120565

PHP code Passed 2 tests

A brief analysis of cyclomatic complexity and code structure for 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

PNG files should be compressed to save space and minimize bandwidth usage
There are no PNG files in this plugin