| @@ -8,13 +8,8 @@ | ||
| 8 | 8 | */ |
| 9 | 9 | |
| 10 | 10 | namespace Fragen\WP_Debugging; |
| 11 | 11 | |
| 12 | -// Exit if called directly. | |
| 13 | -if ( ! defined( 'WPINC' ) ) { | |
| 14 | - die; | |
| 15 | -} | |
| 16 | - | |
| 17 | 12 | /** |
| 18 | 13 | * Class Settings |
| 19 | 14 | */ |
| 20 | 15 | class Settings { |
| @@ -20,64 +15,26 @@ | ||
| 20 | 15 | class Settings { |
| 21 | 16 | /** |
| 22 | 17 | * Hold plugin options. |
| 23 | 18 | * |
| 24 | - * @var array | |
| 19 | + * @var array $options | |
| 25 | 20 | */ |
| 26 | 21 | protected static $options; |
| 27 | 22 | |
| 28 | 23 | /** |
| 29 | - * Hold `wp-config.php` file path. | |
| 30 | - * | |
| 31 | - * @var string | |
| 32 | - */ | |
| 33 | - protected static $config_path; | |
| 34 | - | |
| 35 | - /** | |
| 36 | - * Holds pre-defined constants for `wp-config.php`. | |
| 37 | - * | |
| 38 | - * @var array | |
| 39 | - */ | |
| 40 | - protected $defined_constants; | |
| 41 | - | |
| 42 | - /** | |
| 43 | - * Holds config args for WPConfigTransformer. | |
| 44 | - * | |
| 45 | - * @var array | |
| 46 | - */ | |
| 47 | - protected static $config_args; | |
| 48 | - | |
| 49 | - /** | |
| 50 | 24 | * Constructor. |
| 51 | 25 | * |
| 52 | - * @param array $options Plugin options. | |
| 53 | - * @param string $config_path Path to config file. | |
| 54 | - * @param array $defined_constants Pre-defined constant group. | |
| 26 | + * @param array $options Plugin options. | |
| 55 | 27 | * @return void |
| 56 | 28 | */ |
| 57 | - public function __construct( $options, $config_path, $defined_constants ) { | |
| 58 | - self::$options = $options; | |
| 59 | - self::$config_path = $config_path; | |
| 60 | - $this->defined_constants = $defined_constants; | |
| 61 | - self::$config_args = [ 'normalize' => true ]; | |
| 62 | - | |
| 63 | - if ( false === strpos( file_get_contents( self::$config_path ), "/* That's all, stop editing!" ) ) { | |
| 64 | - if ( 1 === preg_match( '@\$table_prefix(.*;)@', file_get_contents( self::$config_path ), $matches ) ) { | |
| 65 | - self::$config_args = array_merge( | |
| 66 | - self::$config_args, | |
| 67 | - [ | |
| 68 | - 'anchor' => "$matches[0]", | |
| 69 | - 'placement' => 'after', | |
| 70 | - ] | |
| 71 | - ); | |
| 72 | - } | |
| 73 | - } | |
| 29 | + public function __construct( $options ) { | |
| 30 | + self::$options = $options; | |
| 74 | 31 | } |
| 75 | 32 | |
| 76 | 33 | /** |
| 77 | 34 | * Load hooks for settings. |
| 78 | 35 | * |
| 79 | - * @return self | |
| 36 | + * @return void | |
| 80 | 37 | */ |
| 81 | 38 | public function load_hooks() { |
| 82 | 39 | add_action( 'admin_init', [ $this, 'add_settings' ] ); |
| 83 | 40 | add_action( is_multisite() ? 'network_admin_menu' : 'admin_menu', [ $this, 'add_plugin_menu' ] ); |
| @@ -88,10 +45,8 @@ | ||
| 88 | 45 | ? 'network_admin_plugin_action_links_wp-debugging/wp-debugging.php' |
| 89 | 46 | : 'plugin_action_links_wp-debugging/wp-debugging.php', |
| 90 | 47 | [ $this, 'plugin_action_links' ] |
| 91 | 48 | ); |
| 92 | - | |
| 93 | - return $this; | |
| 94 | 49 | } |
| 95 | 50 | |
| 96 | 51 | /** |
| 97 | 52 | * Add plugin menu. |
| @@ -99,14 +54,14 @@ | ||
| 99 | 54 | * @return void |
| 100 | 55 | */ |
| 101 | 56 | public function add_plugin_menu() { |
| 102 | 57 | $parent = is_multisite() ? 'settings.php' : 'tools.php'; |
| 103 | - $capability = is_multisite() ? 'manage_network_options' : 'manage_options'; | |
| 58 | + $capability = is_multisite() ? 'manage_network' : 'manage_options'; | |
| 104 | 59 | |
| 105 | 60 | add_submenu_page( |
| 106 | 61 | $parent, |
| 107 | 62 | esc_html__( 'WP Debugging', 'wp-debugging' ), |
| 108 | - esc_html_x( 'WP Debugging', 'Menu item', 'wp-debugging' ), | |
| 63 | + esc_html__( 'WP Debugging', 'wp-debugging' ), | |
| 109 | 64 | $capability, |
| 110 | 65 | 'wp-debugging', |
| 111 | 66 | [ $this, 'create_settings_page' ] |
| 112 | 67 | ); |
| @@ -117,27 +72,19 @@ | ||
| 117 | 72 | * |
| 118 | 73 | * @return void |
| 119 | 74 | */ |
| 120 | 75 | public function update_settings() { |
| 121 | - // Exit if improper privileges. | |
| 122 | - if ( ! current_user_can( 'manage_options' ) | |
| 123 | - || ( ! isset( $_POST['_wpnonce'] ) || ! wp_verify_nonce( sanitize_key( wp_unslash( $_POST['_wpnonce'] ) ), 'wp_debugging-options' ) ) | |
| 124 | - ) { | |
| 125 | - return; | |
| 126 | - } | |
| 127 | - | |
| 128 | 76 | if ( isset( $_POST['option_page'] ) && |
| 129 | 77 | 'wp_debugging' === $_POST['option_page'] |
| 130 | 78 | ) { |
| 131 | 79 | $options = isset( $_POST['wp-debugging'] ) |
| 132 | - ? array_map( 'sanitize_text_field', wp_unslash( $_POST['wp-debugging'] ) ) | |
| 80 | + ? $_POST['wp-debugging'] | |
| 133 | 81 | : []; |
| 134 | - | |
| 135 | - $options = $this->sanitize( $options ); | |
| 82 | + $options = self::sanitize( $options ); | |
| 136 | 83 | $this->update_constants( self::$options, $options ); |
| 137 | 84 | $filtered_options = array_filter( |
| 138 | 85 | self::$options, |
| 139 | - static function ( $e ) { | |
| 86 | + function ( $e ) { | |
| 140 | 87 | return '1' !== $e; |
| 141 | 88 | } |
| 142 | 89 | ); |
| 143 | 90 | $options = array_merge( $filtered_options, $options ); |
| @@ -148,15 +95,15 @@ | ||
| 148 | 95 | |
| 149 | 96 | /** |
| 150 | 97 | * Update constants in wp-config.php. |
| 151 | 98 | * |
| 152 | - * @param array $old Current value of self::$options. | |
| 153 | - * @param mixed $updated New value of $options. | |
| 99 | + * @param array $old Current value of self::$options. | |
| 100 | + * @param mixed $new New value of $options. | |
| 154 | 101 | * @return void |
| 155 | 102 | */ |
| 156 | - private function update_constants( $old, $updated ) { | |
| 157 | - $remove = array_diff_assoc( $old, $updated ); | |
| 158 | - $add = array_diff_assoc( $updated, $old ); | |
| 103 | + private function update_constants( $old, $new ) { | |
| 104 | + $remove = array_diff_assoc( $old, $new ); | |
| 105 | + $add = array_diff_assoc( $new, $old ); | |
| 159 | 106 | |
| 160 | 107 | if ( ! empty( $add ) ) { |
| 161 | 108 | $this->add_constants( $add ); |
| 162 | 109 | } |
| @@ -170,65 +117,20 @@ | ||
| 170 | 117 | * |
| 171 | 118 | * @uses https://github.com/wp-cli/wp-config-transformer |
| 172 | 119 | * |
| 173 | 120 | * @param array $add Constants to add to wp-config.php. |
| 174 | - * @return array $added Array of added constants. | |
| 175 | - */ | |
| 176 | - public function add_constants( $add ) { | |
| 177 | - $added = []; | |
| 178 | - try { | |
| 179 | - $config_transformer = new \WPConfigTransformer( self::$config_path ); | |
| 180 | - foreach ( $add as $constant => $config ) { | |
| 181 | - $value = 'wp_debug_display' === $constant ? 'false' : 'true'; | |
| 182 | - $value = isset( $config['value'] ) ? $config['value'] : $value; | |
| 183 | - $raw = isset( $config['raw'] ) ? $config['raw'] : true; | |
| 184 | - self::$config_args = array_merge( self::$config_args, [ 'raw' => $raw ] ); | |
| 185 | - $config_transformer->update( 'constant', strtoupper( $constant ), $value, self::$config_args ); | |
| 186 | - $added[ $constant ] = $value; | |
| 187 | - } | |
| 188 | - | |
| 189 | - return $added; | |
| 190 | - } catch ( \Exception $e ) { | |
| 191 | - $messsage = 'Caught Exception: \Fragen\WP_Debugging\Settings::add_constants() - ' . $e->getMessage(); | |
| 192 | - wp_die( esc_html( $messsage ) ); | |
| 193 | - } | |
| 194 | - } | |
| 195 | - | |
| 196 | - /** | |
| 197 | - * Process user defined constants added via filter. | |
| 198 | - * | |
| 199 | 121 | * @return void |
| 200 | 122 | */ |
| 201 | - public function process_filter_constants() { | |
| 202 | - /** | |
| 203 | - * Filter to add user define constants. | |
| 204 | - * | |
| 205 | - * @since 2.5.0 | |
| 206 | - * | |
| 207 | - * @param array Array of added constants. | |
| 208 | - * The format for adding constants is to return an array of arrays. | |
| 209 | - * Each array will have the constant as the key with an array of configuration data. | |
| 210 | - * array( | |
| 211 | - * 'my_constant' => | |
| 212 | - * array( | |
| 213 | - * 'value' => $value, @type string | |
| 214 | - * 'raw' => $raw, // Optional. @type bool $raw is a boolean where false will return the value in quotes and true will return the raw value. Default is true. | |
| 215 | - * ), | |
| 216 | - * ) | |
| 217 | - * Default is an empty array. | |
| 218 | - */ | |
| 219 | - $filter_constants = apply_filters( 'wp_debugging_add_constants', [] ); | |
| 220 | - $remove_user_defined = array_diff( self::$options, array_flip( $this->defined_constants ) ); | |
| 221 | - | |
| 222 | - // Remove and re-add user defined constants. Clean up for when filter removed or changed. | |
| 223 | - if ( ! empty( $remove_user_defined ) ) { | |
| 224 | - $this->remove_constants( $remove_user_defined ); | |
| 123 | + private function add_constants( $add ) { | |
| 124 | + $config_transformer = new \WPConfigTransformer( ABSPATH . 'wp-config.php' ); | |
| 125 | + $config_args = [ | |
| 126 | + 'raw' => true, | |
| 127 | + 'normalize' => true, | |
| 128 | + ]; | |
| 129 | + foreach ( array_keys( $add ) as $constant ) { | |
| 130 | + $value = 'wp_debug_display' === $constant ? 'false' : 'true'; | |
| 131 | + $config_transformer->update( 'constant', strtoupper( $constant ), $value, $config_args ); | |
| 225 | 132 | } |
| 226 | - $added_constants = $this->add_constants( $filter_constants ); | |
| 227 | - | |
| 228 | - $options = array_diff( self::$options, $remove_user_defined ); | |
| 229 | - self::$options = array_merge( $options, $added_constants ); | |
| 230 | - update_site_option( 'wp_debugging', (array) self::$options ); | |
| 231 | 133 | } |
| 232 | 134 | |
| 233 | 135 | /** |
| 234 | 136 | * Remove constants from wp-config.php file. |
| @@ -237,17 +139,12 @@ | ||
| 237 | 139 | * |
| 238 | 140 | * @param array $remove Constants to remove from wp-config.php. |
| 239 | 141 | * @return void |
| 240 | 142 | */ |
| 241 | - public function remove_constants( $remove ) { | |
| 242 | - try { | |
| 243 | - $config_transformer = new \WPConfigTransformer( self::$config_path ); | |
| 244 | - foreach ( array_keys( $remove ) as $constant ) { | |
| 245 | - $config_transformer->remove( 'constant', strtoupper( $constant ) ); | |
| 246 | - } | |
| 247 | - } catch ( \Exception $e ) { | |
| 248 | - $messsage = 'Caught Exception: \Fragen\WP_Debugging\Settings::remove_constants() - ' . $e->getMessage(); | |
| 249 | - wp_die( esc_html( $messsage ) ); | |
| 143 | + private function remove_constants( $remove ) { | |
| 144 | + $config_transformer = new \WPConfigTransformer( ABSPATH . 'wp-config.php' ); | |
| 145 | + foreach ( array_keys( $remove ) as $constant ) { | |
| 146 | + $config_transformer->remove( 'constant', strtoupper( $constant ) ); | |
| 250 | 147 | } |
| 251 | 148 | } |
| 252 | 149 | |
| 253 | 150 | /** |
| @@ -256,16 +153,13 @@ | ||
| 256 | 153 | * @return void |
| 257 | 154 | */ |
| 258 | 155 | private function redirect_on_save() { |
| 259 | 156 | $update = false; |
| 260 | - | |
| 261 | - // phpcs:disable WordPress.Security.NonceVerification.Missing | |
| 262 | 157 | if ( ( isset( $_POST['action'] ) && 'update' === $_POST['action'] ) && |
| 263 | 158 | ( isset( $_POST['option_page'] ) && 'wp_debugging' === $_POST['option_page'] ) |
| 264 | 159 | ) { |
| 265 | 160 | $update = true; |
| 266 | 161 | } |
| 267 | - // phpcs:enable | |
| 268 | 162 | |
| 269 | 163 | $redirect_url = is_multisite() ? network_admin_url( 'settings.php' ) : admin_url( 'tools.php' ); |
| 270 | 164 | |
| 271 | 165 | if ( $update ) { |
| @@ -286,17 +180,15 @@ | ||
| 286 | 180 | * |
| 287 | 181 | * @return void |
| 288 | 182 | */ |
| 289 | 183 | private function saved_settings_notice() { |
| 290 | - // phpcs:disable WordPress.Security.NonceVerification.Recommended | |
| 291 | - if ( ( isset( $_GET['updated'] ) && '1' === $_GET['updated'] ) || | |
| 292 | - ( isset( $_GET['settings-updated'] ) && '1' === $_GET['settings-updated'] ) | |
| 184 | + if ( ( isset( $_GET['updated'] ) && true == $_GET['updated'] ) || | |
| 185 | + ( isset( $_GET['settings-updated'] ) && true == $_GET['settings-updated'] ) | |
| 293 | 186 | ) { |
| 294 | 187 | echo '<div class="updated"><p>'; |
| 295 | 188 | esc_html_e( 'Saved.', 'wp-debugging' ); |
| 296 | 189 | echo '</p></div>'; |
| 297 | 190 | } |
| 298 | - // phpcs:enable | |
| 299 | 191 | } |
| 300 | 192 | |
| 301 | 193 | /** |
| 302 | 194 | * Register settings. |
| @@ -340,20 +232,21 @@ | ||
| 340 | 232 | 'title' => esc_html__( 'Set WP_DEBUG_DISPLAY to false, default is true.', 'wp-debugging' ), |
| 341 | 233 | ] |
| 342 | 234 | ); |
| 343 | 235 | |
| 344 | - add_settings_field( | |
| 345 | - 'wp_disable_fatal_error_handler', | |
| 346 | - null, | |
| 347 | - [ $this, 'checkbox_setting' ], | |
| 348 | - 'wp_debugging', | |
| 349 | - 'wp_debugging', | |
| 350 | - [ | |
| 351 | - 'id' => 'wp_disable_fatal_error_handler', | |
| 352 | - 'title' => esc_html__( 'Set WP_DISABLE_FATAL_ERROR_HANDLER to true.', 'wp-debugging' ), | |
| 353 | - 'class' => version_compare( get_bloginfo( 'version' ), '5.2', '>=' ) ? '' : 'hidden', | |
| 354 | - ] | |
| 355 | - ); | |
| 236 | + if ( version_compare( get_bloginfo( 'version' ), '5.2-beta', '>=' ) ) { | |
| 237 | + add_settings_field( | |
| 238 | + 'wp_disable_fatal_error_handler', | |
| 239 | + null, | |
| 240 | + [ $this, 'checkbox_setting' ], | |
| 241 | + 'wp_debugging', | |
| 242 | + 'wp_debugging', | |
| 243 | + [ | |
| 244 | + 'id' => 'wp_disable_fatal_error_handler', | |
| 245 | + 'title' => esc_html__( 'Set WP_DISABLE_FATAL_ERROR_HANDLER to true.', 'wp-debugging' ), | |
| 246 | + ] | |
| 247 | + ); | |
| 248 | + } | |
| 356 | 249 | } |
| 357 | 250 | |
| 358 | 251 | /** |
| 359 | 252 | * Print settings section information. |
| @@ -371,32 +264,16 @@ | ||
| 371 | 264 | * |
| 372 | 265 | * @return void |
| 373 | 266 | */ |
| 374 | 267 | private function print_constants() { |
| 375 | - $added_constants = apply_filters( 'wp_debugging_add_constants', [] ); | |
| 376 | - $additional_constants = []; | |
| 377 | - if ( $added_constants ) { | |
| 378 | - foreach ( $added_constants as $constant => $config ) { | |
| 379 | - $additional_constants[ $constant ] = $config['value']; | |
| 380 | - } | |
| 381 | - } | |
| 382 | - | |
| 383 | - // Strip user defined constants from $constants array. | |
| 384 | 268 | $constants = [ 'wp_debug_log', 'script_debug', 'savequeries' ]; |
| 385 | 269 | $constants = array_merge( array_keys( self::$options ), $constants ); |
| 386 | - $constants = array_diff( $constants, array_keys( $additional_constants ) ); | |
| 387 | - | |
| 388 | 270 | echo '<pre>'; |
| 389 | 271 | foreach ( $constants as $constant ) { |
| 390 | 272 | $value = 'wp_debug_display' === $constant ? 'false' : 'true'; |
| 391 | 273 | $constant = strtoupper( $constant ); |
| 392 | - echo wp_kses_post( "<code>define( '{$constant}', {$value} );</code><br>" ); | |
| 274 | + echo( wp_kses_post( "<code>define( '{$constant}', {$value} );</code><br>" ) ); | |
| 393 | 275 | } |
| 394 | - foreach ( $additional_constants as $constant => $value ) { | |
| 395 | - $value = in_array( $value, [ 'true', 'false' ], true ) ? $value : "'$value'"; | |
| 396 | - $constant = strtoupper( $constant ); | |
| 397 | - echo wp_kses_post( "<code>define( '{$constant}', {$value} );</code><br>" ); | |
| 398 | - } | |
| 399 | 276 | echo '</pre>'; |
| 400 | 277 | } |
| 401 | 278 | |
| 402 | 279 | /** |
| @@ -409,12 +286,12 @@ | ||
| 409 | 286 | $action = is_multisite() ? 'edit.php?action=wp-debugging' : 'options.php'; ?> |
| 410 | 287 | <div class="wrap"> |
| 411 | 288 | <h1><?php esc_html_e( 'WP Debugging', 'wp-debugging' ); ?></h1> |
| 412 | 289 | <div class="updated fade"> |
| 413 | - <p><?php echo wp_kses_post( __( '<strong>Please note:</strong> Your <code>wp-config.php</code> file must be writable by the filesystem. Any errors will result in a PHP Exception being thrown. Debug constants as documented in <a href="https://wordpress.org/documentation/article/debugging-in-wordpress/">Debugging in WordPress</a>.', 'wp-debugging' ) ); ?></p> | |
| 290 | + <p><?php echo wp_kses_post( __( '<strong>Please note:</strong> Your <code>wp-config.php</code> file must be writable by the filesystem. Any errors will result in a PHP Exception being thrown. Debug constants per <a href="https://codex.wordpress.org/Debugging_in_WordPress">Debugging in WordPress</a>.', 'wp-debugging' ) ); ?></p> | |
| 414 | 291 | </div> |
| 415 | 292 | <div> |
| 416 | - <form method="post" action="<?php echo esc_attr( $action ); ?>"> | |
| 293 | + <form method="post" action="<?php esc_attr_e( $action ); ?>"> | |
| 417 | 294 | <?php settings_fields( 'wp_debugging' ); ?> |
| 418 | 295 | <?php do_settings_sections( 'wp_debugging' ); ?> |
| 419 | 296 | <?php submit_button(); ?> |
| 420 | 297 | </form> |
| @@ -443,17 +320,17 @@ | ||
| 443 | 320 | |
| 444 | 321 | /** |
| 445 | 322 | * Get the settings option array and print one of its values. |
| 446 | 323 | * |
| 447 | - * @param array $args 'id' and 'title'. | |
| 324 | + * @param array $args 'id' and 'title' | |
| 448 | 325 | */ |
| 449 | 326 | public function checkbox_setting( $args ) { |
| 450 | 327 | $checked = isset( self::$options[ $args['id'] ] ) ? self::$options[ $args['id'] ] : null; |
| 451 | 328 | ?> |
| 452 | 329 | <style> .form-table th { display:none; } </style> |
| 453 | - <label for="<?php echo esc_attr( $args['id'] ); ?>"> | |
| 454 | - <input type="checkbox" name="wp-debugging[<?php echo esc_attr( $args['id'] ); ?>]" value="1" <?php checked( '1', $checked ); ?> > | |
| 455 | - <?php echo esc_html( $args['title'] ); ?> | |
| 330 | + <label for="<?php esc_attr_e( $args['id'] ); ?>"> | |
| 331 | + <input type="checkbox" name="wp-debugging[<?php esc_attr_e( $args['id'] ); ?>]" value="1" <?php checked( '1', $checked ); ?> > | |
| 332 | + <?php echo $args['title']; ?> | |
| 456 | 333 | </label> |
| 457 | 334 | <?php |
| 458 | 335 | } |
| 459 | 336 | |
| @@ -468,7 +345,7 @@ | ||
| 468 | 345 | public function plugin_action_links( $links ) { |
| 469 | 346 | $settings_page = is_multisite() ? 'settings.php' : 'tools.php'; |
| 470 | 347 | $link = [ '<a href="' . esc_url( network_admin_url( $settings_page ) ) . '?page=wp-debugging">' . esc_html__( 'Settings', 'wp-debugging' ) . '</a>' ]; |
| 471 | 348 | |
| 472 | - return array_merge( $link, $links ); | |
| 349 | + return array_merge( $links, $link ); | |
| 473 | 350 | } |
| 474 | 351 | } |
