-
Notifications
You must be signed in to change notification settings - Fork 379
Expand file tree
/
Copy pathOption.php
More file actions
301 lines (265 loc) · 6.47 KB
/
Copy pathOption.php
File metadata and controls
301 lines (265 loc) · 6.47 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
<?php
/**
* Interface Option.
*
* @package AmpProject\AmpWP
*/
namespace AmpProject\AmpWP;
/**
* An interface to share knowledge about options stored in the AMP Options Manager.
*
* @package AmpProject\AmpWP
* @since 2.0
* @internal
*/
interface Option {
/**
* Serve all templates as AMP regardless of what is being queried.
*
* Default value: true
*
* @var string
*/
const ALL_TEMPLATES_SUPPORTED = 'all_templates_supported';
/**
* List of JSON objects that should be injected into the <amp-analytics> component.
*
* @see https://developers.google.com/analytics/devguides/collection/amp-analytics/
*
* Default value: []
*
* @var string
*/
const ANALYTICS = 'analytics';
/**
* Persist the fact that the transient caching of stylesheets needs to be disabled.
*
* @var string
*/
const DISABLE_CSS_TRANSIENT_CACHING = 'amp_css_transient_monitor_disable_caching';
/**
* Indicate the structure for paired AMP URLs.
*
* Default value: 'query_var'
*
* @var string
*/
const PAIRED_URL_STRUCTURE = 'paired_url_structure';
/**
* Query var paired URL structure.
*
* This is the default, where all AMP URLs end in `?amp=1`.
*
* @var string
*/
const PAIRED_URL_STRUCTURE_QUERY_VAR = 'query_var';
/**
* Path suffix paired URL structure.
*
* This adds `/amp/` to all URLs, even pages and archives. This is a popular option for those who feel query params
* are bad for SEO.
*
* @var string
*/
const PAIRED_URL_STRUCTURE_PATH_SUFFIX = 'path_suffix';
/**
* Legacy transitional paired URL structure.
*
* This involves using `?amp` for all paired AMP URLs.
*
* @var string
*/
const PAIRED_URL_STRUCTURE_LEGACY_TRANSITIONAL = 'legacy_transitional';
/**
* Legacy transitional paired URL structure.
*
* This involves using `/amp/` for all non-hierarchical post URLs which lack endpoints or query vars, or else using
* the same `?amp` as used by legacy transitional.
*
* @var string
*/
const PAIRED_URL_STRUCTURE_LEGACY_READER = 'legacy_reader';
/**
* Redirect mobile visitors to the AMP version of a page when the site is in Transitional or Reader mode.
*
* Default value: false
*
* @var string
*/
const MOBILE_REDIRECT = 'mobile_redirect';
/**
* The list of post types that have support for AMP.
*
* The provided value should be an array of WordPress post-type slugs.
*
* Default value: [ 'post' ]
*
* @var string
*/
const SUPPORTED_POST_TYPES = 'supported_post_types';
/**
* List of WordPress template conditionals to define what templates are supported by AMP.
*
* Default value: [ 'is_singular' ]
*
* @var string
*/
const SUPPORTED_TEMPLATES = 'supported_templates';
/**
* The template mode that is being used for AMP support.
*
* Currently valid values are:
* - AMP_Theme_Support::STANDARD_MODE_SLUG
* - AMP_Theme_Support::TRANSITIONAL_MODE_SLUG
* - AMP_Theme_Support::READER_MODE_SLUG
*
* Default value: AMP_Theme_Support::READER_MODE_SLUG
*
* @var string
*/
const THEME_SUPPORT = 'theme_support';
/**
* The slug of the theme selected to be used on AMP pages in reader mode.
*
* Default value: legacy
*
* @var string
*/
const READER_THEME = 'reader_theme';
/**
* Theme support features from the primary theme.
*
* When using a Reader theme, the theme support features from the primary theme are stored in this option so that
* they will be available when the Reader theme is active.
*
* @var string
*/
const PRIMARY_THEME_SUPPORT = 'primary_theme_support';
/**
* The key of the option storing whether the setup wizard has been completed.
*
* @var string
*/
const PLUGIN_CONFIGURED = 'plugin_configured';
/**
* The key of the option storing whether to delete AMP data upon uninstalling the plugin.
*
* @var string
*/
const DELETE_DATA_AT_UNINSTALL = 'delete_data_at_uninstall';
/**
* The key of the option storing whether to use native img tag instead of amp-img tag.
*
* @var string
*/
const USE_NATIVE_IMG_TAG = 'use_native_img_tag';
/**
* Cached slug when it is defined late.
*
* @var string
*/
const LATE_DEFINED_SLUG = 'late_defined_slug';
/**
* Suppressed plugins
*
* @var string
*/
const SUPPRESSED_PLUGINS = 'suppressed_plugins';
/**
* Suppressed plugins, last version.
*
* @var string
*/
const SUPPRESSED_PLUGINS_LAST_VERSION = 'last_version';
/**
* Suppressed plugins, timestamp.
*
* @var string
*/
const SUPPRESSED_PLUGINS_TIMESTAMP = 'timestamp';
/**
* Suppressed plugins, username.
*
* @var string
*/
const SUPPRESSED_PLUGINS_USERNAME = 'username';
/**
* Option key for enabling sandboxing.
*
* @var string
*/
const SANDBOXING_ENABLED = 'sandboxing_enabled';
/**
* Option key for sandboxing level.
*
* @var string
*/
const SANDBOXING_LEVEL = 'sandboxing_level';
/**
* Version of the AMP plugin for which the options were last saved.
*
* This allows for recognizing updates and triggering update-specific logic.
*
* @var string
*/
const VERSION = 'version';
// ---------------------- Deprecated options down below ---------------------- //
/**
* Whether to accept or reject sanitization results by default.
*
* @deprecated Removed with version 1.4.0
*
* @var string
*/
const AUTO_ACCEPT_SANITIZATION = 'auto_accept_sanitization';
/**
* Whether the AMP stories experience is enabled.
*
* @deprecated Removed with version 1.5.0
*
* @var string
*/
const ENABLE_AMP_STORIES = 'enable_amp_stories';
/**
* Whether responses should be statically cached.
*
* @deprecated Removed with version 1.5.0
*
* @var string
*/
const ENABLE_RESPONSE_CACHING = 'enable_response_caching';
/**
* List of AMP experiences that are currently active.
*
* @deprecated Removed with version 1.5.0
*
* @var string
*/
const EXPERIENCES = 'experiences';
/**
* Base URL to use when exporting a story to the file system.
*
* @deprecated Removed with version 1.5.0
*
* @var string
*/
const STORY_EXPORT_BASE_URL = 'story_export_base_url';
/**
* Settings for the AMP stories experience.
*
* @deprecated Removed with version 1.5.0
*
* @var string
*/
const STORY_SETTINGS = 'story_settings';
/**
* Version string at which the story templates were generated and persisted.
*
* This allows for recognizing story template updates and triggering update-specific logic.
*
* @deprecated Removed with version 1.5.0
*
* @var string
*/
const STORY_TEMPLATES_VERSION = 'story_templates_version';
}