84% footnotation

Code Review | Footnotation

WordPress plugin Footnotation scored84%from 54 tests.

About plugin

  • Plugin page: footnotation
  • Plugin version: 1.2
  • PHP version: 7.4.16
  • WordPress compatibility: 2.0-4.7.4
  • WordPress version: 6.3.1
  • First release: Jan 17, 2017
  • Latest release: Apr 30, 2017
  • Number of updates: 39
  • Update frequency: every 2.7 days
  • Top authors: vhbelvadi (100%)

Code review

54 tests

User reviews

5 reviews

Install metrics

200+ active /3,789 total downloads

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | Verifying that this plugin installs correctly without errors
The plugin installed successfully, without throwing any errors or notices

Server metrics [RAM: ▲0.03MB] [CPU: ▼6.14ms] Passed 4 tests

This is a short check of server-side resources used by Footnotation
Server-side resource usage in normal parameters
PageMemory (MB)CPU Time (ms)
Home /3.50 ▲0.0341.78 ▲4.21
Dashboard /wp-admin3.34 ▲0.0349.51 ▲5.04
Posts /wp-admin/edit.php3.39 ▲0.0344.18 ▼4.29
Add New Post /wp-admin/post-new.php5.92 ▲0.0386.52 ▼27.86
Media Library /wp-admin/upload.php3.26 ▲0.0334.78 ▲3.38
Footnotation /wp-admin/options-general.php?page=footnotation/footnotation.php3.2330.88

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

How much does this plugin use your filesystem and database?
No storage issues were detected
Filesystem: 12 new files
Database: no new tables, 6 new options
New WordPress options
widget_recent-posts
widget_recent-comments
db_upgraded
theysaidso_admin_options
can_compress_scripts
widget_theysaidso_widget

Browser metrics Passed 4 tests

A check of browser resources used by Footnotation
This plugin renders optimally with no browser resource issues detected
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,912 ▲16613.58 ▼0.809.16 ▲7.5046.06 ▲5.14
Dashboard /wp-admin2,213 ▲585.84 ▲0.13100.23 ▼7.6638.83 ▼3.34
Posts /wp-admin/edit.php2,093 ▲11.99 ▼0.0633.78 ▼5.5834.86 ▼4.30
Add New Post /wp-admin/post-new.php1,552 ▲3818.32 ▲0.91623.49 ▼19.8667.26 ▲11.09
Media Library /wp-admin/upload.php1,395 ▲44.21 ▼0.0299.97 ▲0.2441.80 ▼6.43
Footnotation /wp-admin/options-general.php?page=footnotation/footnotation.php8052.1823.7931.79

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
  • This plugin does not fully uninstall, leaving 6 options in the database
    • widget_theysaidso_widget
    • can_compress_scripts
    • theysaidso_admin_options
    • widget_recent-posts
    • db_upgraded
    • widget_recent-comments

Smoke tests 75% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | This is a shallow check for server-side errors
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
  • 1× PHP files trigger errors when accessed directly with GET requests:
    • > PHP Fatal error
      Uncaught Error: Call to undefined function add_action() in wp-content/plugins/footnotation/footnotation.php:35

User-side errors Passed 1 test

🔹 Test weight: 20 | A shallow check that no browser errors were triggered
No browser errors were detected

Optimizations

Plugin configuration Passed 29 tests

readme.txt Passed 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
7 plugin tags: essay, post, footnotes, editing, academic...

footnotation/footnotation.php Passed 13 tests

"Footnotation" version 1.2's primary PHP file adds more information about the plugin and serves as the entry point for WordPress
38 characters long description:
A simple footnote plugin for Wordpress

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | Executable files are considered dangerous and should not be included with any WordPress plugin
Good job! No executable or dangerous file extensions detected229 lines of code in 3 files:
LanguageFilesBlank linesComment linesLines of code
PHP13732167
CSS16031
JavaScript13031

PHP code Passed 2 tests

An overview of cyclomatic complexity and code structure
Everything seems fine, there were no complexity issues found
Cyclomatic complexity
Average complexity per logical line of code0.38
Average class complexity0.00
▷ Minimum class complexity0.00
▷ Maximum class complexity0.00
Average method complexity0.00
▷ Minimum method complexity0.00
▷ Maximum method complexity0.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes0
▷ Abstract classes00.00%
▷ Concrete classes00.00%
▷ Final classes00.00%
Methods0
▷ Static methods00.00%
▷ Public methods00.00%
▷ Protected methods00.00%
▷ Private methods00.00%
Functions5
▷ Named functions5100.00%
▷ Anonymous functions00.00%
Constants0
▷ Global constants00.00%
▷ Class constants00.00%
▷ Public constants00.00%

Plugin size 50% from 2 tests

Image compression 50% from 2 tests

Often times overlooked, PNG files can occupy unnecessary space in your plugin
7 PNG files occupy 2.30MB with 1.70MB in potential savings
Potential savings
Compression of 5 random PNG files using pngquant
FileSize - originalSize - compressedSavings
assets/screenshot-1.png800.52KB276.80KB▼ 65.42%
assets/banner-1544x500.png319.16KB90.18KB▼ 71.75%
assets/screenshot-3.png322.46KB106.57KB▼ 66.95%
assets/banner-772x250.png225.01KB76.17KB▼ 66.15%
assets/icon-256x256.png18.02KB0.21KB▼ 98.84%