summaryrefslogblamecommitdiff
path: root/inc/core/theme-hooks.php
blob: 35b012b274465f324ffe8ae5ed071535fcc8c562 (plain) (tree)
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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499


















































































































































































































































































































































































































































































































                                                                                                    
<?php
/**
 * Theme Hook Alliance hook stub list.
 *
 * @see  https://github.com/zamoose/themehookalliance
 *
 * @package     Astra
 * @author      Astra
 * @copyright   Copyright (c) 2020, Astra
 * @link        https://wpastra.com/
 * @since       Astra 1.0.0
 */

if ( ! defined( 'ABSPATH' ) ) {
	exit; // Exit if accessed directly.
}

/**
 * Themes and Plugins can check for astra_hooks using current_theme_supports( 'astra_hooks', $hook )
 * to determine whether a theme declares itself to support this specific hook type.
 *
 * Example:
 * <code>
 *      // Declare support for all hook types
 *      add_theme_support( 'astra_hooks', array( 'all' ) );
 *
 *      // Declare support for certain hook types only
 *      add_theme_support( 'astra_hooks', array( 'header', 'content', 'footer' ) );
 * </code>
 */
add_theme_support(
	'astra_hooks',
	array(

		/**
		 * As a Theme developer, use the 'all' parameter, to declare support for all
		 * hook types.
		 * Please make sure you then actually reference all the hooks in this file,
		 * Plugin developers depend on it!
		 */
		'all',

		/**
		 * Themes can also choose to only support certain hook types.
		 * Please make sure you then actually reference all the hooks in this type
		 * family.
		 *
		 * When the 'all' parameter was set, specific hook types do not need to be
		 * added explicitly.
		 */
		'html',
		'body',
		'head',
		'header',
		'content',
		'entry',
		'comments',
		'sidebars',
		'sidebar',
		'footer',

	/**
	 * If/when WordPress Core implements similar methodology, Themes and Plugins
	 * will be able to check whether the version of THA supplied by the theme
	 * supports Core hooks.
	 */
	)
);

/**
 * Determines, whether the specific hook type is actually supported.
 *
 * Plugin developers should always check for the support of a <strong>specific</strong>
 * hook type before hooking a callback function to a hook of this type.
 *
 * Example:
 * <code>
 *      if ( current_theme_supports( 'astra_hooks', 'header' ) )
 *          add_action( 'astra_head_top', 'prefix_header_top' );
 * </code>
 *
 * @param bool  $bool true.
 * @param array $args The hook type being checked.
 * @param array $registered All registered hook types.
 *
 * @return bool
 */
function astra_current_theme_supports( $bool, $args, $registered ) {
	return in_array( $args[0], $registered[0] ) || in_array( 'all', $registered[0] );
}
add_filter( 'current_theme_supports-astra_hooks', 'astra_current_theme_supports', 10, 3 );

/**
 * HTML <html> hook
 * Special case, useful for <DOCTYPE>, etc.
 * $astra_supports[] = 'html;
 */
function astra_html_before() {
	do_action( 'astra_html_before' );
}
/**
 * HTML <body> hooks
 * $astra_supports[] = 'body';
 */
function astra_body_top() {
	do_action( 'astra_body_top' );
}

/**
 * Body Bottom
 */
function astra_body_bottom() {
	do_action( 'astra_body_bottom' );
}

/**
 * HTML <head> hooks
 *
 * $astra_supports[] = 'head';
 */
function astra_head_top() {
	do_action( 'astra_head_top' );
}

/**
 * Head Bottom
 */
function astra_head_bottom() {
	do_action( 'astra_head_bottom' );
}

/**
 * Semantic <header> hooks
 *
 * $astra_supports[] = 'header';
 */
function astra_header_before() {
	do_action( 'astra_header_before' );
}

/**
 * Site Header
 */
function astra_header() {
	do_action( 'astra_header' );
}

/**
 * Masthead Top
 */
function astra_masthead_top() {
	do_action( 'astra_masthead_top' );
}

/**
 * Masthead
 */
function astra_masthead() {
	do_action( 'astra_masthead' );
}

/**
 * Masthead Bottom
 */
function astra_masthead_bottom() {
	do_action( 'astra_masthead_bottom' );
}

/**
 * Header After
 */
function astra_header_after() {
	do_action( 'astra_header_after' );
}

/**
 * Main Header bar top
 */
function astra_main_header_bar_top() {
	do_action( 'astra_main_header_bar_top' );
}

/**
 * Main Header bar bottom
 */
function astra_main_header_bar_bottom() {
	do_action( 'astra_main_header_bar_bottom' );
}

/**
 * Main Header Content
 */
function astra_masthead_content() {
	do_action( 'astra_masthead_content' );
}
/**
 * Main toggle button before
 */
function astra_masthead_toggle_buttons_before() {
	do_action( 'astra_masthead_toggle_buttons_before' );
}

/**
 * Main toggle buttons
 */
function astra_masthead_toggle_buttons() {
	do_action( 'astra_masthead_toggle_buttons' );
}

/**
 * Main toggle button after
 */
function astra_masthead_toggle_buttons_after() {
	do_action( 'astra_masthead_toggle_buttons_after' );
}

/**
 * Semantic <content> hooks
 *
 * $astra_supports[] = 'content';
 */
function astra_content_before() {
	do_action( 'astra_content_before' );
}

/**
 * Content after
 */
function astra_content_after() {
	do_action( 'astra_content_after' );
}

/**
 * Content top
 */
function astra_content_top() {
	do_action( 'astra_content_top' );
}

/**
 * Content bottom
 */
function astra_content_bottom() {
	do_action( 'astra_content_bottom' );
}

/**
 * Content while before
 */
function astra_content_while_before() {
	do_action( 'astra_content_while_before' );
}

/**
 * Content loop
 */
function astra_content_loop() {
	do_action( 'astra_content_loop' );
}

/**
 * Conten Page Loop.
 *
 * Called from page.php
 */
function astra_content_page_loop() {
	do_action( 'astra_content_page_loop' );
}

/**
 * Content while after
 */
function astra_content_while_after() {
	do_action( 'astra_content_while_after' );
}

/**
 * Semantic <entry> hooks
 *
 * $astra_supports[] = 'entry';
 */
function astra_entry_before() {
	do_action( 'astra_entry_before' );
}

/**
 * Entry after
 */
function astra_entry_after() {
	do_action( 'astra_entry_after' );
}

/**
 * Entry content before
 */
function astra_entry_content_before() {
	do_action( 'astra_entry_content_before' );
}

/**
 * Entry content after
 */
function astra_entry_content_after() {
	do_action( 'astra_entry_content_after' );
}

/**
 * Entry Top
 */
function astra_entry_top() {
	do_action( 'astra_entry_top' );
}

/**
 * Entry bottom
 */
function astra_entry_bottom() {
	do_action( 'astra_entry_bottom' );
}

/**
 * Single Post Header Before
 */
function astra_single_header_before() {
	do_action( 'astra_single_header_before' );
}

/**
 * Single Post Header After
 */
function astra_single_header_after() {
	do_action( 'astra_single_header_after' );
}

/**
 * Single Post Header Top
 */
function astra_single_header_top() {
	do_action( 'astra_single_header_top' );
}

/**
 * Single Post Header Bottom
 */
function astra_single_header_bottom() {
	do_action( 'astra_single_header_bottom' );
}

/**
 * Comments block hooks
 *
 * $astra_supports[] = 'comments';
 */
function astra_comments_before() {
	do_action( 'astra_comments_before' );
}

/**
 * Comments after.
 */
function astra_comments_after() {
	do_action( 'astra_comments_after' );
}

/**
 * Semantic <sidebar> hooks
 *
 * $astra_supports[] = 'sidebar';
 */
function astra_sidebars_before() {
	do_action( 'astra_sidebars_before' );
}

/**
 * Sidebars after
 */
function astra_sidebars_after() {
	do_action( 'astra_sidebars_after' );
}

/**
 * Semantic <footer> hooks
 *
 * $astra_supports[] = 'footer';
 */
function astra_footer() {
	do_action( 'astra_footer' );
}

/**
 * Footer before
 */
function astra_footer_before() {
	do_action( 'astra_footer_before' );
}

/**
 * Footer after
 */
function astra_footer_after() {
	do_action( 'astra_footer_after' );
}

/**
 * Footer top
 */
function astra_footer_content_top() {
	do_action( 'astra_footer_content_top' );
}

/**
 * Footer
 */
function astra_footer_content() {
	do_action( 'astra_footer_content' );
}

/**
 * Footer bottom
 */
function astra_footer_content_bottom() {
	do_action( 'astra_footer_content_bottom' );
}

/**
 * Archive header
 */
function astra_archive_header() {
	do_action( 'astra_archive_header' );
}

/**
 * Pagination
 */
function astra_pagination() {
	do_action( 'astra_pagination' );
}

/**
 * Entry content single
 */
function astra_entry_content_single() {
	do_action( 'astra_entry_content_single' );
}

/**
 * 404
 */
function astra_entry_content_404_page() {
	do_action( 'astra_entry_content_404_page' );
}

/**
 * Entry content blog
 */
function astra_entry_content_blog() {
	do_action( 'astra_entry_content_blog' );
}

/**
 * Blog featured post section
 */
function astra_blog_post_featured_format() {
	do_action( 'astra_blog_post_featured_format' );
}

/**
 * Primary Content Top
 */
function astra_primary_content_top() {
	do_action( 'astra_primary_content_top' );
}

/**
 * Primary Content Bottom
 */
function astra_primary_content_bottom() {
	do_action( 'astra_primary_content_bottom' );
}

/**
 * 404 Page content template action.
 */
function astra_404_content_template() {
	do_action( 'astra_404_content_template' );
}

if ( ! function_exists( 'wp_body_open' ) ) {

	/**
	 * Fire the wp_body_open action.
	 * Adds backward compatibility for WordPress versions < 5.2
	 *
	 * @since 1.8.7
	 */
	function wp_body_open() {
		do_action( 'wp_body_open' );
	}
}