84% wds-site-documentation

Code Review | WDS Site Documentation

WordPress plugin WDS Site Documentation scored84%from 54 tests.

About plugin

  • Plugin page: wds-site-document...
  • Plugin version: 1.0.2
  • PHP compatiblity: 7.4+
  • PHP version: 7.4.16
  • WordPress compatibility: 5.2-6.0
  • WordPress version: 6.3.1
  • First release: Mar 25, 2021
  • Latest release: Jun 7, 2022
  • Number of updates: 13
  • Update frequency: every 34.6 days
  • Top authors: webdevstudios (69.23%)tw2113 (38.46%)

Code review

54 tests

User reviews

1 review

Install metrics

10+ active /2,024 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.01MB] [CPU: ▼6.61ms] Passed 4 tests

Server-side resources used by WDS Site Documentation
No issues were detected with server-side resource usage
PageMemory (MB)CPU Time (ms)
Home /3.47 ▲0.0141.95 ▼0.42
Dashboard /wp-admin3.31 ▲0.0144.90 ▼5.07
Posts /wp-admin/edit.php3.36 ▲0.0142.46 ▼0.54
Add New Post /wp-admin/post-new.php5.89 ▲0.0180.90 ▼20.41
Media Library /wp-admin/upload.php3.23 ▲0.0136.43 ▲1.87
Documentation /wp-admin/options-general.php?page=wds_documentation3.2235.33

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

A short overview of filesystem and database impact
No storage issues were detected
Filesystem: 4 new files
Database: no new tables, 6 new options
New WordPress options
widget_recent-posts
can_compress_scripts
widget_recent-comments
widget_theysaidso_widget
theysaidso_admin_options
db_upgraded

Browser metrics Passed 4 tests

A check of browser resources used by WDS Site Documentation
This plugin has a minimal impact on browser resources
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,859 ▲12413.21 ▼1.351.87 ▼0.0645.88 ▼2.65
Dashboard /wp-admin2,262 ▲774.87 ▼1.0397.06 ▼13.2740.14 ▼7.37
Posts /wp-admin/edit.php2,105 ▲132.05 ▲0.0236.64 ▼2.7634.26 ▼1.36
Add New Post /wp-admin/post-new.php1,534 ▲1523.12 ▼0.14686.46 ▲25.5057.08 ▲3.73
Media Library /wp-admin/upload.php1,401 ▲164.20 ▲0.0994.24 ▼23.4040.53 ▼8.24
Documentation /wp-admin/options-general.php?page=wds_documentation1,0063.0542.3967.90

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
  • Zombie WordPress options detected upon uninstall: 6 options
    • theysaidso_admin_options
    • widget_recent-comments
    • widget_theysaidso_widget
    • widget_recent-posts
    • db_upgraded
    • can_compress_scripts

Smoke tests 75% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | A smoke test targeting server-side errors
Even though no errors were found, this is by no means an exhaustive test

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
Almost there! Just fix the following items
  • 1× GET requests to PHP files trigger server-side errors or Error 500 responses:
    • > PHP Fatal error
      Uncaught Error: Call to undefined function WebDevStudios\\Documentation\\add_action() in wp-content/plugins/wds-site-documentation/wds-site-documentation.php:99

User-side errors Passed 1 test

🔹 Test weight: 20 | This is just a short smoke test looking for browser issues
Everything seems fine on the user side

Optimizations

Plugin configuration 96% from 29 tests

readme.txt Passed 16 tests

Often overlooked, readme.txt is one of the most important files in your plugin
1 plugin tags: documentation

wds-site-documentation/wds-site-documentation.php 92% from 13 tests

Analyzing the main PHP file in "WDS Site Documentation" version 1.0.2
Please take the time to fix the following:
  • Requires at least: Required version must match the one declared in readme.txt ("5.6" instead of "5.2")

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 plugin178 lines of code in 2 files:
LanguageFilesBlank linesComment linesLines of code
PHP25194178

PHP code Passed 2 tests

A brief analysis of cyclomatic complexity and code structure for this plugin
Although this was not an exhaustive test, there were no cyclomatic complexity issues detected
Cyclomatic complexity
Average complexity per logical line of code0.15
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
Namespaces1
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%
Functions7
▷ Named functions7100.00%
▷ Anonymous functions00.00%
Constants0
▷ Global constants00.00%
▷ Class constants00.00%
▷ Public constants00.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

Often times overlooked, PNG files can occupy unnecessary space in your plugin
1 compressed PNG file occupies 0.19MB
Potential savings
Compression of 1 random PNG file using pngquant
FileSize - originalSize - compressedSavings
wds_banner.png194.40KB194.38KB0.01%