wp-debugging / readme.txt

readme.txt in WP Debugging 2.10.2, at readme.txt

199 lines 7.0 KB

Raw Download Zip

1	# WP Debugging
2
3	Contributors: afragen
4	Tags: debug, support, wp-config
5	Requires at least: 4.6
6	Requires PHP: 5.6
7	Tested up to: 5.8
8	Stable tag: 2.10.2
9	Donate link: https://thefragens.com/git-updater-donate
10	License: MIT
11
12	A support/troubleshooting plugin for WordPress.
13
14	## Description
15
16	This plugin sets the following debug constants in `wp-config.php` on plugin activation and removes them on plugin deactivation. Any errors will result in a PHP Exception being thrown. Debug constants per [Debugging in WordPress](https://codex.wordpress.org/Debugging_in_WordPress).
17
18	Default settings:
19
20	define( 'WP_DEBUG_LOG', true );
21	define( 'SCRIPT_DEBUG', true );
22	define( 'SAVEQUERIES', true );
23
24
25	`@ini_set( 'display_errors', 1 );` is set when the plugin is active. `WP_DEBUG` is set to true when the plugin is first run, thereafter it can be turned off in the Settings.
26
27	The Settings page allows the user to set the following.
28
29	define( 'WP_DEBUG', true ); // Default on initial plugin installation.
30	define( 'WP_DEBUG_DISPLAY', false ); // Default when not declared is true.
31	define( 'WP_DISABLE_FATAL_ERROR_HANDLER', true ); // WordPress 5.2 WSOD Override.
32
33	When the plugin is deactivated best efforts are made to re-add pre-existing constants to their former state. When the plugin is activated the default settings and any saved settings are restored.
34
35	This plugin uses the [wp-cli/wp-config-transformer](https://github.com/wp-cli/wp-config-transformer) command for writing constants to `wp-config.php`.
36
37	[Debug Quick Look](https://github.com/norcross/debug-quick-look) from Andrew Norcross is included with this plugin to assist in reading the debug.log file. If you already have this plugin installed you should delete it when WP Debugging is not active.
38
39	[Query Monitor](https://wordpress.org/plugins/query-monitor/) and [Debug Bar](https://wordpress.org/plugins/debug-bar/) plugins are optional dependencies to aid in debugging and troubleshooting. The notice for installation will recur 45 days after being dismissed.
40
41	If you have a non-standard location for your `wp-config.php` file you can use the filter `wp_debugging_config_path` to return the file path for your installation.
42
43	The filter `wp_debugging_add_constants` allows the user to add constants to `wp-config.php`.
44
45	The filter returns an array where the key is the name of the constant and the value is an array of data containing the value as a string and a boolean to indicate whether or not the value should be passed without quotes.
46
47	$my_constants = [
48	'my_test_constant' =>
49	[
50	'value' => 'abc123',
51	'raw' => false,
52	],
53	'another_test_constant' => [ 'value' => 'true' ],
54	];
55
56	The `value` option contains the constant's value as a string.
57
58	The `raw` option means that instead of placing the value inside the config as a string it will become unquoted. The default is `true`. Set as `false` for non-boolean values.
59
60	Example:
61
62	add_filter(
63	'wp_debugging_add_constants',
64	function( $added_constants ) {
65	$my_constants = [
66	'my_test_constant' => [
67	'value' => '124xyz',
68	'raw' => false,
69	],
70	'another_test_constant' => [ 'value' => 'true' ],
71	];
72	return array_merge( $added_constants, $my_constants );
73	},
74	10,
75	1
76	);
77
78	This will create the following constants.
79
80	define( 'MY_TEST_CONSTANT', '124xyz' );
81	define( 'ANOTHER_TEST_CONSTANT', true );
82
83	## Screenshots
84
85	1. Settings Screen
86
87	## Development
88
89	PRs are welcome against the [develop branch on GitHub](https://github.com/afragen/wp-debugging).
90
91	## Changelog
92
93	#### 2.10.2 / 2021-09-04
94	* only use `esc_attr_e` for translating strings
95
96	#### 2.10.1 / 2021-07-23
97	* fix PHP Notice, `Settings:line 68`
98	* update Debug Quick Look admin bar menu for mobile
99
100	#### 2.10.0 / 2021-06-30
101	* update Debug Quick Look to show menu on mobile
102
103	#### 2.9.3 / 2021-06-22
104	* update WPConfigTransformer to use alternate anchor if default not present
105	* add @10up GitHub Actions for WordPress svn integration
106
107	#### 2.9.1 / 2020-11-17
108	* update `wp-dependency-installer` library
109	* update `wp-cli/wp-config-transformer`
110	* comment out quote normalization in `set_pre_activation_constants()`, not sure why I did that but it can cause problems [#10](https://github.com/afragen/wp-debugging/issues/10)
111
112	#### 2.9.0 / 2020-08-15
113	* use try/catch around use of `WPConfigTransformer` object
114
115	#### 2.8.0 / 2020-08-01
116	* exit if called directly
117	* NB: I have seen the `WPConfigTransformer` Exception error live. The issue seems to be that a `file_get_contents()` on the `wp-config.php` file path, at random times, returns an empty value. I'm done chasing this random error in `wp-cli/wp-config-transformer`. Modified version of `wp-cli/wp-config-transformer` present
118
119	#### 2.7.2 / 2020-06-01
120	* test `wp-config.php` everywhere, still occasional WSOD reports.
121
122	#### 2.7.1 / 2020-5-15
123	* return early if `wp-config.php` is empty before calling `WPConfigTransformer`
124
125	#### 2.7.0 / 2020-04-30
126	* start loading in `init` hook
127	* run `process_filter_constants()` as chained method in `Bootstrap`
128
129	#### 2.6.1 / 2020-03-28
130	* move `Settings` action link to front
131	* change test for `wp-config.php` file empty
132
133	#### 2.6.0 / 2020-02-28
134	* load autoloader in main file
135	* update composer dependencies
136
137	#### 2.5.8 / 2019-12-23
138	* badly messed up check for empty `wp-config.php`
139
140	#### 2.5.7 / 2019-12-20
141	* check and exit early if `wp-config.php` is empty
142	* return empty array for the above exit
143
144	#### 2.5.6 / 2019-11-02
145	* early exit if `wp-config.php` not set in specific functions
146
147	#### 2.5.5 / 2019-09-17
148	* update composer.json for wp-dependency-installer update, now requires at least PHP 5.6 for spread operator
149	* composer update
150
151	#### 2.5.4 / 2019-04-25
152	* added check for writable `wp-config.php`, exit with notice if not found
153
154	#### 2.5.3 / 2019-04-01
155	* update `Debug Quick Look` to display error log file path
156
157	#### 2.5.1 / 2019-04-01
158	* updated version of wp-cli/wp-config-transformer
159
160	#### 2.5.0 / 2019-03-25
161	* added `wp_debugging_add_constants` filter for users to add their own constants
162
163	#### 2.4.3 / 2019-03-09
164	* missed an output escape
165
166	#### 2.4.2 / 2019-02-26
167	* add `Domain Path` header
168
169	#### 2.4.1 / 2019-02-10
170	* refactor set/restore pre-activation constants
171
172	#### 2.4.0 / 2019-02-06
173	* save pre-activation constants for re-installation on deactivation ( say that 5x fast )
174
175	#### 2.3.0 / 2019-02-04
176	* look for `wp-config.php` in directory above `ABSPATH`
177	* add filter `wp_debugging_config_path` to set non-standard path to `wp-config.php`
178
179	#### 2.2.0 / 2019-02-02 🏈
180	* initial release on dot org
181
182	#### 2.1.1 / 2019-02-01
183	* only show WSOD bypass when appropriate
184	* update dependencies
185
186	#### 2.1.0 / 2019-01-26
187	* update Debug Quick Look, minor CSS changes
188	* Improve messaging
189	* add setting for WP_DISABLE_FATAL_ERROR_HANDLER constant (WSOD)
190	* add default setting of WP_DEBUG to true, can be changed
191
192	#### 2.0.0 / 2019-01-18
193	* total re-write
194	* add settings page
195	* use `wp-cli/wp-config-transformer` to change `wp-config.php`
196	* include `norcross/debug-quick-look` as dependency via composer but use my fork
197	* update POT via `composer.json` and wp-cli
198	* add image assets
199