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

Code Review | A Note Above - WP Dashboard Notes

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

About plugin

  • Plugin page: a-note-above-wp-d...
  • Plugin version: 2.0.2
  • PHP compatiblity: 7.0+
  • PHP version: 7.4.16
  • WordPress compatibility: 5.0-6.4.1
  • WordPress version: 6.3.1
  • First release: May 19, 2021
  • Latest release: Nov 12, 2023
  • Number of updates: 20
  • Update frequency: every 45.5 days
  • Top authors: brownbrowniebrownerson (100%)

Code review

54 tests

User reviews

1 review

Install metrics

100+ active /813 total downloads

Benchmarks

Plugin footprint 65% 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.12MB] [CPU: ▼3.76ms] Passed 4 tests

An overview of server-side resources used by A Note Above - WP Dashboard Notes
Normal server usage
PageMemory (MB)CPU Time (ms)
Home /3.57 ▲0.1139.00 ▼1.66
Dashboard /wp-admin3.43 ▲0.1248.13 ▼2.85
Posts /wp-admin/edit.php3.54 ▲0.1851.16 ▲6.04
Add New Post /wp-admin/post-new.php6.04 ▲0.1585.80 ▼12.17
Media Library /wp-admin/upload.php3.35 ▲0.1232.55 ▲1.63

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

A short overview of filesystem and database impact
No storage issues were detected
Filesystem: 34 new files
Database: 1 new table, 9 new options
New tables
wp__anoteabove
New WordPress options
theysaidso_admin_options
widget_recent-posts
anoteabove_stack
anoteabove_installed
can_compress_scripts
widget_recent-comments
anoteabove_version
widget_theysaidso_widget
db_upgraded

Browser metrics Passed 4 tests

Checking browser requirements for A Note Above - WP Dashboard Notes
There were no issues detected in relation to browser resource usage
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,880 ▲11814.76 ▲0.411.70 ▼0.0238.23 ▼5.80
Dashboard /wp-admin2,285 ▲1086.49 ▲0.91116.60 ▲21.1442.73 ▼2.96
Posts /wp-admin/edit.php2,103 ▲31.94 ▼0.0339.94 ▼3.6034.21 ▼2.72
Add New Post /wp-admin/post-new.php1,526 ▼023.21 ▼0.10598.13 ▼76.9359.38 ▲7.58
Media Library /wp-admin/upload.php1,400 ▼34.24 ▼0.0398.61 ▲0.6741.23 ▲0.15

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

🔸 Tests weight: 35 | The uninstall procedure must remove all plugin files and extra database tables
It is recommended to fix the following
  • Zombie tables detected upon uninstall: 1 table
    • wp__anoteabove
  • This plugin does not fully uninstall, leaving 9 options in the database
    • anoteabove_version
    • theysaidso_admin_options
    • anoteabove_stack
    • can_compress_scripts
    • anoteabove_installed
    • widget_theysaidso_widget
    • db_upgraded
    • widget_recent-comments
    • widget_recent-posts

Smoke tests 75% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | A shallow check that no server-side errors were triggered
Even though everything seems fine, this is not an exhaustive test

SRP 50% from 2 tests

🔹 Tests weight: 20 | A shallow check of the single-responsibility principle; PHP files should perform no action - including output of placeholder text - and trigger no errors when accessed directly
Please take a closer look at the following
  • 2× GET requests to PHP files have triggered server-side errors or warnings:
    • > 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
    • > 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

User-side errors Passed 1 test

🔹 Test weight: 20 | This is a smoke test targeting browser errors/issues
Everything seems fine on the user side

Optimizations

Plugin configuration 90% from 29 tests

readme.txt 94% from 16 tests

Often overlooked, readme.txt is one of the most important files in your plugin
Attributes that require attention:
  • Screenshots: These screenshots require images: #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.)
The official readme.txt is a good inspiration

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

The main file in "A Note Above - WP Dashboard Notes" v. 2.0.2 serves as a complement to information provided in readme.txt and as the entry point to the plugin
Please take the time to fix the following:
  • Main file name: Please rename the main PHP file in this plugin to the plugin slug ("a-note-above-wp-dashboard-notes.php" instead of "anoteabove.php")
  • Text Domain: Since WordPress version 4.6 the text domain is optional; if specified, it must be the same as the plugin slug

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | An overview of files in this plugin; executable files are not allowed
Good job! No executable or dangerous file extensions 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

An overview of cyclomatic complexity and code structure
Although this was not an exhaustive test, there were no cyclomatic 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

All PNG images should be compressed to minimize bandwidth usage for end users
No PNG files were detected