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
The plugin installed gracefully, with no errors
Server metrics [RAM: ▲0.44MB] [CPU: ▼1.03ms] Passed 4 tests
A check of server-side resources used by Documentation
Server-side resource usage in normal parameters
| Page | Memory (MB) | CPU Time (ms) |
|---|---|---|
| Home / | 3.85 ▲0.38 | 40.36 ▼3.89 |
| Dashboard /wp-admin | 3.78 ▲0.48 | 55.14 ▲5.58 |
| Posts /wp-admin/edit.php | 3.84 ▲0.48 | 54.36 ▲0.84 |
| Add New Post /wp-admin/post-new.php | 6.46 ▲0.57 | 93.54 ▼6.65 |
| Media Library /wp-admin/upload.php | 3.64 ▲0.41 | 43.05 ▲5.75 |
| Settings /wp-admin/edit.php?post_type=document&page=documentation-settings | 3.63 | 37.57 |
| All Documents /wp-admin/edit.php?post_type=document | 3.69 | 43.15 |
| Add-Ons /wp-admin/edit.php?post_type=document&page=documentation-add-ons | 3.61 | 35.14 |
| Tags /wp-admin/edit-tags.php?taxonomy=document_tag&post_type=document | 3.63 | 39.76 |
| New Document /wp-admin/post-new.php?post_type=document | 6.45 | 89.19 |
| Categories /wp-admin/edit-tags.php?taxonomy=document_category&post_type=document | 3.64 | 42.14 |
Server storage [IO: ▲0.32MB] [DB: ▲0.00MB] Passed 3 tests
How much does this plugin use your filesystem and database?
This plugin was installed successfully
Filesystem: 44 new files
Database: no new tables, 10 new options
| New WordPress options |
|---|
| widget_documentation_document_children_widget |
| widget_theysaidso_widget |
| widget_documentation_document_hierarchy_widget |
| widget_documentation_documents_widget |
| db_upgraded |
| widget_recent-comments |
| theysaidso_admin_options |
| widget_documentation_categories_widget |
| can_compress_scripts |
| widget_recent-posts |
Browser metrics Passed 4 tests
This is an overview of browser requirements for Documentation
Normal browser usage
| Page | Nodes | Memory (MB) | Script (ms) | Layout (ms) |
|---|---|---|---|---|
| Home / | 2,845 ▲74 | 13.30 ▼1.06 | 4.70 ▲2.67 | 43.00 ▲3.20 |
| Dashboard /wp-admin | 2,236 ▲48 | 5.79 ▲0.90 | 102.86 ▼1.38 | 77.51 ▲33.83 |
| Posts /wp-admin/edit.php | 2,131 ▲42 | 2.01 ▼0.02 | 35.83 ▼6.75 | 32.69 ▼5.92 |
| Add New Post /wp-admin/post-new.php | 1,558 ▲16 | 23.34 ▲5.01 | 785.47 ▲144.34 | 62.92 ▲11.39 |
| Media Library /wp-admin/upload.php | 1,421 ▲33 | 4.23 ▲0.01 | 103.17 ▼3.92 | 83.41 ▲39.03 |
| Settings /wp-admin/edit.php?post_type=document&page=documentation-settings | 865 | 2.02 | 25.22 | 31.32 |
| All Documents /wp-admin/edit.php?post_type=document | 1,162 | 1.95 | 32.22 | 35.69 |
| Add-Ons /wp-admin/edit.php?post_type=document&page=documentation-add-ons | 915 | 2.02 | 24.50 | 32.14 |
| Tags /wp-admin/edit-tags.php?taxonomy=document_tag&post_type=document | 1,279 | 2.14 | 27.68 | 30.86 |
| New Document /wp-admin/post-new.php?post_type=document | 6,245 | 23.92 | 911.73 | 32.20 |
| Categories /wp-admin/edit-tags.php?taxonomy=document_category&post_type=document | 1,304 | 2.15 | 26.36 | 30.50 |
Uninstaller [IO: ▲0.00MB] [DB: ▲0.00MB] 75% from 4 tests
🔸 Tests weight: 35 | The uninstall procedure must remove all plugin files and extra database tables
Please fix the following items
- Zombie WordPress options were found after uninstall: 10 options
- can_compress_scripts
- widget_documentation_categories_widget
- widget_documentation_document_hierarchy_widget
- db_upgraded
- widget_documentation_documents_widget
- widget_recent-comments
- widget_documentation_document_children_widget
- theysaidso_admin_options
- widget_theysaidso_widget
- widget_recent-posts
Smoke tests Passed 4 tests
Server-side errors Passed 1 test
🔹 Test weight: 20 | This is a shallow check for server-side errors
Even though everything seems fine, this is not an exhaustive test
SRP Passed 2 tests
🔹 Tests weight: 20 | SRP (Single-Responsibility Principle) - PHP files must act as libraries and never output text or perform any action when accessed directly in a browser
The SRP test was a success
User-side errors Passed 1 test
🔹 Test weight: 20 | This is just a short smoke test looking for browser issues
Everything seems fine, but this is not an exhaustive test
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 to be fixed:
- Screenshots: These screenshots need descriptions #12, #13, #14, #15, #16, #17, #18 in documentation/assets to your readme.txt
documentation/documentation.php Passed 13 tests
The main file in "Documentation" v. 1.11.0 serves as a complement to information provided in readme.txt and as the entry point to the plugin
34 characters long description:
A Documentation Management System.
Code Analysis Passed 3 tests
File types Passed 1 test
🔸 Test weight: 35 | A short check of programming languages and file extensions; no executable files are allowed
There were no executable files found in this plugin2,532 lines of code in 24 files:
| Language | Files | Blank lines | Comment lines | Lines of code |
|---|---|---|---|---|
| PHP | 17 | 411 | 1,128 | 2,301 |
| CSS | 4 | 0 | 76 | 125 |
| JavaScript | 2 | 18 | 42 | 89 |
| Bourne Shell | 1 | 0 | 0 | 17 |
PHP code Passed 2 tests
This is a short overview of cyclomatic complexity and code structure for this plugin
There were no cyclomatic complexity issued detected
| Cyclomatic complexity | |
|---|---|
| Average complexity per logical line of code | 0.37 |
| Average class complexity | 25.60 |
| ▷ Minimum class complexity | 1.00 |
| ▷ Maximum class complexity | 96.00 |
| Average method complexity | 4.84 |
| ▷ Minimum method complexity | 1.00 |
| ▷ Maximum method complexity | 59.00 |
| Code structure | ||
|---|---|---|
| Namespaces | 0 | |
| Interfaces | 0 | |
| Traits | 0 | |
| Classes | 15 | |
| ▷ Abstract classes | 0 | 0.00% |
| ▷ Concrete classes | 15 | 100.00% |
| ▷ Final classes | 0 | 0.00% |
| Methods | 96 | |
| ▷ Static methods | 76 | 79.17% |
| ▷ Public methods | 92 | 95.83% |
| ▷ Protected methods | 0 | 0.00% |
| ▷ Private methods | 4 | 4.17% |
| Functions | 0 | |
| ▷ Named functions | 0 | 0.00% |
| ▷ Anonymous functions | 0 | 0.00% |
| Constants | 24 | |
| ▷ Global constants | 10 | 41.67% |
| ▷ Class constants | 14 | 58.33% |
| ▷ Public constants | 14 | 100.00% |
Plugin size Passed 2 tests
Image compression Passed 2 tests
Often times overlooked, PNG files can occupy unnecessary space in your plugin
14 PNG files occupy 0.13MB with 0.07MB in potential savings
Potential savings
| Compression of 5 random PNG files using pngquant | |||
|---|---|---|---|
| File | Size - original | Size - compressed | Savings |
| images/add-ons/groups.png | 5.75KB | 2.63KB | ▼ 54.21% |
| images/documentation.png | 0.34KB | 0.25KB | ▼ 26.74% |
| images/add-ons/woocommerce-documentation.png | 10.46KB | 4.18KB | ▼ 60.07% |
| images/add-ons/affiliates.png | 10.15KB | 4.46KB | ▼ 56.04% |
| images/add-ons/widgets-control.png | 8.58KB | 3.86KB | ▼ 54.96% |