84% simple-tour-guide

Code Review | Simple Tour Guide

WordPress plugin Simple Tour Guide scored84%from 54 tests.

About plugin

  • Plugin page: simple-tour-guide
  • Plugin version: 1.1.3
  • PHP compatiblity: 5.2.4+
  • PHP version: 7.4.16
  • WordPress compatibility: 4.4-6.2
  • WordPress version: 6.3.1
  • First release: Apr 14, 2021
  • Latest release: Jul 13, 2023
  • Number of updates: 90
  • Update frequency: every 9.1 days
  • Top authors: nravota12 (100%)

Code review

54 tests

User reviews

9 reviews

Install metrics

300+ active /4,570 total downloads

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | Verifying that this plugin installs correctly without errors
Install script ran successfully

Server metrics [RAM: ▲0.07MB] [CPU: ▼4.10ms] Passed 4 tests

A check of server-side resources used by Simple Tour Guide
Server-side resource usage in normal parameters
PageMemory (MB)CPU Time (ms)
Home /3.56 ▲0.0941.59 ▲2.57
Dashboard /wp-admin3.37 ▲0.0752.04 ▲1.78
Posts /wp-admin/edit.php3.42 ▲0.0750.30 ▲0.41
Add New Post /wp-admin/post-new.php5.97 ▲0.0986.75 ▼16.87
Media Library /wp-admin/upload.php3.30 ▲0.0737.93 ▼1.71
Simple Tour Guide /wp-admin/options-general.php?page=simple_tour_guide3.2834.09

Server storage [IO: ▲0.31MB] [DB: ▲0.07MB] Passed 3 tests

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

Browser metrics Passed 4 tests

A check of browser resources used by Simple Tour Guide
There were no issues detected in relation to browser resource usage
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,942 ▲18113.50 ▼0.868.67 ▲6.5246.77 ▲3.07
Dashboard /wp-admin2,225 ▲485.92 ▲0.3989.20 ▲1.0039.33 ▼0.26
Posts /wp-admin/edit.php2,135 ▲352.30 ▲0.3538.61 ▼2.4932.47 ▼4.67
Add New Post /wp-admin/post-new.php1,709 ▲18122.39 ▼0.74652.96 ▼38.1737.92 ▼18.67
Media Library /wp-admin/upload.php1,430 ▲274.42 ▲0.22101.30 ▼8.3542.14 ▼7.89
Simple Tour Guide /wp-admin/options-general.php?page=simple_tour_guide9361.9428.1930.97

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

🔸 Tests weight: 35 | It is important to correctly uninstall your plugin, without leaving any traces
You still need to fix the following
  • Zombie WordPress options were found after uninstall: 9 options
    • can_compress_scripts
    • stg_colors
    • widget_recent-posts
    • stg_tour
    • theysaidso_admin_options
    • widget_recent-comments
    • stg_settings
    • db_upgraded
    • widget_theysaidso_widget

Smoke tests 75% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | Just a short smoke test targeting errors on the server (in the Apache logs)
The smoke test was a success, however most plugin functionality was not tested

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
Please take a closer look at the following
  • 1× PHP files output non-empty strings when accessed directly via GET requests:
    • > /wp-content/plugins/simple-tour-guide/index.php

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

readme.txt Passed 16 tests

The readme.txt file is an important file in your plugin as it is parsed by WordPress.org to prepare the public listing of your plugin
5 plugin tags: tour, walkthrough, shepherd, introduction, user-onboarding

simple-tour-guide/index.php 85% from 13 tests

"Simple Tour Guide" version 1.1.3's primary PHP file adds more information about the plugin and serves as the entry point for WordPress
The following require your attention:
  • Main file name: Please rename the main PHP file in this plugin to the plugin slug ("simple-tour-guide.php" instead of "index.php")
  • Description: If Twitter did it, so should we! Keep the description under 140 characters (currently 333 characters long)

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
Good job! No executable or dangerous file extensions detected5,159 lines of code in 14 files:
LanguageFilesBlank linesComment linesLines of code
JavaScript59947854,481
PHP550111423
CSS400255

PHP code Passed 2 tests

An overview of cyclomatic complexity and code structure
All good! No complexity issues found
Cyclomatic complexity
Average complexity per logical line of code0.27
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
Namespaces0
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%
Functions15
▷ Named functions15100.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
PNG images were not found in this plugin