🚀 RELEASE: v1.0.0

Author: robertdevore

README.md

@@ -1,6 +1,8 @@
 # BenchPress
 
-**BenchPress** is a WordPress plugin for benchmarking PHP code snippets, WordPress queries, and other critical operations. It's designed to help developers evaluate and optimize code performance by running benchmarks and capturing snapshots for comparison.
+**BenchPress** is a WordPress® plugin for benchmarking PHP code snippets, WordPress® queries, and other critical operations. 
+
+It's designed to help developers evaluate and optimize code performance by running benchmarks and capturing snapshots for later comparison.
 * * *
 
 ## Table of Contents
@@ -19,17 +21,17 @@
 ## Installation
 
 1. **Download** the plugin ZIP from the [GitHub repository](https://github.com/robertdevore/benchpress).
-2. **Upload** it via WordPress Admin:
+2. **Upload** it via WordPress® Admin:
     - Go to `Plugins` > `Add New`.
     - Click `Upload Plugin`, select the downloaded ZIP, and click `Install Now`.
-3. **Activate** the plugin via the `Plugins` page in the WordPress Admin.
+3. **Activate** the plugin via the `Plugins` page in the WordPress® Admin.
 * * *
 
 ## Setup
 
 BenchPress automatically creates a custom database table to store snapshots of benchmark results on activation. The plugin also includes settings to customize benchmark runs. To configure these:
 
-1. Go to `BenchPress > Settings` in your WordPress admin sidebar.
+1. Go to `BenchPress > Settings` in your WordPress® admin sidebar.
 2. Adjust loop counts, post IDs, and other options to customize how each benchmark runs.
 
 * * *
@@ -40,7 +42,7 @@ Once installed and configured, you can run benchmarks, view results, and save sn
 
 1. **Running Benchmarks**:
 
-    - Navigate to `BenchPress` in your WordPress admin menu.
+    - Navigate to `BenchPress` in your WordPress® admin menu.
     - Click `Refresh Tests` to run all enabled benchmarks and view results.
 2. **Saving Snapshots**:
 
@@ -67,42 +69,43 @@ BenchPress comes with several built-in benchmarks. Here's a quick overview:
 ### Adding Custom Benchmarks
 
 BenchPress includes a `benchpress_run_all_benchmarks` filter to allow you to add custom benchmarks. Here's an example of how to add your own benchmark:
-    ```
-    add_filter( 'benchpress_run_all_benchmarks', function( $benchmarks ) {
-        // Define your custom benchmark
-        $benchmarks[] = custom_benchmark_example();
-        return $benchmarks;
-    });
-    
-    // Custom benchmark function
-    function custom_benchmark_example() {
-        $loop_count = get_option( 'custom_benchmark_loop_count', 100000 );
-        $start_time = microtime( true );
-    
-        for ( $i = 0; $i < $loop_count; $i++ ) {
-            $result = $i * 2; // Example operation
-        }
-    
-        $execution_time = microtime( true ) - $start_time;
-    
-        return [
-            'name'          => esc_html__( 'Custom Benchmark', 'benchpress' ),
-            'execution_time'=> round( $execution_time, 5 ),
-            'description'   => sprintf( esc_html__( 'Executed a loop of %d iterations.', 'benchpress' ), $loop_count ),
-        ];
+
+```
+add_filter( 'benchpress_run_all_benchmarks', function( $benchmarks ) {
+    // Define your custom benchmark
+    $benchmarks[] = custom_benchmark_example();
+    return $benchmarks;
+});
+
+// Custom benchmark function
+function custom_benchmark_example() {
+    $loop_count = get_option( 'custom_benchmark_loop_count', 100000 );
+    $start_time = microtime( true );
+
+    for ( $i = 0; $i < $loop_count; $i++ ) {
+        $result = $i * 2; // Example operation
     }
-    ```
+
+    $execution_time = microtime( true ) - $start_time;
+
+    return [
+        'name'          => esc_html__( 'Custom Benchmark', 'benchpress' ),
+        'execution_time'=> round( $execution_time, 5 ),
+        'description'   => sprintf( esc_html__( 'Executed a loop of %d iterations.', 'benchpress' ), $loop_count ),
+    ];
+}
+```
 
 ### Removing Benchmarks
 
 If you want to remove a specific benchmark, you can use the same `benchpress_run_all_benchmarks` filter. For example, to remove the "Switch vs Match" benchmark:
-    ```
-    add_filter( 'benchpress_run_all_benchmarks', function( $benchmarks ) {
-        return array_filter( $benchmarks, function( $benchmark ) {
-            return $benchmark['name'] !== esc_html__( 'Switch vs Match', 'benchpress' );
-        });
+```
+add_filter( 'benchpress_run_all_benchmarks', function( $benchmarks ) {
+    return array_filter( $benchmarks, function( $benchmark ) {
+        return $benchmark['name'] !== esc_html__( 'Switch vs Match', 'benchpress' );
     });
-    ```
+});
+```
 
 ### Accessing Benchmark Data
 

assets/css/admin-style.css

@@ -10,4 +10,4 @@
 /* BenchPress icon - Hover color */
 #adminmenu .toplevel_page_benchpress:hover .wp-menu-image img {
     color: #FFF;
-}
+}

assets/css/style.css

@@ -1,6 +1,5 @@
 /* BenchPress styles */
 
-/* Hide empty tablenav div to improve layout */
 .tablenav.top {
     display: none;
 }

benchpress.php

@@ -5,7 +5,7 @@
   *
   * @link              https://robertdevore.com
   * @since             1.0.0
-  * @package           Back_In_Stock_Notifications
+  * @package           BenchPress
   *
   * @wordpress-plugin
   *
@@ -39,9 +39,9 @@
 use YahnisElsts\PluginUpdateChecker\v5\PucFactory;
 
 $myUpdateChecker = PucFactory::buildUpdateChecker(
-	'https://github.com/robertdevore/benchpress/',
-	__FILE__,
-	'benchpress'
+    'https://github.com/robertdevore/benchpress/',
+    __FILE__,
+    'benchpress'
 );
 
 // Set the branch that contains the stable release.
@@ -127,13 +127,13 @@ function benchpress_render_snapshots_page() {
     echo ' <button id="benchpress-clear-snapshots-btn" class="button" style="margin-left: 10px;"><span class="dashicons dashicons-trash"></span> ' . esc_html__( 'Clear Snapshots', 'benchpress' ) . '</button>';
     echo ' <button id="benchpress-download-snapshots-btn" class="button" style="margin-left: 10px;"><span class="dashicons dashicons-download"></span> ' . esc_html__( 'Download Snapshots', 'benchpress' ) . '</button>';
     echo '</h1><hr />';
-    echo '<p><a href="https://robertdevore.com/benchpress-documentation/" target="_blank">' . esc_html__( 'Documentation', 'benchpress' ) . '</a> &middot; <a href="https://robertdevore.com/contact/" target="_blank">' . esc_html__( 'Support', 'benchpress' ) . '</a> &middot; <a href="https://robertdevore.com/wordpress-and-woocommerce-plugins/" target="_blank">' . esc_html__( 'More Plugins', 'benchpress' ) . '</a></p>';
+    echo '<p><a href="https://robertdevore.com/articles/benchpress/" target="_blank">' . esc_html__( 'Documentation', 'benchpress' ) . '</a> &middot; <a href="https://robertdevore.com/contact/" target="_blank">' . esc_html__( 'Support', 'benchpress' ) . '</a> &middot; <a href="https://robertdevore.com/wordpress-and-woocommerce-plugins/" target="_blank">' . esc_html__( 'More Plugins', 'benchpress' ) . '</a></p>';
 
     $table = new BenchPress_Snapshots_Table();
     $table->prepare_items();
     $table->display();
 
-    // Modal HTML for viewing snapshot data.
+    // Modal HTML for viewing the snapshot data.
     echo '
         <div id="snapshotModal" class="snapshot-modal" style="display:none;">
             <div class="snapshot-modal-content">
@@ -177,7 +177,7 @@ function benchpress_render_page() {
 /**
  * Render the BenchPress settings page.
  *
- * @since 1.0.0
+ * @since  1.0.0
  * @return void
  */
 function benchpress_render_settings_page() {
@@ -221,7 +221,7 @@ function benchpress_render_settings_page() {
         <a id="benchpress-support-btn" href="https://robertdevore.com/contact/" target="_blank" class="button button-alt" style="margin-left: 10px;">
             <span class="dashicons dashicons-format-chat" style="vertical-align: middle;"></span> ' . esc_html__( 'Support', 'benchpress' ) . '
         </a>
-        <a id="benchpress-docs-btn" href="https://robertdevore.com/benchpress-documentation/" target="_blank" class="button button-alt" style="margin-left: 5px;">
+        <a id="benchpress-docs-btn" href="https://robertdevore.com/articles/benchpress/" target="_blank" class="button button-alt" style="margin-left: 5px;">
             <span class="dashicons dashicons-media-document" style="vertical-align: middle;"></span> ' . esc_html__( 'Documentation', 'benchpress' ) . '
         </a>
     </h1><hr />';

classes/BenchPress_Snapshots_Table.php

@@ -1,5 +1,5 @@
 <?php
-// Snapshot List Table class
+// Snapshot List Table class.
 if ( ! class_exists( 'WP_List_Table' ) ) {
     require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
 }
@@ -8,8 +8,8 @@ class BenchPress_Snapshots_Table extends WP_List_Table {
 
     public function __construct() {
         parent::__construct([
-            'singular' => __( 'Snapshot', 'benchpress' ),
-            'plural'   => __( 'Snapshots', 'benchpress' ),
+            'singular' => esc_html__( 'Snapshot', 'benchpress' ),
+            'plural'   => esc_html__( 'Snapshots', 'benchpress' ),
             'ajax'     => false,
         ]);
     }
@@ -19,9 +19,9 @@ public function __construct() {
      */
     public function get_columns() {
         return [
-            'id'           => __( 'ID', 'benchpress' ),
-            'created_at'   => __( 'Date', 'benchpress' ),
-            'snapshot_data'=> __( 'Actions', 'benchpress' ),
+            'id'           => esc_html__( 'ID', 'benchpress' ),
+            'created_at'   => esc_html__( 'Date', 'benchpress' ),
+            'snapshot_data'=> esc_html__( 'Actions', 'benchpress' ),
         ];
     }
 
@@ -79,19 +79,19 @@ protected function column_default( $item, $column_name ) {
                 return esc_html( date_i18n( get_option( 'date_format' ), strtotime( $item['created_at'] ) ) );
             case 'snapshot_data':
                 $encoded_data = esc_attr( json_encode( json_decode( $item['snapshot_data'], true ) ) );
-    
-                // View (eye) and Delete (trash) buttons
+
+                // View (eye) and Delete (trash) buttons.
                 return sprintf(
                     '<button class="button view-data-btn" data-snapshot="%s" aria-label="%s"><span class="dashicons dashicons-visibility"></span></button>
                      <button class="button delete-snapshot-btn" data-id="%d" aria-label="%s" style="margin-left: 5px;"><span class="dashicons dashicons-trash"></span></button>',
                     $encoded_data,
-                    __( 'View Data', 'benchpress' ),
+                    esc_html__( 'View Data', 'benchpress' ),
                     esc_attr( $item['id'] ),
-                    __( 'Delete Snapshot', 'benchpress' )
+                    esc_html__( 'Delete Snapshot', 'benchpress' )
                 );
             default:
                 return print_r( $item, true );
         }
-    }    
-    
+    }
+
 }

classes/BenchPress_Table.php

@@ -38,10 +38,10 @@ public function get_columns() {
      * Prepare items for the table.
      */
     public function prepare_items() {
-        $benchmarks = benchpress_run_all_benchmarks();
+        $benchmarks  = benchpress_run_all_benchmarks();
         $this->items = $benchmarks;
 
-        $columns  = $this->get_columns();
+        $columns = $this->get_columns();
         $this->_column_headers = [ $columns, [], [] ];
     }