84% storytelling

Code Review | Storytelling

WordPress plugin Storytelling scored84%from 54 tests.

About plugin

  • Plugin page: storytelling
  • Plugin version: 1.3.4
  • PHP version: 7.4.16
  • WordPress compatibility: 4.1-4.3.1
  • WordPress version: 6.3.1
  • First release: Jan 14, 2015
  • Latest release: Sep 30, 2015
  • Number of updates: 25
  • Update frequency: every 10.4 days
  • Top authors: david massiani (100%)

Code review

54 tests

User reviews

1 review

Install metrics

10+ active /1,769 total downloads

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | Checking the installer triggered no errors
This plugin's installer ran successfully

Server metrics [RAM: ▼0.08MB] [CPU: ▼4.14ms] Passed 4 tests

Analyzing server-side resources used by Storytelling
Server-side resource usage in normal parameters
PageMemory (MB)CPU Time (ms)
Home /3.49 ▲0.0337.42 ▼4.01
Dashboard /wp-admin3.34 ▲0.0452.19 ▲4.61
Posts /wp-admin/edit.php3.45 ▲0.1045.74 ▼0.01
Add New Post /wp-admin/post-new.php5.48 ▼0.4075.53 ▼13.20
Media Library /wp-admin/upload.php3.26 ▲0.0334.96 ▲0.65

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

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

Browser metrics Passed 4 tests

Storytelling: an overview of browser usage
There were no issues detected in relation to browser resource usage
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,829 ▲8313.23 ▼1.361.88 ▼0.0542.85 ▼0.59
Dashboard /wp-admin2,207 ▲195.89 ▲1.00106.25 ▲0.8738.95 ▼2.57
Posts /wp-admin/edit.php2,093 ▲42.06 ▲0.0740.52 ▲4.0137.46 ▲1.23
Add New Post /wp-admin/post-new.php6,282 ▲4,74925.90 ▲2.85917.84 ▲239.5761.33 ▲8.58
Media Library /wp-admin/upload.php1,392 ▲44.24 ▼0.06105.02 ▼5.3147.78 ▲0.24

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

🔸 Tests weight: 35 | Checking the uninstaller removed all traces of the plugin
These items require your attention
  • The uninstall procedure has failed, leaving 6 options in the database
    • can_compress_scripts
    • widget_theysaidso_widget
    • db_upgraded
    • theysaidso_admin_options
    • 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 no errors were found, this is by no means an exhaustive test

SRP 50% from 2 tests

🔹 Tests weight: 20 | The single-responsibility principle applies for WordPress plugins as well - please make sure your PHP files perform no actions when accessed directly
Please take a closer look at the following
  • 7× PHP files trigger server errors when accessed directly:
    • > PHP Fatal error
      Uncaught Error: Call to undefined function wp_enqueue_style() in wp-content/plugins/storytelling/templates/inside-container/triple-col.php:13
    • > PHP Fatal error
      Uncaught Error: Call to undefined function wp_enqueue_style() in wp-content/plugins/storytelling/templates/outside-container/double-col.php:13
    • > PHP Fatal error
      Uncaught Error: Call to undefined function wp_enqueue_style() in wp-content/plugins/storytelling/templates/outside-container/triple-col.php:15
    • > PHP Fatal error
      Uncaught Error: Call to undefined function wp_enqueue_style() in wp-content/plugins/storytelling/templates/inside-container/double-col.php:13
    • > PHP Fatal error
      Uncaught Error: Class 'Storytelling__kickstarter' not found in wp-content/plugins/storytelling/core/inc/story__structure.php:9
    • > PHP Fatal error
      Uncaught Error: Call to undefined function the_chapter_title() in wp-content/plugins/storytelling/macro-template-example.php:24
    • > PHP Fatal error
      Uncaught Error: Call to undefined function plugins_url() in wp-content/plugins/storytelling/index.php:20

User-side errors Passed 1 test

🔹 Test weight: 20 | This is just a short smoke test looking for browser issues
No browser errors were detected

Optimizations

Plugin configuration 93% from 29 tests

readme.txt 94% from 16 tests

The readme.txt file describes your plugin functionality and requirements and it is parsed to prepare the your plugin's listing
Attributes that need to be fixed:
  • Screenshots: Add images for these screenshots: #1 (Page / Post Sidebar where Chapter - Macro-template - are available), #2 (Storytelling folder example in your theme), #3 (Metabox with various content), #4 (Another metabox with other various content), #5 (Final result - [Storytelling Website](http://storytelling.io/ "Storytelling for WordPress"))
You can look at the official readme.txt

storytelling/index.php 92% from 13 tests

The principal PHP file in "Storytelling" v. 1.3.4 is loaded by WordPress automatically on each request
You should first fix the following items:
  • Main file name: Even though not officially enforced, the main plugin file should be the same as the plugin slug ("storytelling.php" instead of "index.php")

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | This is an overview of file extensions present in this plugin and a short test that no dangerous files are bundled with this plugin
Good job! No executable or dangerous file extensions detected1,576 lines of code in 18 files:
LanguageFilesBlank linesComment linesLines of code
PHP157093021,258
JavaScript19537162
CSS11312118
PO File1111438

PHP code Passed 2 tests

Analyzing logical lines of code, cyclomatic complexity, and other code metrics
There were no cyclomatic complexity issued detected
Cyclomatic complexity
Average complexity per logical line of code0.34
Average class complexity14.30
▷ Minimum class complexity1.00
▷ Maximum class complexity52.00
Average method complexity3.77
▷ Minimum method complexity1.00
▷ Maximum method complexity29.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes10
▷ Abstract classes00.00%
▷ Concrete classes10100.00%
▷ Final classes00.00%
Methods48
▷ Static methods12.08%
▷ Public methods48100.00%
▷ Protected methods00.00%
▷ Private methods00.00%
Functions14
▷ Named functions14100.00%
▷ Anonymous functions00.00%
Constants5
▷ Global constants5100.00%
▷ Class constants00.00%
▷ Public constants00.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

PNG files should be compressed to save space and minimize bandwidth usage
1 PNG file occupies 0.00MB with 0.00MB in potential savings
Potential savings
Compression of 1 random PNG file using pngquant
FileSize - originalSize - compressedSavings
front/image/damier.png0.18KB0.09KB▼ 47.22%