78% storymaps

Code Review | Storymaps

WordPress plugin Storymaps scored 78% from 54 tests.

About plugin

  • Plugin page: storymaps
  • Plugin version: 1.02
  • PHP version: 7.4.16
  • WordPress compatibility: 3.0.1-4.3.1
  • WordPress version: 6.3.1
  • First release: Sep 3, 2015
  • Latest release: Oct 2, 2015
  • Number of updates: 7
  • Update frequency: every 4.3 days
  • Top authors: uiux (100%)

Code review

54 tests

User reviews

2 reviews

Install metrics

70+ active / 2,592 total downloads

Benchmarks

Plugin footprint 83% 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.01MB] [CPU: ▼3.13ms] Passed 4 tests

Analyzing server-side resources used by Storymaps
No issues were detected with server-side resource usage
PageMemory (MB)CPU Time (ms)
Home /3.47 ▲0.0133.91 ▼5.08
Dashboard /wp-admin3.31 ▲0.0144.30 ▼4.00
Posts /wp-admin/edit.php3.36 ▲0.0143.90 ▼1.78
Add New Post /wp-admin/post-new.php5.89 ▲0.0194.11 ▼1.67
Media Library /wp-admin/upload.php3.23 ▲0.0037.10 ▲0.85

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

A short overview of filesystem and database impact
There were no storage issued detected upon installing this plugin
Filesystem: 48 new files
Database: no new tables, 6 new options
New WordPress options
db_upgraded
can_compress_scripts
theysaidso_admin_options
widget_recent-posts
widget_recent-comments
widget_theysaidso_widget

Browser metrics Passed 4 tests

Checking browser requirements for Storymaps
This plugin has a minimal impact on browser resources
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,804 ▲6913.18 ▼1.121.76 ▲0.1141.80 ▲0.29
Dashboard /wp-admin2,210 ▲195.87 ▲0.95109.64 ▲5.1739.56 ▼0.68
Posts /wp-admin/edit.php2,092 ▼01.98 ▼0.0240.58 ▲3.9936.52 ▲1.12
Add New Post /wp-admin/post-new.php1,532 ▼423.22 ▼0.31659.32 ▼71.0874.03 ▲11.64
Media Library /wp-admin/upload.php1,389 ▲14.23 ▼0.04101.10 ▼17.6443.54 ▼4.12

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

🔸 Tests weight: 35 | Checking the uninstaller removed all traces of the plugin
You still need to fix the following
  • This plugin did not uninstall successfully, leaving 6 options in the database
    • widget_theysaidso_widget
    • theysaidso_admin_options
    • db_upgraded
    • widget_recent-posts
    • can_compress_scripts
    • widget_recent-comments

Smoke tests 50% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | This is a shallow check for server-side errors
The smoke test was a success, however most plugin functionality was not tested

SRP 0% from 2 tests

🔹 Tests weight: 20 | The single-responsibility principle: PHP files have to remain inert when accessed directly, throwing no errors and performing no actions
Almost there! Just fix the following items
  • 1× PHP files output text when accessed directly:
    • > /wp-content/plugins/storymaps/templates/storymap-javascript-template.php
  • 3× GET requests to PHP files have triggered server-side errors or warnings:
    • > PHP Notice
      Undefined variable: slides in wp-content/plugins/storymaps/templates/storymap-javascript-template.php on line 2
    • > PHP Notice
      Undefined variable: id in wp-content/plugins/storymaps/templates/storymap-javascript-template.php on line 4
    • > PHP Notice
      Undefined variable: settings in wp-content/plugins/storymaps/templates/storymap-javascript-template.php on line 3

User-side errors Passed 1 test

🔹 Test weight: 20 | Just a short smoke test targeting errors on the browser (console and network errors and warnings)
There were no browser issues found

Optimizations

Plugin configuration 97% from 29 tests

readme.txt 94% from 16 tests

The readme.txt file is important because it is parsed by WordPress.org for the public listing of your plugin
These attributes need your attention:
  • Plugin Name: Write the name of your plugin instead of "Plugin Name" on the first line ( === storymaps === )
The official readme.txt is a good inspiration

storymaps/storymaps.php Passed 13 tests

The entry point to "Storymaps" version 1.02 is a PHP file that has certain tags in its header comment area
127 characters long description:
StoryMapJS by Knight Lab is a free tool to help you tell stories on the web that highlight the locations of a series of events.

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | There should be no dangerous file extensions present in any WordPress plugin
No dangerous file extensions were detected3,845 lines of code in 18 files:
LanguageFilesBlank linesComment linesLines of code
PHP14286293,315
CSS14715416
JavaScript33111114

PHP code Passed 2 tests

A brief analysis of cyclomatic complexity and code structure for this plugin
Everything seems fine, there were no complexity issues found
Cyclomatic complexity
Average complexity per logical line of code0.34
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%
Functions24
▷ Named functions24100.00%
▷ Anonymous functions00.00%
Constants0
▷ Global constants00.00%
▷ Class constants00.00%
▷ Public constants00.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

It is recommended to compress PNG files in your plugin to minimize bandwidth usage
29 PNG files occupy 0.08MB with 0.04MB in potential savings
Potential savings
Compression of 5 random PNG files using pngquant
FileSize - originalSize - compressedSavings
img/vimeo.png3.16KB1.37KB▼ 56.72%
img/evernote.png3.27KB1.57KB▼ 52.16%
img/marker-icon.png1.71KB1.56KB▼ 8.59%
img/linkedin.png2.70KB1.05KB▼ 61.20%
img/behance.png3.22KB1.41KB▼ 56.18%