84% bytheway

Code Review | ByTheWay Annotations for Wordpress

WordPress plugin ByTheWay Annotations for Wordpress scored 84% from 54 tests.

About plugin

  • Plugin page: bytheway
  • Plugin version: 1.0.1
  • PHP version: 7.4.16
  • WordPress compatibility: 3.6.1-3.8
  • WordPress version: 5.8.1
  • First release: Oct 15, 2013
  • Latest release: Dec 17, 2013
  • Number of updates: 6
  • Update frequency: every 10.8 days
  • Top authors: ulrichw (100%)

Code review

54 tests

User reviews

1 review

Install metrics

10+ active / 956 total downloads
Download (7.43 KB)

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | The install procedure must perform silently
Installer ran successfully

Server metrics [RAM: ▲0.01MB] [CPU: ▼143.01ms] Passed 4 tests

A check of server-side resources used by ByTheWay Annotations for Wordpress
Server-side resource usage in normal parameters
PageMemory (MB)CPU Time (ms)
Home /2.85 ▲0.0136.19 ▲1.23
Dashboard /wp-admin3.08 ▲0.0245.69 ▲2.89
Posts /wp-admin/edit.php3.13 ▲0.0240.24 ▼3.08
Add New Post /wp-admin/post-new.php5.44 ▲0.0192.86 ▼566.65
Media Library /wp-admin/upload.php3.02 ▲0.0134.82 ▼3.55
ByTheWay /wp-admin/options-general.php?page=btw-plugin2.9927.62

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

A short overview of filesystem and database impact
No storage issues were detected
Filesystem: 3 new files
Database: no new tables, 3 new options
New WordPress options
btw_general
btw_modedefaults
btw_defaultatts

Browser metrics Passed 4 tests

A check of browser resources used by ByTheWay Annotations for Wordpress
This plugin renders optimally with no browser resource issues detected
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /3,808 ▲21216.24 ▲0.7114.22 ▲4.0147.22 ▼0.88
Dashboard /wp-admin2,972 ▲385.92 ▼0.03133.71 ▼5.24115.26 ▼2.70
Posts /wp-admin/edit.php2,741 ▲22.71 ▼0.0162.94 ▼1.8287.15 ▼4.97
Add New Post /wp-admin/post-new.php1,879 ▲20719.18 ▲0.34378.53 ▲11.22103.90 ▼9.53
Media Library /wp-admin/upload.php1,812 ▲85.06 ▲0.01142.10 ▲1.43111.17 ▼14.10
ByTheWay /wp-admin/options-general.php?page=btw-plugin1,2862.1154.3979.24

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

🔸 Tests weight: 35 | Verifying that this plugin uninstalls completely without leaving any traces
Please fix the following items
  • Zombie WordPress options were found after uninstall: 3 options
    • btw_defaultatts
    • btw_general
    • btw_modedefaults

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)
The smoke test was a success, however most plugin functionality was not tested

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 fix the following
  • 1× GET requests to PHP files trigger server-side errors or Error 500 responses:
    • > PHP Fatal error
      Uncaught Error: Call to undefined function is_admin() in wp-content/plugins/bytheway/btw.php:497

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

readme.txt 94% from 16 tests

Perhaps the most important file in your plugin readme.txt gets parsed in order to generate the public listing of your plugin
Attributes that need to be fixed:
  • Plugin Name: Write the name of your plugin instead of "Plugin Name" on the first line ( === bytheway === )
You can look at the official readme.txt

bytheway/btw.php 92% from 13 tests

The principal PHP file in "ByTheWay Annotations for Wordpress" v. 1.0.1 is loaded by WordPress automatically on each request
Please take the time to fix the following:
  • Main file name: It is recommended to name the main PHP file as the plugin slug ("bytheway.php" instead of "btw.php")

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
Success! There were no dangerous files found in this plugin369 lines of code in 2 files:
LanguageFilesBlank linesComment linesLines of code
PHP110196328
CSS15741

PHP code Passed 2 tests

Cyclomatic complexity and code structure are the fingerprint of this plugin
This plugin has no cyclomatic complexity problems
Cyclomatic complexity
Average complexity per logical line of code0.11
Average class complexity15.00
▷ Minimum class complexity15.00
▷ Maximum class complexity15.00
Average method complexity1.44
▷ Minimum method complexity1.00
▷ Maximum method complexity7.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes1
▷ Abstract classes00.00%
▷ Concrete classes1100.00%
▷ Final classes00.00%
Methods32
▷ Static methods32100.00%
▷ Public methods32100.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

All PNG images should be compressed to minimize bandwidth usage for end users
No PNG images were found in this plugin