73% a-note-above-wp-dashboard-notes

Code Review | A Note Above - WP Dashboard Notes

WordPress plugin A Note Above - WP Dashboard Notes scored 73% from 54 tests.

About plugin

  • Plugin page: a-note-above-wp-d...
  • Plugin version: 2.0.1
  • PHP compatiblity: 7.0+
  • PHP version: 7.4.16
  • WordPress compatibility: 5.0-5.8.1
  • WordPress version: 5.9.2
  • First release: May 19, 2021
  • Latest release: Sep 16, 2021
  • Number of updates: 18
  • Update frequency: every 6.8 days
  • Top authors: brownbrowniebrownerson (100%)

Code review

54 tests

User reviews

1 review

Install metrics

20+ active / 277 total downloads

Benchmarks

Plugin footprint 65% from 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 gracefully, with no errors

Server metrics [RAM: ▲0.11MB] [CPU: ▼301.90ms] Passed 4 tests

A check of server-side resources used by A Note Above - WP Dashboard Notes
Server-side resource usage in normal parameters
PageMemory (MB)CPU Time (ms)
Home /3.69 ▲0.1757.20 ▼44.26
Dashboard /wp-admin3.54 ▲0.1437.69 ▼0.07
Posts /wp-admin/edit.php3.76 ▲0.1243.39 ▼1.27
Add New Post /wp-admin/post-new.php7.01 ▲0.0495.37 ▼1,159.59
Media Library /wp-admin/upload.php3.42 ▲0.1225.71 ▼2.49

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

A short overview of filesystem and database impact
This plugin was installed successfully
Filesystem: 34 new files
Database: 1 new table, 3 new options
New tables
wp__anoteabove
New WordPress options
anoteabove_version
anoteabove_stack
anoteabove_installed

Browser metrics Passed 4 tests

A check of browser resources used by A Note Above - WP Dashboard Notes
This plugin renders optimally with no browser resource issues detected
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /3,908 ▲18617.84 ▲2.066.21 ▼2.912.54 ▼0.10
Dashboard /wp-admin3,001 ▲1478.09 ▲1.94145.13 ▲6.08167.84 ▲3.80
Posts /wp-admin/edit.php2,691 ▼03.23 ▲0.0062.21 ▼2.24139.50 ▼7.08
Add New Post /wp-admin/post-new.php1,759 ▲4822.96 ▲1.60440.33 ▼10.19166.31 ▼43.44
Media Library /wp-admin/upload.php1,695 ▼35.48 ▼0.03179.31 ▲35.82201.85 ▲3.20

Uninstaller [IO: ▲0.00MB] [DB: ▲0.00MB] 50% 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
  • The uninstall procedure failed, leaving 1 table in the database
    • wp__anoteabove
  • This plugin did not uninstall successfully, leaving 3 options in the database
    • anoteabove_installed
    • anoteabove_stack
    • anoteabove_version

Smoke tests 75% from 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)
Good news, no errors were detected

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
Almost there! Just fix the following items
  • 2× GET requests to PHP files trigger server-side errors or Error 500 responses:
    • > PHP Fatal error
      Uncaught Error: Class 'WP_REST_Controller' not found in wp-content/plugins/a-note-above-wp-dashboard-notes/includes/Api.php:9
    • > PHP Fatal error
      Uncaught Error: Class 'WP_REST_Controller' not found in wp-content/plugins/a-note-above-wp-dashboard-notes/includes/Api/WPNAPI.php:9

User-side errors Passed 1 test

🔹 Test weight: 20 | This is just a short smoke test looking for browser issues
There were no browser issues found

Optimizations

Plugin configuration 90% from 29 tests

readme.txt 94% from 16 tests

Don't ignore readme.txt as it is the file that instructs WordPress.org on how to present your plugin to the world
Attributes that need to be fixed:
  • Screenshots: These screenshots have no corresponding images in /assets: #1 (Click 'Add A Note' for the note edit panel to appear), #2 (Click 'Visibility' to open the visibility control panel), #3 (Notes can be assigned visibility from all users, to only your user profile, to ranges of capabilities.)
Please take inspiration from this readme.txt

a-note-above-wp-dashboard-notes/anoteabove.php 85% from 13 tests

This is the main PHP file of "A Note Above - WP Dashboard Notes" version 2.0.1, providing information about the plugin in the header fields and serving as the principal entry point to the plugin's functions
It is important to fix the following:
  • Main file name: Name the main plugin file the same as the plugin slug ("a-note-above-wp-dashboard-notes.php" instead of "anoteabove.php")
  • Text Domain: You no longer need to specify the text domain since WordPress 4.6; it must be the same as the plugin slug

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | This is a short overview of programming languages used in this plugin, detecting executable files
No dangerous file extensions were detected23,564 lines of code in 29 files:
LanguageFilesBlank linesComment linesLines of code
JSON40021,514
Vuejs Component7105131,163
PHP5192280566
JavaScript113337278
Markdown116042
CSS1001

PHP code Passed 2 tests

Analyzing cyclomatic complexity and code structure
No complexity issues detected
Cyclomatic complexity
Average complexity per logical line of code0.25
Average class complexity10.00
▷ Minimum class complexity1.00
▷ Maximum class complexity21.00
Average method complexity1.92
▷ Minimum method complexity1.00
▷ Maximum method complexity8.00
Code structure
Namespaces2
Interfaces0
Traits0
Classes5
▷ Abstract classes00.00%
▷ Concrete classes5100.00%
▷ Final classes120.00%
Methods49
▷ Static methods12.04%
▷ Public methods3367.35%
▷ Protected methods00.00%
▷ Private methods1632.65%
Functions0
▷ Named functions00.00%
▷ Anonymous functions00.00%
Constants6
▷ Global constants6100.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 were not PNG files found in your plugin