84% better-writing

Code Review | Better Writing

WordPress plugin Better Writing scored 84% from 54 tests.

About plugin

  • Plugin page: better-writing
  • Plugin version: 1.4
  • PHP version: 7.4.16
  • WordPress compatibility: 3.0-3.7.1
  • WordPress version: 6.3.1
  • First release: Jan 20, 2013
  • Latest release: Jan 20, 2014
  • Number of updates: 33
  • Update frequency: every 11.1 days
  • Top authors: Mike Riethmuller (100%)

Code review

54 tests

User reviews

5 reviews

Install metrics

40+ active / 4,611 total downloads

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | It is important to correctly install your plugin, without throwing errors or notices
Installer ran successfully

Server metrics [RAM: ▼0.52MB] [CPU: ▼13.68ms] Passed 4 tests

This is a short check of server-side resources used by Better Writing
This plugin has minimal impact on server resources
PageMemory (MB)CPU Time (ms)
Home /3.66 ▲0.2043.68 ▲5.40
Dashboard /wp-admin3.49 ▲0.1847.85 ▼4.57
Posts /wp-admin/edit.php3.46 ▲0.1042.05 ▼0.42
Add New Post /wp-admin/post-new.php3.33 ▼2.5537.76 ▼53.47
Media Library /wp-admin/upload.php3.41 ▲0.1837.22 ▲3.76
Better Writing /wp-admin/options-general.php?page=better-writing3.3835.87

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

Analyzing filesystem and database footprints of this plugin
No storage issues were detected
Filesystem: 9 new files
Database: no new tables, 11 new options
New WordPress options
readability_column
theysaidso_admin_options
readability_target
readability_method
widget_theysaidso_widget
db_upgraded
widget_recent-comments
widget_recent-posts
can_compress_scripts
readability_required_posts
...

Browser metrics Passed 4 tests

Checking browser requirements for Better Writing
This plugin renders optimally with no browser resource issues detected
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,808 ▲7313.25 ▼1.521.73 ▼0.0845.01 ▼1.79
Dashboard /wp-admin2,208 ▲234.86 ▼1.19102.56 ▼1.1939.73 ▼3.04
Posts /wp-admin/edit.php2,128 ▲392.04 ▲0.0137.07 ▼0.3036.28 ▲2.56
Add New Post /wp-admin/post-new.php6,501 ▲4,98220.17 ▼2.72867.46 ▲208.4362.63 ▲4.86
Media Library /wp-admin/upload.php1,390 ▼14.29 ▲0.0895.82 ▼4.2541.22 ▼3.99
Better Writing /wp-admin/options-general.php?page=better-writing8482.0624.8026.00

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
  • The uninstall procedure has failed, leaving 6 options in the database
    • can_compress_scripts
    • theysaidso_admin_options
    • widget_recent-comments
    • widget_theysaidso_widget
    • widget_recent-posts
    • db_upgraded

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)
Even though everything seems fine, this is not an exhaustive test

SRP 50% from 2 tests

🔹 Tests weight: 20 | It is important to ensure that your PHP files perform no action when accessed directly, respecting the single-responsibility principle
The following issues need your attention
  • 1× PHP files trigger errors when accessed directly with GET requests:
    • > PHP Fatal error
      Uncaught Error: Call to undefined function plugins_url() in wp-content/plugins/better-writing/better-writing.php:17

User-side errors Passed 1 test

🔹 Test weight: 20 | This is a smoke test targeting browser errors/issues
There were no browser issues found

Optimizations

Plugin configuration Passed 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
3 plugin tags: readability, plain english, preferred terms

better-writing/better-writing.php Passed 13 tests

The main PHP file in "Better Writing" ver. 1.4 adds more information about the plugin and also serves as the entry point for this plugin
79 characters long description:
Helps you write better with readability scores and preferred terms as you type.

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
Success! There were no dangerous files found in this plugin1,030 lines of code in 6 files:
LanguageFilesBlank linesComment linesLines of code
PHP3116169697
JavaScript2216256
CSS17077

PHP code Passed 2 tests

A short review of cyclomatic complexity and code structure
This plugin has no cyclomatic complexity problems
Cyclomatic complexity
Average complexity per logical line of code0.31
Average class complexity25.00
▷ Minimum class complexity25.00
▷ Maximum class complexity25.00
Average method complexity2.14
▷ Minimum method complexity1.00
▷ Maximum method complexity7.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes1
▷ Abstract classes00.00%
▷ Concrete classes1100.00%
▷ Final classes00.00%
Methods21
▷ Static methods00.00%
▷ Public methods1780.95%
▷ Protected methods419.05%
▷ Private methods00.00%
Functions27
▷ Named functions27100.00%
▷ Anonymous functions00.00%
Constants4
▷ Global constants4100.00%
▷ Class constants00.00%
▷ Public constants00.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

Using a strong compression for your PNG files is a great way to speed-up your plugin
2 PNG files occupy 0.05MB with 0.03MB in potential savings
Potential savings
Compression of 2 random PNG files using pngquant
FileSize - originalSize - compressedSavings
score-sprite.png21.62KB10.26KB▼ 52.54%
score-sprite-flesch.png33.44KB11.90KB▼ 64.41%