wp-debugging / readme.txt

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

245 lines 8.1 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: 6.0
8	Stable tag: 2.11.13
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://wordpress.org/support/article/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.11.13 / 2022-06-23
94	* make anchor `preg_match` more greedy
95
96	#### 2.11.12 / 2022-05-29
97	* update to latest `afragen/debug-quick-look`
98
99	#### 2.11.11 / 2022--5-16
100	* update `wp-dismiss-notice` with transient and only poll `wp_remote_get()` weekly
101
102	#### 2.11.10 / 2022-05-10
103	* use `sanitize_key()` for nonces
104	* composer update
105
106	#### 2.11.9 / 2022-02-05
107	* composer update
108
109	#### 2.11.8 / 2022-01-24
110	* load call to `WP_Dependency_Installer()` in `plugins_loaded` hook to avoid loading `pluggable.php`.
111	* update `WP_Dependency_Installer`
112
113	#### 2.11.7 / 2022-01-18
114	* fix logic in verify nonce conditional
115
116	#### 2.11.6 /2022-01-18
117	* proper nonce verification
118	* composer updates
119
120	#### 2.11.5 / 2022-01-11
121	* I messed up the release 🤦‍♂️
122
123	#### 2.11.4 / 2022-01-10
124	* composer updates
125
126	#### 2.11.3 / 2021-12-19
127	* more fixes via composer update
128
129	#### 2.11.2 / 2021-09-24
130	* composer update, cause of course I needed to fix something
131
132	#### 2.11.1 / 2021-09-24
133	* init in `plugins_loaded` hook
134	* composer update
135
136	#### 2.11.0 / 2021-09-23
137	* fix security issue for capabilities check, possible CSRF, and nonce checks.
138
139	#### 2.10.2 / 2021-09-04
140	* only use `esc_attr_e` for translating strings
141
142	#### 2.10.1 / 2021-07-23
143	* fix PHP Notice, `Settings:line 68`
144	* update Debug Quick Look admin bar menu for mobile
145
146	#### 2.10.0 / 2021-06-30
147	* update Debug Quick Look to show menu on mobile
148
149	#### 2.9.3 / 2021-06-22
150	* update WPConfigTransformer to use alternate anchor if default not present
151	* add @10up GitHub Actions for WordPress svn integration
152
153	#### 2.9.1 / 2020-11-17
154	* update `wp-dependency-installer` library
155	* update `wp-cli/wp-config-transformer`
156	* 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)
157
158	#### 2.9.0 / 2020-08-15
159	* use try/catch around use of `WPConfigTransformer` object
160
161	#### 2.8.0 / 2020-08-01
162	* exit if called directly
163	* 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
164
165	#### 2.7.2 / 2020-06-01
166	* test `wp-config.php` everywhere, still occasional WSOD reports.
167
168	#### 2.7.1 / 2020-5-15
169	* return early if `wp-config.php` is empty before calling `WPConfigTransformer`
170
171	#### 2.7.0 / 2020-04-30
172	* start loading in `init` hook
173	* run `process_filter_constants()` as chained method in `Bootstrap`
174
175	#### 2.6.1 / 2020-03-28
176	* move `Settings` action link to front
177	* change test for `wp-config.php` file empty
178
179	#### 2.6.0 / 2020-02-28
180	* load autoloader in main file
181	* update composer dependencies
182
183	#### 2.5.8 / 2019-12-23
184	* badly messed up check for empty `wp-config.php`
185
186	#### 2.5.7 / 2019-12-20
187	* check and exit early if `wp-config.php` is empty
188	* return empty array for the above exit
189
190	#### 2.5.6 / 2019-11-02
191	* early exit if `wp-config.php` not set in specific functions
192
193	#### 2.5.5 / 2019-09-17
194	* update composer.json for wp-dependency-installer update, now requires at least PHP 5.6 for spread operator
195	* composer update
196
197	#### 2.5.4 / 2019-04-25
198	* added check for writable `wp-config.php`, exit with notice if not found
199
200	#### 2.5.3 / 2019-04-01
201	* update `Debug Quick Look` to display error log file path
202
203	#### 2.5.1 / 2019-04-01
204	* updated version of wp-cli/wp-config-transformer
205
206	#### 2.5.0 / 2019-03-25
207	* added `wp_debugging_add_constants` filter for users to add their own constants
208
209	#### 2.4.3 / 2019-03-09
210	* missed an output escape
211
212	#### 2.4.2 / 2019-02-26
213	* add `Domain Path` header
214
215	#### 2.4.1 / 2019-02-10
216	* refactor set/restore pre-activation constants
217
218	#### 2.4.0 / 2019-02-06
219	* save pre-activation constants for re-installation on deactivation ( say that 5x fast )
220
221	#### 2.3.0 / 2019-02-04
222	* look for `wp-config.php` in directory above `ABSPATH`
223	* add filter `wp_debugging_config_path` to set non-standard path to `wp-config.php`
224
225	#### 2.2.0 / 2019-02-02 🏈
226	* initial release on dot org
227
228	#### 2.1.1 / 2019-02-01
229	* only show WSOD bypass when appropriate
230	* update dependencies
231
232	#### 2.1.0 / 2019-01-26
233	* update Debug Quick Look, minor CSS changes
234	* Improve messaging
235	* add setting for WP_DISABLE_FATAL_ERROR_HANDLER constant (WSOD)
236	* add default setting of WP_DEBUG to true, can be changed
237
238	#### 2.0.0 / 2019-01-18
239	* total re-write
240	* add settings page
241	* use `wp-cli/wp-config-transformer` to change `wp-config.php`
242	* include `norcross/debug-quick-look` as dependency via composer but use my fork
243	* update POT via `composer.json` and wp-cli
244	* add image assets
245