84% organized-docs

Code Review | Organized Docs

WordPress plugin Organized Docs scored84%from 54 tests.

About plugin

  • Plugin page: organized-docs
  • Plugin version: 2.6.3
  • PHP version: 7.4.16
  • WordPress compatibility: 4.0-5.5
  • WordPress version: 6.3.1
  • First release: Oct 24, 2013
  • Latest release: Aug 30, 2020
  • Number of updates: 90
  • Update frequency: every 27.8 days
  • Top authors: isabel104 (100%)

Code review

54 tests

User reviews

3 reviews

Install metrics

90+ active /9,457 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
Install script ran successfully

Server metrics [RAM: ▲0.31MB] [CPU: ▼1.64ms] Passed 4 tests

Server-side resources used by Organized Docs
No issues were detected with server-side resource usage
PageMemory (MB)CPU Time (ms)
Home /3.82 ▲0.3145.48 ▲5.49
Dashboard /wp-admin3.66 ▲0.3153.74 ▼1.03
Posts /wp-admin/edit.php3.78 ▲0.3854.97 ▲6.89
Add New Post /wp-admin/post-new.php6.24 ▲0.3189.33 ▼16.31
Media Library /wp-admin/upload.php3.58 ▲0.3139.54 ▲5.30
Add New /wp-admin/post-new.php?post_type=isa_docs3.7859.26
All Docs /wp-admin/edit.php?post_type=isa_docs3.6339.49
Settings /wp-admin/edit.php?post_type=isa_docs&page=organized-docs-settings3.5534.14
Docs Categories /wp-admin/edit-tags.php?taxonomy=isa_docs_category&post_type=isa_docs3.5737.62

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

A short overview of filesystem and database impact
The plugin installed successfully
Filesystem: 15 new files
Database: no new tables, 8 new options
New WordPress options
widget_recent-comments
theysaidso_admin_options
can_compress_scripts
widget_docs_section_contents
widget_recent-posts
widget_theysaidso_widget
db_upgraded
odocs_upgrade_two_six

Browser metrics Passed 4 tests

Checking browser requirements for Organized Docs
There were no issues detected in relation to browser resource usage
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,827 ▲6614.69 ▲0.501.78 ▲0.1138.61 ▼6.96
Dashboard /wp-admin2,221 ▲415.48 ▼0.1290.07 ▲0.1242.20 ▲5.09
Posts /wp-admin/edit.php2,135 ▲352.04 ▲0.0635.24 ▼6.4734.97 ▲2.52
Add New Post /wp-admin/post-new.php1,555 ▲2923.30 ▼0.37676.92 ▲34.3266.13 ▼5.27
Media Library /wp-admin/upload.php1,435 ▲354.25 ▲0.09101.42 ▼9.9744.81 ▼1.14
Add New /wp-admin/post-new.php?post_type=isa_docs2,6167.90175.7565.84
All Docs /wp-admin/edit.php?post_type=isa_docs1,1531.9331.6532.98
Settings /wp-admin/edit.php?post_type=isa_docs&page=organized-docs-settings8732.0124.0627.92
Docs Categories /wp-admin/edit-tags.php?taxonomy=isa_docs_category&post_type=isa_docs1,3352.2526.9331.78

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

🔸 Tests weight: 35 | Verifying that this plugin uninstalls completely without leaving any traces
Please fix the following items
  • This plugin did not uninstall successfully, leaving 8 options in the database
    • odocs_upgrade_two_six
    • theysaidso_admin_options
    • db_upgraded
    • can_compress_scripts
    • widget_docs_section_contents
    • widget_recent-posts
    • widget_theysaidso_widget
    • widget_recent-comments

Smoke tests 75% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | A smoke test targeting server-side errors
Everything seems fine, however this is by no means 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
Please fix the following items
  • 7× GET requests to PHP files have triggered server-side errors or warnings:
    • > PHP Fatal error
      Uncaught Error: Call to undefined function plugin_dir_path() in wp-content/plugins/organized-docs/organized-docs.php:41
    • > PHP Fatal error
      Uncaught Error: Class 'WP_Widget' not found in wp-content/plugins/organized-docs/includes/widget.php:10
    • > PHP Fatal error
      Uncaught Error: Call to undefined function get_header() in wp-content/plugins/organized-docs/includes/templates/single.php:9
    • > PHP Fatal error
      Uncaught Error: Call to undefined function dynamic_sidebar() in wp-content/plugins/organized-docs/includes/templates/sidebar.php:10
    • > PHP Fatal error
      Uncaught Error: Call to undefined function get_header() in wp-content/plugins/organized-docs/includes/templates/archive.php:9
    • > PHP Fatal error
      Uncaught Error: Call to undefined function add_action() in wp-content/plugins/organized-docs/includes/templating.php:57
    • > PHP Fatal error
      Uncaught Error: Call to undefined function get_header() in wp-content/plugins/organized-docs/includes/templates/taxonomy.php:8

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)
No browser errors were detected

Optimizations

Plugin configuration 93% from 29 tests

readme.txt Passed 16 tests

Often overlooked, readme.txt is one of the most important files in your plugin
6 plugin tags: docs, organized docs, organized documentation, instruction guides, documentor...

organized-docs/organized-docs.php 85% from 13 tests

The main PHP script in "Organized Docs" version 2.6.3 is automatically included on every request by WordPress
You should first fix the following items:
  • Domain Path: Prefix the domain path with a forward slash character ("/languages")
  • Domain Path: You should use only dashes and lowercase characters for the domain path ("languages")

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | A short glimpse at programming languages used with this plugin and a check that no dangerous files are present
No dangerous file extensions were detected1,497 lines of code in 11 files:
LanguageFilesBlank linesComment linesLines of code
PHP82634261,341
CSS1147113
JavaScript25443

PHP code Passed 2 tests

This plugin's cyclomatic complexity and code structure detailed below
No complexity issues detected
Cyclomatic complexity
Average complexity per logical line of code0.29
Average class complexity56.00
▷ Minimum class complexity22.00
▷ Maximum class complexity90.00
Average method complexity2.80
▷ Minimum method complexity1.00
▷ Maximum method complexity21.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes2
▷ Abstract classes00.00%
▷ Concrete classes2100.00%
▷ Final classes00.00%
Methods61
▷ Static methods58.20%
▷ Public methods6098.36%
▷ Protected methods00.00%
▷ Private methods11.64%
Functions9
▷ Named functions9100.00%
▷ Anonymous functions00.00%
Constants1
▷ Global constants1100.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
1 PNG file occupies 0.01MB with 0.01MB in potential savings
Potential savings
Compression of 1 random PNG file using pngquant
FileSize - originalSize - compressedSavings
includes/organized-docs.png9.89KB4.46KB▼ 54.90%