Benchmarks
Plugin footprint 83% from 16 tests
Installer Passed 1 test
🔺 Critical test (weight: 50) | The install procedure must perform silently
The plugin installed gracefully, with no errors
Server metrics [RAM: ▲0.17MB] [CPU: ▼1.63ms] Passed 4 tests
An overview of server-side resources used by UserDocs
This plugin has minimal impact on server resources
| Page | Memory (MB) | CPU Time (ms) |
|---|---|---|
| Home / | 3.64 ▲0.18 | 41.71 ▲2.88 |
| Dashboard /wp-admin | 3.47 ▲0.17 | 50.75 ▲3.10 |
| Posts /wp-admin/edit.php | 3.59 ▲0.23 | 52.31 ▼1.04 |
| Add New Post /wp-admin/post-new.php | 6.05 ▲0.16 | 88.24 ▼11.05 |
| Media Library /wp-admin/upload.php | 3.39 ▲0.16 | 38.49 ▲2.68 |
| Topics /wp-admin/edit-tags.php?taxonomy=userdocs_taxonomy&post_type=userdocs | 3.39 | 40.60 |
| All UserDocs /wp-admin/edit.php?post_type=userdocs | 3.44 | 39.16 |
| Add New /wp-admin/post-new.php?post_type=userdocs | 3.52 | 51.71 |
Server storage [IO: ▲0.07MB] [DB: ▲0.00MB] Passed 3 tests
Analyzing filesystem and database footprints of this plugin
This plugin was installed successfully
Filesystem: 23 new files
Database: no new tables, 6 new options
| New WordPress options |
|---|
| can_compress_scripts |
| db_upgraded |
| theysaidso_admin_options |
| widget_recent-comments |
| widget_theysaidso_widget |
| widget_recent-posts |
Browser metrics Passed 4 tests
A check of browser resources used by UserDocs
There were no issues detected in relation to browser resource usage
| Page | Nodes | Memory (MB) | Script (ms) | Layout (ms) |
|---|---|---|---|---|
| Home / | 2,825 ▲64 | 14.37 ▲0.02 | 1.62 ▲0.11 | 41.06 ▼4.36 |
| Dashboard /wp-admin | 2,220 ▲43 | 5.56 ▼0.04 | 87.69 ▼1.51 | 41.44 ▼6.13 |
| Posts /wp-admin/edit.php | 2,134 ▲34 | 2.02 ▲0.00 | 40.42 ▲4.74 | 35.71 ▼2.44 |
| Add New Post /wp-admin/post-new.php | 1,552 ▲24 | 23.57 ▲0.55 | 682.47 ▲7.86 | 55.51 ▲0.26 |
| Media Library /wp-admin/upload.php | 1,431 ▲31 | 4.18 ▼0.05 | 103.12 ▼7.26 | 44.03 ▲2.07 |
| Topics /wp-admin/edit-tags.php?taxonomy=userdocs_taxonomy&post_type=userdocs | 1,280 | 2.12 | 32.12 | 31.63 |
| All UserDocs /wp-admin/edit.php?post_type=userdocs | 1,109 | 1.98 | 29.17 | 31.45 |
| Add New /wp-admin/post-new.php?post_type=userdocs | 2,232 | 7.54 | 169.40 | 63.30 |
Uninstaller [IO: ▲0.00MB] [DB: ▲0.00MB] 75% from 4 tests
🔸 Tests weight: 35 | Checking the uninstaller removed all traces of the plugin
The following items require your attention
- This plugin did not uninstall successfully, leaving 6 options in the database
- widget_recent-comments
- db_upgraded
- widget_theysaidso_widget
- theysaidso_admin_options
- widget_recent-posts
- can_compress_scripts
Smoke tests Passed 4 tests
Server-side errors Passed 1 test
🔹 Test weight: 20 | This is a short smoke test looking for server-side errors
Good news, no errors were detected
SRP Passed 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
No output text or server-side errors detected on direct access of PHP files
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)
Everything seems fine on the user side
Optimizations
Plugin configuration Passed 29 tests
readme.txt Passed 16 tests
Perhaps the most important file in your plugin readme.txt gets parsed in order to generate the public listing of your plugin
7 plugin tags: user documentation, help, versioning, project management, helpdesk...
userdocs/userdocs.php Passed 13 tests
"UserDocs" version 0.9.1's main PHP file describes plugin functionality and also serves as the entry point to any WordPress functionality
98 characters long description:
The best documentation plugin for WordPress. To use: add shortcode [userdocs] in a sidebar widget.
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
There were no executable files found in this plugin684 lines of code in 14 files:
| Language | Files | Blank lines | Comment lines | Lines of code |
|---|---|---|---|---|
| PHP | 11 | 187 | 645 | 598 |
| CSS | 2 | 10 | 4 | 76 |
| SVG | 1 | 1 | 0 | 10 |
PHP code Passed 2 tests
This is a very shot review of cyclomatic complexity and code structure
There are no cyclomatic complexity problems detected for this plugin
| Cyclomatic complexity | |
|---|---|
| Average complexity per logical line of code | 0.45 |
| Average class complexity | 11.38 |
| ▷ Minimum class complexity | 1.00 |
| ▷ Maximum class complexity | 67.00 |
| Average method complexity | 3.18 |
| ▷ Minimum method complexity | 1.00 |
| ▷ Maximum method complexity | 53.00 |
| Code structure | ||
|---|---|---|
| Namespaces | 0 | |
| Interfaces | 0 | |
| Traits | 0 | |
| Classes | 8 | |
| ▷ Abstract classes | 0 | 0.00% |
| ▷ Concrete classes | 8 | 100.00% |
| ▷ Final classes | 0 | 0.00% |
| Methods | 38 | |
| ▷ Static methods | 2 | 5.26% |
| ▷ Public methods | 33 | 86.84% |
| ▷ Protected methods | 0 | 0.00% |
| ▷ Private methods | 5 | 13.16% |
| Functions | 3 | |
| ▷ Named functions | 3 | 100.00% |
| ▷ Anonymous functions | 0 | 0.00% |
| Constants | 0 | |
| ▷ Global constants | 0 | 0.00% |
| ▷ Class constants | 0 | 0.00% |
| ▷ Public constants | 0 | 0.00% |
Plugin size Passed 2 tests
Image compression Passed 2 tests
Often times overlooked, PNG files can occupy unnecessary space in your plugin
No PNG files were detected