10% xowl-service-client

Code Review | xowl-client

WordPress plugin xowl-client scored 10% from 54 tests.

About plugin

  • Plugin page: xowl-service-client
  • Plugin version: 0.1
  • PHP version: 7.4.16
  • WordPress compatibility: 4.2.2-4.2.2
  • WordPress version: 6.3.1
  • First release: Jul 27, 2015
  • Latest release: Jul 27, 2015
  • Number of updates: 4
  • Update frequency: every 3.0 days
  • Top authors: oxe (100%)

Code review

54 tests

User reviews

1 review

Install metrics

10+ active / 551 total downloads

Benchmarks

Plugin footprint 58% from 16 tests

Installer 0% from 1 test

🔺 Critical test (weight: 50) | It is important to correctly install your plugin, without throwing errors or notices
The following installer errors require your attention
  • Install procedure validation failed for this plugin
    • > User deprecated in wp-includes/functions.php+5747
    Function add_option was called with an argument that is deprecated since version 2.3.0 with no alternative available.

Server metrics [RAM: ▲0.04MB] [CPU: ▼2.88ms] Passed 4 tests

An overview of server-side resources used by xowl-client
Server-side resource usage in normal parameters
PageMemory (MB)CPU Time (ms)
Home /3.51 ▲0.0539.37 ▲0.29
Dashboard /wp-admin3.35 ▲0.0446.90 ▼5.54
Posts /wp-admin/edit.php3.46 ▲0.1047.39 ▼0.95
Add New Post /wp-admin/post-new.php5.93 ▲0.0494.50 ▼5.32
Media Library /wp-admin/upload.php3.27 ▲0.0435.65 ▲3.72
Xowl Service /wp-admin/options-general.php?page=xowl-config3.2432.84

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

Analyzing filesystem and database footprints of this plugin
No storage issues were detected
Filesystem: 20 new files
Database: no new tables, 9 new options
New WordPress options
widget_theysaidso_widget
can_compress_scripts
theysaidso_admin_options
xowl_apikey
db_upgraded
xowl_register
widget_recent-posts
xowl_endpoint
widget_recent-comments

Browser metrics Passed 4 tests

A check of browser resources used by xowl-client
Normal browser usage
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,804 ▲6913.28 ▼1.461.68 ▼0.1042.16 ▼2.80
Dashboard /wp-admin2,210 ▲225.83 ▲0.93101.42 ▼15.2840.69 ▼5.94
Posts /wp-admin/edit.php2,093 ▲72.05 ▲0.0338.24 ▲0.3335.37 ▲1.57
Add New Post /wp-admin/post-new.php1,538 ▲223.12 ▲0.03585.58 ▼106.2054.58 ▼14.29
Media Library /wp-admin/upload.php1,392 ▲74.17 ▼0.0393.94 ▼5.7142.10 ▼0.73
Xowl Service /wp-admin/options-general.php?page=xowl-config9302.0329.7439.15

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
These items require your attention
  • The uninstall procedure has failed, leaving 9 options in the database
    • xowl_endpoint
    • widget_recent-comments
    • xowl_register
    • db_upgraded
    • can_compress_scripts
    • theysaidso_admin_options
    • widget_recent-posts
    • widget_theysaidso_widget
    • xowl_apikey

Smoke tests 50% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | This is a shallow check for server-side errors
Good news, no errors were detected

SRP 0% from 2 tests

🔹 Tests weight: 20 | The single-responsibility principle: PHP files have to remain inert when accessed directly, throwing no errors and performing no actions
Almost there! Just fix the following items
  • 1× PHP files output text when accessed directly:
    • > /wp-content/plugins/xowl-service-client/wp-xowl-client.php
  • 1× PHP files trigger server errors when accessed directly:
    • > PHP Fatal error
      Uncaught Error: Class 'XowlClient' not found in wp-content/plugins/xowl-service-client/inc/xowl-config.php:5

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 90% from 29 tests

readme.txt 94% from 16 tests

You should put a lot of thought into formatting readme.txt as it is used by WordPress.org to prepare the public listing of your plugin
Attributes that need to be fixed:
  • Screenshots: Add images for these screenshots: #1 (enhancement01.png: post enhancement with external referencies to entities recognized, visually distinct by type (Person, Places, Organizations, etc..).), #2 (enhancement02.png: Disambiguation dialog that appears when an entity has more than one related meanings.), #3 (enhancement03.png: a published post with all the references to the official wikipedia pages of each entity.), #4 (enhancement04.png: the enhance post button on the TinyMCE's toolbar.)
The official readme.txt might help

xowl-service-client/wp-xowl-client.php 85% from 13 tests

The main PHP script in "xowl-client" version 0.1 is automatically included on every request by WordPress
Please take the time to fix the following:
  • Text Domain: Since WordPress version 4.6 the text domain is optional; if specified, it must be the same as the plugin slug
  • Main file name: It is recommended to name the main PHP file as the plugin slug ("xowl-service-client.php" instead of "wp-xowl-client.php")

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | This is a short overview of programming languages used in this plugin, detecting executable files
Everything looks great! No dangerous files found in this plugin715 lines of code in 8 files:
LanguageFilesBlank linesComment linesLines of code
LESS1637292
JavaScript2816212
PHP34945193
Markdown112017
CSS1001

PHP code Passed 2 tests

An short overview of logical lines of code, cyclomatic complexity, and other code metrics
This plugin has no cyclomatic complexity problems
Cyclomatic complexity
Average complexity per logical line of code0.08
Average class complexity2.50
▷ Minimum class complexity2.00
▷ Maximum class complexity3.00
Average method complexity1.18
▷ Minimum method complexity1.00
▷ Maximum method complexity3.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes2
▷ Abstract classes00.00%
▷ Concrete classes2100.00%
▷ Final classes00.00%
Methods17
▷ Static methods1694.12%
▷ Public methods1482.35%
▷ Protected methods00.00%
▷ Private methods317.65%
Functions0
▷ Named functions00.00%
▷ Anonymous functions00.00%
Constants4
▷ Global constants4100.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
10 PNG files occupy 0.36MB with 0.19MB in potential savings
Potential savings
Compression of 5 random PNG files using pngquant
FileSize - originalSize - compressedSavings
assets/imgs/screenshots/enhancement01.png161.39KB51.80KB▼ 67.91%
assets/imgs/enhance.png0.48KB0.31KB▼ 36.31%
assets/imgs/screenshots/enhancement03.png90.06KB29.81KB▼ 66.90%
assets/imgs/h2-back-2.png18.08KB11.15KB▼ 38.33%
assets/imgs/check-icon-2.png1.18KB0.55KB▼ 53.15%