-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgenesis-stubs.php
4905 lines (4904 loc) · 151 KB
/
genesis-stubs.php
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
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Generated stub declarations for Genesis
* @see https://www.studiopress.com/get-genesis/ to download the Genesis framework (require an email)
* @see https://github.com/php-stubs/genesis-stubs
*/
/**
* Genesis Framework.
*
* WARNING: This file is part of the core Genesis Framework. DO NOT edit this file under any circumstances.
* Please do all modifications in the form of a child theme.
*
* @package Genesis\Schema
* @author StudioPress
* @license GPL-2.0-or-later
* @link https://my.studiopress.com/themes/genesis/
*/
namespace StudioPress\Genesis\Functions\Rest {
/**
* Add `layouts` endpoint to the REST API.
*
* Example: `curl https://example.com/wp-json/genesis/v1/layouts/site`
* Example: `curl https://example.com/wp-json/genesis/v1/layouts/singular,page,24`
*
* @since 3.3.0 Accept multiple comma-separated layout types.
* Types are checked from right to left, returning the first type
* with registered layouts and falling back to 'site' if no passed
* types have registered layouts.
* @since 3.1.0
*/
function layouts()
{
}
/**
* Add `singular-images` endpoint to the REST API.
*
* Returns an array of post types that have genesis-singular-images support
* with singular images enabled in the Singular Content panel in the Customizer.
*
* Example: `curl https://example.com/wp-json/genesis/v1/singular-images`
*
* Example response:
*
* [
* 'post', // Featured Images are enabled on posts.
* 'page' // Featured Images are enabled on pages.
* ]
*
* @since 3.1.0
*/
function get_singular_images()
{
}
/**
* Update singular image state to turn featured image output on or off for
* the provided post types.
*
* Expects to receive a JSON object with post type as key, then 1 for the value
* to enable images, and 0 to disable.
*
* {
* "pages": 0, // Disable featured images on pages.
* "posts": 1 // Enable featured images on posts.
* }
*
* Returns an array of all post types that now have featured images enabled
* after the update is applied. For the above example, assuming no other post
* types have `genesis-singular-images` support:
*
* [ "posts" ]
*
* @since 3.1.0
*/
function set_singular_images()
{
}
/**
* Add `breadcrumbs` endpoint to the REST API.
*
* Returns an array of options that have breadcrumbs enabled.
*
* Example: `curl https://example.com/wp-json/genesis/v1/breadcrumbs`
*
* Example response: [ "breadcrumb_single", "breadcrumb_page" ]
*
* @since 3.1.0
*/
function get_breadcrumbs()
{
}
/**
* Update breadcrumbs state to turn breadcrumb output on or off for
* the provided option type.
*
* Expects to receive a JSON object with breadcrumb type as key,
* then 1 for the value to enable breadcrumbs, and 0 to disable.
*
* {
* "breadcrumb_front_page": 0, // Disable breadcrumbs on the front page.
* "breadcrumb_single": 1 // Enable breadcrumbs on posts.
* "breadcrumb_page": 1 // Enable breadcrumbs on pages.
* }
*
* Returns an array of all options that now have breadcrumbs enabled after
* the update is applied. For the above example, assuming no other breadcrumbs
* are enabled:
*
* [ "breadcrumb_single", "breadcrumb_page" ]
*
* @since 3.1.0
*/
function set_breadcrumbs()
{
}
/**
* Presents show_on_front, page_on_front, and page_for_posts settings.
*
* These settings are not currently offered by the WordPress REST API. We could
* switch to `wp` endpoints once the settings are exposed there.
*
* Example: `curl https://example.com/wp-json/genesis/v1/reading-settings`
*
* Example response:
*
* {"show_on_front":"page","page_on_front":123,"page_for_posts":456}
*
* @since 3.1.0
*/
function get_reading_settings()
{
}
}
/**
* Genesis Framework.
*
* WARNING: This file is part of the core Genesis Framework. DO NOT edit this file under any circumstances.
* Please do all modifications in the form of a child theme.
*
* @package Genesis\Schema
* @author StudioPress
* @license GPL-2.0-or-later
* @link https://my.studiopress.com/themes/genesis/
*/
namespace StudioPress\Genesis\Functions\Schema {
/**
* Add schema markup attributes for head element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for `head` element.
* @return array Amended attributes for `head` element.
*/
function head($attributes)
{
}
/**
* Add schema markup attributes for body element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for `body` element.
* @return array Amended attributes for `body` element.
*/
function body($attributes)
{
}
/**
* Add schema markup attributes for site header element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for site header element.
* @return array Amended attributes for site header element.
*/
function site_header($attributes)
{
}
/**
* Add schema markup attributes for site title element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for site title element.
* @return array Amended attributes for site title element.
*/
function site_title($attributes)
{
}
/**
* Add schema markup attributes for site description element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for site description element.
* @return array Amended attributes for site description element.
*/
function site_description($attributes)
{
}
/**
* Add schema markup attributes for breadcrumbs wrapper.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for breadcrumbs wrapper element.
* @return array Amended attributes for breadcrumbs wrapper element.
*/
function breadcrumb($attributes)
{
}
/**
* Add schema markup attributes for breadcrumb item element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for breadcrumb item element.
* @return array Amended attributes for breadcrumb item element.
*/
function breadcrumb_link_wrap($attributes)
{
}
/**
* Add schema markup attributes for breadcrumb link wrap meta element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for breadcrumb link wrap meta element.
* @return array Amended attributes for breadcrumb link wrap meta element.
*/
function breadcrumb_link_wrap_meta($attributes)
{
}
/**
* Add schema markup attributes for breadcrumb link element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for breadcrumb link element.
* @param string $context Not used. Markup context (ie. `footer-widget-area`).
* @param array $args Markup arguments.
* @return array Amended attributes for breadcrumb link element.
*/
function breadcrumb_link($attributes, $context, $args)
{
}
/**
* Add schema markup attributes for breadcrumb link text wrap.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for breadcrumb link text wrap.
* @return array Amended attributes for breadcrumb link text wrap.
*/
function breadcrumb_link_text_wrap($attributes)
{
}
/**
* Add schema markup attributes for search form.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for search form element.
* @return array Amended attributes for search form element.
*/
function search_form($attributes)
{
}
/**
* Add schema markup attributes for search form meta tag.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for search form meta element.
* @return array Amended attributes for search form meta element.
*/
function search_form_meta($attributes)
{
}
/**
* Add schema markup attributes for search form input element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for footer widget area wrapper elements.
* @param string $context Not used. Markup context (ie. `footer-widget-area`).
* @param array $args Markup arguments.
* @return array Amended attributes.
*/
function search_form_input($attributes, $context, $args)
{
}
/**
* Add schema markup attributes for primary navigation element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for primary navigation element.
* @return array Amended attributes for navigation elements.
*/
function nav_primary($attributes)
{
}
/**
* Add schema markup attributes for secondary navigation element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for secondary navigation element.
* @return array Amended attributes for navigation elements.
*/
function nav_secondary($attributes)
{
}
/**
* Add schema markup attributes for header navigation element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for header navigation element.
* @return array Amended attributes for navigation elements.
*/
function nav_header($attributes)
{
}
/**
* Add schema markup attributes for the span wrap around navigation item links.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for span wrap around navigation item links.
* @return array Amended attributes for span wrap around navigation item links.
*/
function nav_link_wrap($attributes)
{
}
/**
* Add schema markup attributes for the navigation item links.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for navigation item links.
* @return array Amended attributes for navigation item links.
*/
function nav_link($attributes)
{
}
/**
* Add schema markup attributes for entry element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for entry element.
* @return array Amended attributes for entry element.
*/
function entry($attributes)
{
}
/**
* Add schema markup attributes for entry image element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for entry image element.
* @return array Amended attributes for entry image element.
*/
function entry_image($attributes)
{
}
/**
* Add attributes for singular entry image element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for entry image element.
* @return array Amended attributes for entry image element.
*/
function singular_entry_image($attributes)
{
}
/**
* Add schema markup attributes for entry image element shown in a widget.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for entry image element shown in a widget.
* @return array Amended attributes for entry image element shown in a widget.
*/
function entry_image_widget($attributes)
{
}
/**
* Add schema markup attributes for entry image element shown in a grid loop.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for entry image element shown in a grid loop.
* @return array Amended attributes for entry image element shown in a grid loop.
*/
function entry_image_grid_loop($attributes)
{
}
/**
* Add schema markup attributes for author element for an entry.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for author element for an entry.
* @return array Amended attributes for author element for an entry.
*/
function entry_author($attributes)
{
}
/**
* Add schema markup attributes for entry author link element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for entry author link element.
* @return array Amended attributes for entry author link element.
*/
function entry_author_link($attributes)
{
}
/**
* Add schema markup attributes for entry author name element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for entry author name element.
* @return array Amended attributes for entry author name element.
*/
function entry_author_name($attributes)
{
}
/**
* Add schema markup attributes for time element for an entry.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for time element for an entry.
* @return array Amended attributes for time element for an entry.
*/
function entry_time($attributes)
{
}
/**
* Add schema markup attributes for modified time element for an entry.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for modified time element for an entry.
* @return array Amended attributes for modified time element for an entry.
*/
function entry_modified_time($attributes)
{
}
/**
* Add schema markup attributes for entry title element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for entry title element.
* @return array Amended attributes for entry title element.
*/
function entry_title($attributes)
{
}
/**
* Add schema markup attributes for entry content element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for entry content element.
* @return array Amended attributes for entry content element.
*/
function entry_content($attributes)
{
}
/**
* Add schema markup attributes for single comment element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for single comment element.
* @return array Amended attributes for single comment element.
*/
function comment($attributes)
{
}
/**
* Add schema markup attributes for comment author element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for comment author element.
* @return array Amended attributes for comment author element.
*/
function comment_author($attributes)
{
}
/**
* Add schema markup attributes for comment author link element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for comment author link element.
* @return array Amended attributes for comment author link element.
*/
function comment_author_link($attributes)
{
}
/**
* Add schema markup attributes for comment author name element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for comment author name element.
* @return array Amended attributes for comment author name element.
*/
function comment_author_name($attributes)
{
}
/**
* Add schema markup attributes for comment time element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for comment time element.
* @return array Amended attributes for comment time element.
*/
function comment_time($attributes)
{
}
/**
* Add schema markup attributes for comment time link element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for comment time link element.
* @param array $context Not used. Markup context (ie. `footer-widget-area`).
* @param array $args Arguments.
* @return array Amended attributes for comment time link.
*/
function comment_time_link($attributes, $context, $args)
{
}
/**
* Add schema markup attributes for comment content container.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for comment content container.
* @return array Amended attributes for comment content container.
*/
function comment_content($attributes)
{
}
/**
* Add schema markup attributes for author box element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for author box element.
* @return array Amended attributes for author box element.
*/
function author_box($attributes)
{
}
/**
* Add schema markup attributes for primary sidebar element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for primary sidebar element.
* @return array Amended attributes for primary sidebar element.
*/
function sidebar_primary($attributes)
{
}
/**
* Add schema markup attributes for secondary sidebar element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for secondary sidebar element.
* @return array Amended attributes for secondary sidebar element.
*/
function sidebar_secondary($attributes)
{
}
/**
* Add schema markup attributes for site footer element.
*
* @since 3.1.0
*
* @param array $attributes Existing attributes for site footer element.
* @return array Amended attributes for site footer element.
*/
function site_footer($attributes)
{
}
}
namespace {
/**
* Genesis Framework.
*
* WARNING: This file is part of the core Genesis Framework. DO NOT edit this file under any circumstances.
* Please do all modifications in the form of a child theme.
*
* @package Genesis\Framework
* @author StudioPress
* @license GPL-2.0-or-later
* @link https://my.studiopress.com/themes/genesis/
*/
/**
* Used to initialize the framework in the various template files.
*
* It pulls in all the necessary components like header and footer, the basic
* markup structure, and hooks.
*
* @since 1.3.0
*/
function genesis()
{
}
/**
* Genesis Framework.
*
* WARNING: This file is part of the core Genesis Framework. DO NOT edit this file under any circumstances.
* Please do all modifications in the form of a child theme.
*
* @package Genesis\Breadcrumbs
* @author StudioPress
* @license GPL-2.0-or-later
* @link https://my.studiopress.com/themes/genesis/
*/
/**
* Helper function for the Genesis Breadcrumb Class.
*
* @since 1.0.0
*
* @global Genesis_Breadcrumb $_genesis_breadcrumb
*
* @param array $args Breadcrumb arguments.
*/
function genesis_breadcrumb($args = [])
{
}
/**
* Are breadcrumbs hidden for the current page?
*
* Indicates that the “Hide breadcrumbs” checkbox is enabled and checked.
*
* @since 3.1.0
*
* @return bool True if breadcrumbs are hidden, false otherwise.
*/
function genesis_breadcrumbs_hidden_on_current_page()
{
}
/**
* Are breadcrumbs disabled for the current page type?
*
* @since 3.1.1
*
* @return bool True if breadcrumbs are disabled, false otherwise.
*/
function genesis_breadcrumbs_disabled_on_current_page()
{
}
/**
* Display Breadcrumbs above the Loop. Concedes priority to popular breadcrumb
* plugins.
*
* @since 1.0.0
*
* @return void Return early if Genesis settings dictate that no breadcrumbs should show in current context.
*/
function genesis_do_breadcrumbs()
{
}
/**
* Gets breadcrumb options that are enabled in Genesis settings.
*
* @since 3.1.0
*
* @return array The breadcrumb options that are enabled.
*/
function genesis_breadcrumb_options_enabled()
{
}
/**
* Filter the feed URI if the user has input a custom feed URI.
*
* Applied in the `get_feed_link()` WordPress function.
*
* @since 1.3.0
*
* @param string $output From the get_feed_link() WordPress function.
* @param string $feed Optional. Defaults to default feed. Feed type (rss2, rss, sdf, atom).
* @return string Amended feed URL.
*/
function genesis_feed_links_filter($output, $feed)
{
}
/**
* Redirect the browser to the custom feed URI.
*
* Exits PHP after redirect.
*
* @since 1.3.0
*
* @return void Return early if is feed user agent is set and matches Feedblitz,
* Feedburner or Feedvalidator. Redirects and exits on success.
*/
function genesis_feed_redirect()
{
}
/**
* Genesis Framework.
*
* WARNING: This file is part of the core Genesis Framework. DO NOT edit this file under any circumstances.
* Please do all modifications in the form of a child theme.
*
* @package Genesis\Formatting
* @author StudioPress
* @license GPL-2.0-or-later
* @link https://my.studiopress.com/themes/genesis/
*/
/**
* Return a phrase shortened in length to a maximum number of characters.
*
* Result will be truncated at the last white space in the original string. In this function the word separator is a
* single space. Other white space characters (like newlines and tabs) are ignored.
*
* If the first `$max_characters` of the string does not contain a space character, an empty string will be returned.
*
* @since 1.4.0
*
* @param string $text A string to be shortened.
* @param int $max_characters The maximum number of characters to return.
* @return string Truncated string. Empty string if `$max_characters` is falsy.
*/
function genesis_truncate_phrase($text, $max_characters)
{
}
// phpcs:disable WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound, WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound -- Some of the earliest Genesis functions. Can't be renamed.
/**
* Return content stripped down and limited content.
*
* Strips out tags and shortcodes, limits the output to `$max_char` characters, and appends an ellipsis and more link to the end.
*
* @since 1.0.0
*
* @param int $max_characters The maximum number of characters to return.
* @param string $more_link_text Optional. Text of the more link. Default is "(more...)".
* @param bool $stripteaser Optional. Strip teaser content before the more text. Default is false.
* @return string Limited content.
*/
function get_the_content_limit($max_characters, $more_link_text = '(more...)', $stripteaser = \false)
{
}
/**
* Return more link text plus hidden title for screen readers, to improve accessibility.
*
* @since 2.2.0
*
* @param string $more_link_text Text of the more link.
* @return string `$more_link_text` with or without the hidden title.
*/
function genesis_a11y_more_link($more_link_text)
{
}
/**
* Echo the limited content.
*
* @since 1.0.0
*
* @param int $max_characters The maximum number of characters to return.
* @param string $more_link_text Optional. Text of the more link. Default is "(more...)".
* @param bool $stripteaser Optional. Strip teaser content before the more text. Default is false.
*/
function the_content_limit($max_characters, $more_link_text = '(more...)', $stripteaser = \false)
{
}
// phpcs:enable WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound, WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound
/**
* Add `rel="nofollow"` attribute and value to links within string passed in.
*
* @since 1.0.0
*
* @param string $text HTML markup.
* @return string Amended HTML markup with `rel="nofollow"` attribute.
*/
function genesis_rel_nofollow($text)
{
}
/**
* Remove attributes from a HTML element.
*
* This function accepts a string of HTML, parses it for any elements in the `$elements` array, then parses each element
* for any attributes in the `$attributes` array, and strips the attribute and its value(s).
*
* ~~~
* // Strip class attribute from an anchor
* genesis_strip_attr(
* '<a class="my-class" href="http://google.com/">Google</a>',
* 'a',
* 'class'
* );
* // Strips class and id attributes from div and span elements
* genesis_strip_attr(
* '<div class="my-class" id="the-div"><span class="my-class" id="the-span"></span></div>',
* array( 'div', 'span' ),
* array( 'class', 'id' )
* );
* ~~~
*
* @since 1.0.0
*
* @link http://studiopress.com/support/showthread.php?t=20633
*
* @param string $text A string of HTML formatted code.
* @param array|string $elements Elements that $attributes should be stripped from.
* @param array|string $attributes Attributes that should be stripped from $elements.
* @param bool $two_passes Whether the function should allow two passes.
* @return string HTML markup with attributes stripped.
*/
function genesis_strip_attr($text, $elements, $attributes, $two_passes = \true)
{
}
/**
* Return the special URL of a paged post.
*
* Taken from _wp_link_page() in WordPress core, but instead of anchor markup, just return the URL.
*
* @since 2.2.0
*
* @param int $i The page number to generate the URL from.
* @param int $post_id The post ID.
* @return string Unescaped URL for the a paged post.
*/
function genesis_paged_post_url($i, $post_id = 0)
{
}
/**
* Sanitize multiple HTML classes in one pass.
*
* Accepts either an array of `$classes`, or a space separated string of classes and sanitizes them using the
* `sanitize_html_class()` WordPress function.
*
* @since 2.0.0
*
* @param array|string $classes Classes to be sanitized.
* @param string $return_format Optional. The return format, 'input', 'string', or 'array'. Default is 'input'.
* @return array|string String of multiple sanitized classes.
*/
function genesis_sanitize_html_classes($classes, $return_format = 'input')
{
}
/**
* Return an array of allowed tags for output formatting.
*
* Mainly used by `wp_kses()` for sanitizing output.
*
* @since 1.6.0
*
* @return array Allowed elements and attributes, used with KSES.
*/
function genesis_formatting_allowedtags()
{
}
/**
* Wrapper for `wp_kses()` that can be used as a filter function.
*
* @since 1.8.0
*
* @param string $string Content to filter through KSES.
* @return string Filtered content with only allowed HTML elements.
*/
function genesis_formatting_kses($string)
{
}
/**
* Calculate the time difference - a replacement for `human_time_diff()` until it is improved.
*
* Based on BuddyPress function `bp_core_time_since()`, which in turn is based on functions created by
* Dunstan Orchard - http://1976design.com
*
* This function will return an text representation of the time elapsed since a
* given date, giving the two largest units e.g.:
*
* - 2 hours and 50 minutes
* - 4 days
* - 4 weeks and 6 days
*
* @since 1.7.0
*
* @param int $older_date Unix timestamp of date you want to calculate the time since for`.
* @param int|bool $newer_date Optional. Unix timestamp of date to compare older date to. Default false (current time).
* @param int $relative_depth Optional, how many units to include in relative date. Default 2.
* @return string The time difference between two dates.
*/
function genesis_human_time_diff($older_date, $newer_date = \false, $relative_depth = 2)
{
}
/**
* Mark up content with code tags.
*
* Escapes all HTML, so `<` gets changed to `<` and displays correctly.
*
* Used almost exclusively within labels and text in user interfaces added by Genesis.
*
* @since 2.0.0
*
* @param string $content Content to be wrapped in code tags.
* @return string Content wrapped in `code` tags.
*/
function genesis_code($content)
{
}
/**
* Remove paragraph tags from content.
*
* @since 2.5.0
*
* @param string $content Content possibly containing paragraph tags.
* @return string Content without paragraph tags.
*/
function genesis_strip_p_tags($content)
{
}
/**
* Genesis Framework.
*
* WARNING: This file is part of the core Genesis Framework. DO NOT edit this file under any circumstances.
* Please do all modifications in the form of a child theme.
*
* @package StudioPress\Genesis
* @author StudioPress
* @license GPL-2.0-or-later
* @link https://my.studiopress.com/themes/genesis/
*/
/**
* Enable the author box for ALL users.
*
* @since 1.4.1
*
* @param array $args Optional. Arguments for enabling author box. Default is empty array.
*/
function genesis_enable_author_box($args = [])
{
}
/**
* Redirect the user to an admin page, and add query args to the URL string for alerts, etc.
*
* @since 1.6.0
*
* @param string $page Menu slug.
* @param array $query_args Optional. Associative array of query string arguments (key => value). Default is an empty array.
* @return void Return early if first argument, `$page`, is falsy.
*/
function genesis_admin_redirect($page, array $query_args = [])
{
}
/**
* Redirect singular page to an alternate URL.
*
* @since 2.0.0
*
* @return void Return early if not a singular entry.
*/
function genesis_custom_field_redirect()
{
}
/**
* Return a specific value from the array passed as the second argument to `add_theme_support()`.
*
* Supports associative and index array of theme support arguments.
*
* @since 1.9.0
*
* @param string $feature The theme feature.
* @param string $arg The theme feature argument.
* @param string $default Optional. Fallback if value is blank or doesn't exist.
* Default is empty string.
* @return mixed Return value if associative array, true if indexed array, or
* `$default` if theme does not support `$feature` or `$arg` does not exist.
*/
function genesis_get_theme_support_arg($feature, $arg, $default = '')
{
}
/**
* Check if the environment is in development mode via SCRIPT_DEBUG constant.
*
* @since 3.0.0
*
* @return bool True when debugging scripts, otherwise false.
*/