84% eacreadme

Code Review | {eac}Doojigger Readme Extension for WordPress

WordPress plugin {eac}Doojigger Readme Extension for WordPress scored84%from 54 tests.

About plugin

  • Plugin page: eacreadme
  • Plugin version: 1.2.3
  • PHP compatiblity: 7.2+
  • PHP version: 7.4.16
  • WordPress compatibility: 5.5.0-6.3
  • WordPress version: 6.3.1
  • First release: Jul 26, 2022
  • Latest release: Sep 2, 2023
  • Number of updates: 38
  • Update frequency: every 10.6 days
  • Top authors: kevinburkholder (100%)

Code review

54 tests

User reviews

1 review

Install metrics

10+ active /808 total downloads

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | The install procedure must perform silently
The plugin installed successfully, without throwing any errors or notices

Server metrics [RAM: ▲0.00MB] [CPU: ▼10.01ms] Passed 4 tests

A check of server-side resources used by {eac}Doojigger Readme Extension for WordPress
Server-side resource usage in normal parameters
PageMemory (MB)CPU Time (ms)
Home /3.47 ▲0.0139.69 ▼5.30
Dashboard /wp-admin3.32 ▼0.0349.92 ▼24.58
Posts /wp-admin/edit.php3.37 ▲0.0149.15 ▼2.51
Add New Post /wp-admin/post-new.php5.90 ▲0.0192.25 ▼7.66
Media Library /wp-admin/upload.php3.24 ▲0.0132.68 ▼1.86

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

Input-output and database impact of this plugin
The plugin installed successfully
Filesystem: 18 new files
Database: no new tables, 6 new options
New WordPress options
widget_recent-comments
can_compress_scripts
theysaidso_admin_options
widget_recent-posts
widget_theysaidso_widget
db_upgraded

Browser metrics Passed 4 tests

A check of browser resources used by {eac}Doojigger Readme Extension for WordPress
Normal browser usage
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,789 ▲2814.28 ▲0.151.70 ▼0.0642.34 ▲0.69
Dashboard /wp-admin2,198 ▲185.62 ▼0.0390.26 ▼1.2441.15 ▼3.63
Posts /wp-admin/edit.php2,097 ▼32.15 ▲0.1639.71 ▲2.3335.19 ▼0.87
Add New Post /wp-admin/post-new.php1,533 ▼618.17 ▼5.16628.93 ▼56.9471.56 ▲18.77
Media Library /wp-admin/upload.php1,400 ▼34.26 ▲0.07104.78 ▲2.7944.69 ▼2.14

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

🔸 Tests weight: 35 | It is important to correctly uninstall your plugin, without leaving any traces
Please fix the following items
  • Zombie WordPress options detected upon uninstall: 6 options
    • theysaidso_admin_options
    • can_compress_scripts
    • db_upgraded
    • widget_recent-comments
    • widget_recent-posts
    • widget_theysaidso_widget

Smoke tests 75% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | A smoke test targeting server-side errors
Everything seems fine, however this is by no means an exhaustive test

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 have triggered server-side errors or warnings:
    • > PHP Fatal error
      Uncaught Error: Class 'EarthAsylumConsulting\\abstract_extension' not found in wp-content/plugins/eacreadme/Extensions/class.eacReadme.extension.php:22
    • > PHP Fatal error
      Uncaught Error: Call to undefined function EarthAsylumConsulting\\add_filter() in wp-content/plugins/eacreadme/eacReadme.php:48

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 93% from 29 tests

readme.txt Passed 16 tests

The readme.txt file is important because it is parsed by WordPress.org for the public listing of your plugin
9 plugin tags: readme, markdown, code highlighting, parsedown, post from readme...

eacreadme/eacReadme.php 85% from 13 tests

"{eac}Doojigger Readme Extension for WordPress" version 1.2.3's primary PHP file adds more information about the plugin and serves as the entry point for WordPress
You should first fix the following items:
  • Description: Keep the plugin description shorter than 140 characters (currently 145 characters long)
  • Main file name: Name the main plugin file the same as the plugin slug ("eacreadme.php" instead of "eacReadme.php")

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
There were no executable files found in this plugin2,442 lines of code in 16 files:
LanguageFilesBlank linesComment linesLines of code
PHP44995841,775
Markdown21430618
JSON10033
CSS80168
JavaScript1028

PHP code Passed 2 tests

An overview of cyclomatic complexity and code structure
All good! No complexity issues found
Cyclomatic complexity
Average complexity per logical line of code0.53
Average class complexity69.00
▷ Minimum class complexity2.00
▷ Maximum class complexity186.00
Average method complexity4.12
▷ Minimum method complexity1.00
▷ Maximum method complexity26.00
Code structure
Namespaces2
Interfaces0
Traits0
Classes4
▷ Abstract classes00.00%
▷ Concrete classes4100.00%
▷ Final classes00.00%
Methods84
▷ Static methods2732.14%
▷ Public methods3744.05%
▷ Protected methods4452.38%
▷ Private methods33.57%
Functions4
▷ Named functions00.00%
▷ Anonymous functions4100.00%
Constants2
▷ Global constants00.00%
▷ Class constants2100.00%
▷ Public constants2100.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

PNG files should be compressed to save space and minimize bandwidth usage
PNG images were not found in this plugin