';
-
- global $wpdb;
- $autoload_values = \wp_autoload_values_to_autoload();
- $placeholders = implode( ',', array_fill( 0, count( $autoload_values ), '%s' ) );
-
- // phpcs:disable WordPress.DB
- $result = $wpdb->get_row(
- $wpdb->prepare( "SELECT count(*) AS count, SUM( LENGTH( option_value ) ) as autoload_size FROM {$wpdb->options} WHERE autoload IN ( $placeholders )", $autoload_values )
- );
- // phpcs:enable WordPress.DB
-
- echo '
' .
- sprintf(
- // translators: %1$s is the date, %2$s is the number of options at stat, %3$s is the size at start in KB, %4$s is the number of options now, %5$s is the size in KB now.
- esc_html__( 'When you started on %1$s you had %2$s autoloaded options, for %3$sKB of memory. Now you have %4$s options, for %5$sKB of memory.', 'aaa-option-optimizer' ),
- esc_html( gmdate( 'Y-m-d', strtotime( $option_optimizer['starting_point_date'] ) ) ),
- isset( $option_optimizer['starting_point_num'] ) ? esc_html( $option_optimizer['starting_point_num'] ) : '-',
- number_format( ( $option_optimizer['starting_point_kb'] ), 1 ),
- esc_html( $result->count ),
- number_format( ( $result->autoload_size / 1024 ), 1 )
- ) . '
' . esc_html__( 'AAA Meta Optimizer', 'aaa-meta-optimizer' ) . ' ';
- echo '
' . esc_html__( 'Optimize', 'aaa-option-optimizer' ) . ' ';
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- nonce is used for REST API.
if ( isset( $_GET['tracking_reset'] ) && $_GET['tracking_reset'] === 'true' ) {
- echo '
' . esc_html__( 'Tracking data has been reset.', 'aaa-option-optimizer' ) . '
';
+ echo '
' . esc_html__( 'Tracking data has been reset.', 'aaa-meta-optimizer' ) . '
';
// Take the parameter out of the URL without reloading the page.
echo '';
}
- echo '
' . esc_html__( 'Reset data', 'aaa-option-optimizer' ) . '
';
- echo '
' . esc_html__( 'We\'ve found the following things you can maybe optimize:', 'aaa-option-optimizer' ) . '
';
+ echo '
' . esc_html__( 'Reset data', 'aaa-meta-optimizer' ) . '
';
?>
-
+
' . esc_html__( 'Unused, but autoloaded', 'aaa-option-optimizer' ) . '';
- if ( ! empty( $unused_options ) ) {
- echo '
' . esc_html__( 'The following options are autoloaded on each pageload, but AAA Option Optimizer has not been able to detect them being used.', 'aaa-option-optimizer' );
+ echo '
';
+ if ( ! empty( $unused_meta_fields ) ) {
+ echo '
' . esc_html__( 'The following meta fields are not used.', 'aaa-meta-optimizer' );
echo '
';
- $this->table_section( 'thead', [ 'option', 'source', 'size', 'autoload', 'actions' ] );
+ $this->table_section( 'thead', [ 'option', 'source', 'actions' ] );
echo '';
- foreach ( $unused_options as $option => $value ) {
+ foreach ( $unused_meta_fields as $option => $value ) {
echo '' . esc_html( $option ) . ' ';
echo '' . esc_html( $this->get_plugin_name( $option ) ) . ' ';
- echo '' . esc_html( $this->get_length( $value ) ) . ' yes ';
echo '';
- // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- output escaped in get_value_button.
- echo $this->get_value_button( $option, $value );
- echo ' ';
- $this->table_section( 'tfoot', [ 'option', 'source', 'size', 'autoload', 'actions' ] );
+ $this->table_section( 'tfoot', [ 'option', 'source', 'actions' ] );
echo '
';
} else {
- echo '
' . esc_html__( 'All autoloaded options are in use.', 'aaa-option-optimizer' ) . '
';
+ echo '
' . esc_html__( 'All meta fields are in use.', 'aaa-meta-optimizer' ) . '
';
}
?>
-
+
' . esc_html__( 'Used, but not autoloaded options', 'aaa-option-optimizer' ) . '';
- echo '
' . esc_html__( 'The following options are *not* autoloaded on each pageload, but AAA Option Optimizer has detected that they are being used. If one of the options below has been called a lot and is not very big, you might consider adding autoload to that option.', 'aaa-option-optimizer' );
+ if ( ! empty( $meta_optimizer['used_meta_fields'] ) ) {
+ echo '
';
+ echo '
' . esc_html__( 'The following meta fields are being used.', 'aaa-meta-optimizer' );
echo '
';
- $this->table_section( 'thead', [ 'option', 'source', 'size', 'autoload', 'calls', 'actions' ] );
+ $this->table_section( 'thead', [ 'option', 'source', 'calls', 'actions' ] );
echo '';
- foreach ( $non_autoloaded_options_full as $option => $arr ) {
+ foreach ( $meta_optimizer['used_meta_fields'] as $option => $arr ) {
echo '';
echo '' . esc_html( $option ) . ' ';
echo '' . esc_html( $this->get_plugin_name( $option ) ) . ' ';
- echo '' . esc_html( $this->get_length( $arr['value'] ) ) . ' no ';
- echo '' . esc_html( $arr['count'] ) . ' ';
+ echo '' . esc_html( $arr ) . ' ';
echo '';
- // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- output escaped in get_value_button.
- echo $this->get_value_button( $option, $arr['value'] );
- echo '' . esc_html__( 'Add autoload', 'aaa-option-optimizer' ) . ' ';
echo ' ';
}
echo ' ';
- $this->table_section( 'tfoot', [ 'option', 'source', 'size', 'autoload', 'calls', 'actions' ] );
- echo '
';
- } else {
- echo '
' . esc_html__( 'All options that are used are autoloaded.', 'aaa-option-optimizer' ) . '
';
- }
- ?>
-
-
-
-
- ' . esc_html__( 'Requested options that do not exist', 'aaa-option-optimizer' ) . '';
- echo '
' . esc_html__( 'The following options are requested sometimes, but AAA Option Optimizer has detected that they do not exist. If one of the options below has been called a lot, it might help to create it with a value of false.', 'aaa-option-optimizer' );
- echo '
';
- $this->table_section( 'thead', [ 'option', 'source', 'calls', 'actions' ] );
- echo '';
- foreach ( $options_that_do_not_exist as $option => $count ) {
- echo '';
- echo '' . esc_html( $option ) . ' ';
- echo '' . esc_html( $this->get_plugin_name( $option ) ) . ' ';
- echo '' . esc_html( $count ) . ' ';
- echo '' . esc_html__( 'Create option with value false', 'aaa-option-optimizer' ) . ' ';
- }
- echo ' ';
$this->table_section( 'tfoot', [ 'option', 'source', 'calls', 'actions' ] );
echo '
';
+ } else {
+ echo '
' . esc_html__( 'There are no used meta fields.', 'aaa-meta-optimizer' ) . '
';
}
?>
-
-
-
-
-
-
- table_section( 'thead', [ 'option', 'source', 'size', 'autoload', 'actions' ] ); ?>
-
-
-
-
- table_section( 'tfoot', [ 'option', 'source', 'size', 'autoload', 'actions' ] ); ?>
-
-
' . esc_html__( 'Show', 'aaa-option-optimizer' ) . '
-
-
X ' .
- // translators: %s is the name of the option.
- '
' . sprintf( esc_html__( 'Value of %s', 'aaa-option-optimizer' ), '' . esc_html( $name ) . '' ) . '
-
' . htmlentities( $string, ENT_QUOTES | ENT_SUBSTITUTE ) . '
-
';
- }
-
/**
* Find plugin in known plugin prefixes list.
*
diff --git a/src/class-map-plugin-to-options.php b/src/class-map-plugin-to-options.php
index 2732f9a..93741ec 100644
--- a/src/class-map-plugin-to-options.php
+++ b/src/class-map-plugin-to-options.php
@@ -2,15 +2,15 @@
/**
* Functionality to map options to plugins.
*
- * @package Emilia\OptionOptimizer
+ * @package Emilia\MetaOptimizer
*/
-namespace Emilia\OptionOptimizer;
+namespace Emilia\MetaOptimizer;
/**
* Class Map_Plugin_To_Options
*
- * @package Emilia\OptionOptimizer
+ * @package Emilia\MetaOptimizer
*/
class Map_Plugin_To_Options {
/**
@@ -30,7 +30,7 @@ class Map_Plugin_To_Options {
public function get_plugin_name( string $option ): string {
$plugins_list = [];
if ( empty( $this->plugins_list ) ) {
- $this->plugins_list = json_decode( file_get_contents( plugin_dir_path( AAA_OPTION_OPTIMIZER_FILE ) . 'known-plugins/known-plugins.json' ), true );
+ $this->plugins_list = json_decode( file_get_contents( plugin_dir_path( AAA_META_OPTIMIZER_FILE ) . 'known-plugins/known-plugins.json' ), true );
}
// for each plugin in the list, check if the option starts with the prefix.
@@ -44,6 +44,6 @@ public function get_plugin_name( string $option ): string {
}
}
- return __( 'Unknown', 'aaa-option-optimizer' );
+ return __( 'Unknown', 'aaa-meta-optimizer' );
}
}
diff --git a/src/class-plugin.php b/src/class-plugin.php
index a679ed2..b42f17f 100644
--- a/src/class-plugin.php
+++ b/src/class-plugin.php
@@ -2,10 +2,10 @@
/**
* Plugin functionality for AAA Option Optimizer.
*
- * @package Emilia\OptionOptimizer
+ * @package Emilia\MetaOptimizer
*/
-namespace Emilia\OptionOptimizer;
+namespace Emilia\MetaOptimizer;
/**
* Core functionality of AAA Option Optimizer.
@@ -19,11 +19,11 @@ class Plugin {
public static $instance;
/**
- * Holds the names of the options accessed during the request.
+ * Holds the names of the meta fields accessed during the request.
*
* @var string[]
*/
- protected $accessed_options = [];
+ protected $accessed_meta_fields = [];
/**
* Whether the plugin should reset the option_optimizer data.
@@ -60,14 +60,14 @@ public static function get_instance() {
* @return void
*/
public function register_hooks() {
- $this->accessed_options = \get_option( 'option_optimizer', [ 'used_options' => [] ] )['used_options'];
+ $this->accessed_meta_fields = \get_option( 'meta_optimizer', [ 'used_meta_fields' => [] ] )['used_meta_fields'];
// Hook into all actions and filters to monitor option accesses.
// @phpstan-ignore-next-line -- The 'all' hook does not need a return.
- \add_filter( 'all', [ $this, 'monitor_option_accesses' ] );
+ \add_filter( 'all', [ $this, 'monitor_meta_field_accesses' ] );
// Use the shutdown action to update the option with tracked data.
- \add_action( 'shutdown', [ $this, 'update_tracked_options' ] );
+ \add_action( 'shutdown', [ $this, 'update_tracked_meta_fields' ] );
// Register the REST routes.
$rest = new REST();
@@ -98,50 +98,73 @@ public function reset( $should_reset = true ) {
*
* @return void
*/
- public function monitor_option_accesses( $tag ) {
- // Check if the tag is related to an option access.
- if ( strpos( $tag, 'option_' ) === 0 ) {
- $option_name = substr( $tag, strlen( 'option_' ) );
- $this->add_option_usage( $option_name );
+ public function monitor_meta_field_accesses( $tag ) {
+
+ // Check if the tag is related to a post meta field access.
+ if ( 'get_post_metadata' === $tag ) {
+ $args = func_get_args(); // phpcs:ignore -- Get all arguments passed to the hook.
+ $meta_key = $args[3];
+ $this->add_meta_field_usage( $meta_key );
+ }
+
+ // Check if the tag is related to a default post meta field access, meaning that the meta field doesn't exist in the database yet.
+ if ( 'default_post_metadata' === $tag ) {
+ $args = func_get_args(); // phpcs:ignore -- Get all arguments passed to the hook.
+ $meta_key = $args[3];
+ $this->remove_meta_field_usage( $meta_key );
}
}
/**
- * Add an option to the list of used options if it's not already there.
+ * Add a meta field to the list of used meta fields if it's not already there.
*
- * @param string $option_name Name of the option being accessed.
+ * @param string $meta_key Name of the meta field being accessed.
*
* @return void
*/
- protected function add_option_usage( $option_name ) {
+ protected function add_meta_field_usage( $meta_key ) {
// Check if this option hasn't been tracked yet and add it to the array.
- if ( ! array_key_exists( $option_name, $this->accessed_options ) ) {
- $this->accessed_options[ $option_name ] = 1;
+ if ( ! array_key_exists( $meta_key, $this->accessed_meta_fields ) ) {
+ $this->accessed_meta_fields[ $meta_key ] = 1;
return;
}
- ++$this->accessed_options[ $option_name ];
+ ++$this->accessed_meta_fields[ $meta_key ];
+ }
+
+ /**
+ * Add a meta field to the list of used meta fields if it's not already there.
+ *
+ * @param string $meta_key Name of the meta field being accessed.
+ *
+ * @return void
+ */
+ protected function remove_meta_field_usage( $meta_key ) {
+ // Check if this option hasn't been tracked yet and add it to the array.
+ if ( array_key_exists( $meta_key, $this->accessed_meta_fields ) ) {
+ unset( $this->accessed_meta_fields[ $meta_key ] );
+ }
}
/**
- * Update the 'option_optimizer' option with the list of used options at the end of the page load.
+ * Update the 'meta_optimizer' option with the list of used meta fields at the end of the page load.
*
* @return void
*/
- public function update_tracked_options() {
+ public function update_tracked_meta_fields() {
// phpcs:ignore WordPress.Security.NonceVerification -- not doing anything.
- if ( isset( $_GET['page'] ) && $_GET['page'] === 'aaa-option-optimizer' ) {
+ if ( isset( $_GET['page'] ) && $_GET['page'] === 'aaa-meta-optimizer' ) {
return;
}
- // Retrieve the existing option_optimizer data.
- $option_optimizer = get_option( 'option_optimizer', [ 'used_options' => [] ] );
+ // Retrieve the existing meta_optimizer data.
+ $meta_optimizer = get_option( 'meta_optimizer', [ 'used_meta_fields' => [] ] );
- $option_optimizer['used_options'] = $this->accessed_options;
+ $meta_optimizer['used_meta_fields'] = $this->accessed_meta_fields;
if ( $this->should_reset ) {
- $option_optimizer['used_options'] = [];
+ $meta_optimizer['used_meta_fields'] = [];
}
- // Update the 'option_optimizer' option with the new list.
- update_option( 'option_optimizer', $option_optimizer, true );
+ // Update the 'meta_optimizer' option with the new list.
+ update_option( 'meta_optimizer', $meta_optimizer, true );
}
}
diff --git a/src/class-rest.php b/src/class-rest.php
index f32ec3f..0b54570 100644
--- a/src/class-rest.php
+++ b/src/class-rest.php
@@ -2,13 +2,12 @@
/**
* REST functionality for AAA Option Optimizer.
*
- * @package Emilia\OptionOptimizer
+ * @package Emilia\MetaOptimizer
*/
-namespace Emilia\OptionOptimizer;
+namespace Emilia\MetaOptimizer;
use WP_Error;
-use WP_REST_Request;
use WP_REST_Response;
/**
@@ -16,21 +15,12 @@
*/
class REST {
- /**
- * The map plugin to options class.
- *
- * @var Map_Plugin_To_Options
- */
- private $map_plugin_to_options;
-
/**
* Registers hooks.
*
* @return void
*/
public function register_hooks() {
- $this->map_plugin_to_options = new Map_Plugin_To_Options();
-
add_action( 'rest_api_init', [ $this, 'register_rest_routes' ] );
}
@@ -40,78 +30,9 @@ public function register_hooks() {
* @return void
*/
public function register_rest_routes() {
- \register_rest_route(
- 'aaa-option-optimizer/v1',
- '/update-autoload',
- [
- 'methods' => 'POST',
- 'callback' => [ $this, 'update_option_autoload' ],
- 'permission_callback' => function () {
- return current_user_can( 'manage_options' );
- },
- 'args' => [
- 'option_name' => [
- 'required' => true,
- 'sanitize_callback' => 'sanitize_text_field',
- ],
- 'autoload' => [
- 'required' => true,
- 'sanitize_callback' => 'sanitize_text_field',
- ],
- ],
- ]
- );
\register_rest_route(
- 'aaa-option-optimizer/v1',
- '/delete-option',
- [
- 'methods' => 'POST',
- 'callback' => [ $this, 'delete_option' ],
- 'permission_callback' => function () {
- return current_user_can( 'manage_options' );
- },
- 'args' => [
- 'option_name' => [
- 'required' => true,
- 'sanitize_callback' => 'sanitize_text_field',
- ],
- ],
- ]
- );
-
- \register_rest_route(
- 'aaa-option-optimizer/v1',
- '/create-option-false',
- [
- 'methods' => 'POST',
- 'callback' => [ $this, 'create_option_false' ],
- 'permission_callback' => function () {
- return current_user_can( 'manage_options' );
- },
- 'args' => [
- 'option_name' => [
- 'required' => true,
- 'sanitize_callback' => 'sanitize_text_field',
- ],
- ],
- ]
- );
-
- \register_rest_route(
- 'aaa-option-optimizer/v1',
- '/all-options',
- [
- 'methods' => 'GET',
- 'callback' => [ $this, 'get_all_options' ],
- 'permission_callback' => function () {
- return current_user_can( 'manage_options' );
- },
- ]
- );
-
- \register_rest_route(
- 'aaa-option-optimizer/v1',
+ 'aaa-meta-optimizer/v1',
'/reset',
[
'methods' => 'POST',
@@ -132,92 +53,4 @@ public function reset_stats() {
Plugin::get_instance()->reset();
return new \WP_REST_Response( [ 'success' => true ], 200 );
}
-
- /**
- * Update autoload status of an option.
- *
- * @return \WP_Error|\WP_REST_Response
- */
- public function get_all_options() {
- global $wpdb;
-
- $output = [];
- // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching -- We need to query all options.
- $options = $wpdb->get_results( "SELECT option_name, option_value, autoload FROM $wpdb->options" );
- foreach ( $options as $option ) {
- $output[] = [
- 'name' => $option->option_name,
- 'plugin' => $this->map_plugin_to_options->get_plugin_name( $option->option_name ),
- 'value' => htmlentities( $option->option_value, ENT_QUOTES | ENT_SUBSTITUTE ),
- 'size' => number_format( strlen( $option->option_value ) / 1024, 2 ),
- 'autoload' => $option->autoload,
- 'row_id' => 'option_' . $option->option_name,
- ];
- }
- return new \WP_REST_Response( [ 'data' => $output ], 200 );
- }
-
- /**
- * Update autoload status of an option.
- *
- * @param \WP_REST_Request $request The REST request object.
- *
- * @return \WP_Error|\WP_REST_Response
- */
- public function update_option_autoload( $request ) {
- $option_name = $request['option_name'];
- $autoload = $request['autoload'];
- $option_value = get_option( $option_name );
-
- if ( ! in_array( $autoload, [ 'yes', 'on', 'no', 'off','auto', 'auto-on', 'auto-off' ], true ) ) {
- return new \WP_Error( 'invalid_autoload_value', 'Invalid autoload value', [ 'status' => 400 ] );
- }
-
- if ( false === $option_value ) {
- return new \WP_Error( 'option_not_found', 'Option does not exist', [ 'status' => 404 ] );
- }
-
- delete_option( $option_name );
- $autoload_values = \wp_autoload_values_to_autoload();
- $bool_autoload = false;
- if ( in_array( $autoload, $autoload_values, true ) ) {
- $bool_autoload = true;
- }
- $succeeded = add_option( $option_name, $option_value, '', $bool_autoload );
-
- if ( ! $succeeded ) {
- return new \WP_Error( 'update_failed', 'Updating the option failed', [ 'status' => 400 ] );
- }
- return new \WP_REST_Response( [ 'success' => true ], 200 );
- }
-
- /**
- * Delete an option.
- *
- * @param \WP_REST_Request $request The REST request object.
- *
- * @return \WP_REST_Response|\WP_Error
- */
- public function delete_option( $request ) {
- $option_name = $request['option_name'];
- if ( delete_option( $option_name ) ) {
- return new \WP_REST_Response( [ 'success' => true ], 200 );
- }
- return new \WP_Error( 'option_not_found_or_deleted', 'Option does not exist or could not be deleted', [ 'status' => 404 ] );
- }
-
- /**
- * Create an option with a false value.
- *
- * @param \WP_REST_Request $request The REST request object.
- *
- * @return \WP_Error|\WP_REST_Response
- */
- public function create_option_false( $request ) {
- $option_name = $request['option_name'];
- if ( add_option( $option_name, false, '', false ) ) {
- return new \WP_REST_Response( [ 'success' => true ], 200 );
- }
- return new \WP_Error( 'option_not_created', 'Option could not be created', [ 'status' => 400 ] );
- }
}
diff --git a/uninstall.php b/uninstall.php
index 4fa17e2..25981cd 100644
--- a/uninstall.php
+++ b/uninstall.php
@@ -13,4 +13,4 @@
}
// Delete the plugin option.
-delete_option( 'option_optimizer' );
+delete_option( 'meta_optimizer' );