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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
|
<?php
/*
Plugin Name: The Neverending Home Page.
Plugin URI: http://automattic.com/
Description: Adds infinite scrolling support to the front-end blog post view for themes, pulling the next set of posts automatically into view when the reader approaches the bottom of the page.
Version: 1.1
Author: Automattic
Author URI: http://automattic.com/
License: GNU General Public License v2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
*/
/**
* Class: The_Neverending_Home_Page relies on add_theme_support, expects specific
* styling from each theme; including fixed footer.
*/
class The_Neverending_Home_Page {
/**
* Register actions and filters, plus parse IS settings
*
* @uses add_action, add_filter, self::get_settings
* @return null
*/
function __construct() {
add_action( 'pre_get_posts', array( $this, 'posts_per_page_query' ) );
add_action( 'admin_init', array( $this, 'settings_api_init' ) );
add_action( 'template_redirect', array( $this, 'action_template_redirect' ) );
add_action( 'template_redirect', array( $this, 'ajax_response' ) );
add_action( 'custom_ajax_infinite_scroll', array( $this, 'query' ) );
add_filter( 'infinite_scroll_query_args', array( $this, 'inject_query_args' ) );
add_filter( 'infinite_scroll_allowed_vars', array( $this, 'allowed_query_vars' ) );
add_action( 'the_post', array( $this, 'preserve_more_tag' ) );
add_action( 'wp_footer', array( $this, 'footer' ) );
// Plugin compatibility
add_filter( 'grunion_contact_form_redirect_url', array( $this, 'filter_grunion_redirect_url' ) );
// Parse IS settings from theme
self::get_settings();
}
/**
* Initialize our static variables
*/
static $the_time = null;
static $settings = null; // Don't access directly, instead use self::get_settings().
static $option_name_enabled = 'infinite_scroll';
/**
* Parse IS settings provided by theme
*
* @uses get_theme_support, infinite_scroll_has_footer_widgets, sanitize_title, add_action, get_option, wp_parse_args, is_active_sidebar
* @return object
*/
static function get_settings() {
if ( is_null( self::$settings ) ) {
$css_pattern = '#[^A-Z\d\-_]#i';
$settings = $defaults = array(
'type' => 'scroll', // scroll | click
'requested_type' => 'scroll', // store the original type for use when logic overrides it
'footer_widgets' => false, // true | false | sidebar_id | array of sidebar_ids -- last two are checked with is_active_sidebar
'container' => 'content', // container html id
'wrapper' => true, // true | false | html class
'render' => false, // optional function, otherwise the `content` template part will be used
'footer' => true, // boolean to enable or disable the infinite footer | string to provide an html id to derive footer width from
'footer_callback' => false, // function to be called to render the IS footer, in place of the default
'posts_per_page' => false, // int | false to set based on IS type
'click_handle' => true, // boolean to enable or disable rendering the click handler div. If type is click and this is false, page must include its own trigger with the HTML ID `infinite-handle`.
);
// Validate settings passed through add_theme_support()
$_settings = get_theme_support( 'infinite-scroll' );
if ( is_array( $_settings ) ) {
// Preferred implementation, where theme provides an array of options
if ( isset( $_settings[0] ) && is_array( $_settings[0] ) ) {
foreach ( $_settings[0] as $key => $value ) {
switch ( $key ) {
case 'type' :
if ( in_array( $value, array( 'scroll', 'click' ) ) )
$settings[ $key ] = $settings['requested_type'] = $value;
break;
case 'footer_widgets' :
if ( is_string( $value ) )
$settings[ $key ] = sanitize_title( $value );
elseif ( is_array( $value ) )
$settings[ $key ] = array_map( 'sanitize_title', $value );
elseif ( is_bool( $value ) )
$settings[ $key ] = $value;
break;
case 'container' :
case 'wrapper' :
if ( 'wrapper' == $key && is_bool( $value ) ) {
$settings[ $key ] = $value;
} else {
$value = preg_replace( $css_pattern, '', $value );
if ( ! empty( $value ) )
$settings[ $key ] = $value;
}
break;
case 'render' :
if ( false !== $value && is_callable( $value ) ) {
$settings[ $key ] = $value;
}
break;
case 'footer' :
if ( is_bool( $value ) ) {
$settings[ $key ] = $value;
} elseif ( is_string( $value ) ) {
$value = preg_replace( $css_pattern, '', $value );
if ( ! empty( $value ) )
$settings[ $key ] = $value;
}
break;
case 'footer_callback' :
if ( is_callable( $value ) )
$settings[ $key ] = $value;
else
$settings[ $key ] = false;
break;
case 'posts_per_page' :
if ( is_numeric( $value ) )
$settings[ $key ] = (int) $value;
break;
case 'click_handle' :
if ( is_bool( $value ) ) {
$settings[ $key ] = $value;
}
break;
default:
continue;
break;
}
}
} elseif ( is_string( $_settings[0] ) ) {
// Checks below are for backwards compatibility
// Container to append new posts to
$settings['container'] = preg_replace( $css_pattern, '', $_settings[0] );
// Wrap IS elements?
if ( isset( $_settings[1] ) )
$settings['wrapper'] = (bool) $_settings[1];
}
}
// Always ensure all values are present in the final array
$settings = wp_parse_args( $settings, $defaults );
// Check if a legacy `infinite_scroll_has_footer_widgets()` function is defined and override the footer_widgets parameter's value.
// Otherwise, if a widget area ID or array of IDs was provided in the footer_widgets parameter, check if any contains any widgets.
// It is safe to use `is_active_sidebar()` before the sidebar is registered as this function doesn't check for a sidebar's existence when determining if it contains any widgets.
if ( function_exists( 'infinite_scroll_has_footer_widgets' ) ) {
$settings['footer_widgets'] = (bool) infinite_scroll_has_footer_widgets();
} elseif ( is_array( $settings['footer_widgets'] ) ) {
$sidebar_ids = $settings['footer_widgets'];
$settings['footer_widgets'] = false;
foreach ( $sidebar_ids as $sidebar_id ) {
if ( is_active_sidebar( $sidebar_id ) ) {
$settings['footer_widgets'] = true;
break;
}
}
unset( $sidebar_ids );
unset( $sidebar_id );
} elseif ( is_string( $settings['footer_widgets'] ) ) {
$settings['footer_widgets'] = (bool) is_active_sidebar( $settings['footer_widgets'] );
}
/**
* Filter Infinite Scroll's `footer_widgets` parameter.
*
* @module infinite-scroll
*
* @since 2.0.0
*
* @param bool $settings['footer_widgets'] Does the current theme have Footer Widgets.
*/
$settings['footer_widgets'] = apply_filters( 'infinite_scroll_has_footer_widgets', $settings['footer_widgets'] );
// Finally, after all of the sidebar checks and filtering, ensure that a boolean value is present, otherwise set to default of `false`.
if ( ! is_bool( $settings['footer_widgets'] ) )
$settings['footer_widgets'] = false;
// Ensure that IS is enabled and no footer widgets exist if the IS type isn't already "click".
if ( 'click' != $settings['type'] ) {
// Check the setting status
$disabled = '' === get_option( self::$option_name_enabled ) ? true : false;
// Footer content or Reading option check
if ( $settings['footer_widgets'] || $disabled )
$settings['type'] = 'click';
}
// Force display of the click handler and attendant bits when the type isn't `click`
if ( 'click' !== $settings['type'] ) {
$settings['click_handle'] = true;
}
// Store final settings in a class static to avoid reparsing
/**
* Filter the array of Infinite Scroll settings.
*
* @module infinite-scroll
*
* @since 2.0.0
*
* @param array $settings Array of Infinite Scroll settings.
*/
self::$settings = apply_filters( 'infinite_scroll_settings', $settings );
}
/** This filter is already documented in modules/infinite-scroll/infinity.php */
return (object) apply_filters( 'infinite_scroll_settings', self::$settings );
}
/**
* Number of posts per page.
*
* @uses self::wp_query, self::get_settings, apply_filters
* @return int
*/
static function posts_per_page() {
$posts_per_page = self::get_settings()->posts_per_page ? self::get_settings()->posts_per_page : self::wp_query()->get( 'posts_per_page' );
// Take JS query into consideration here
if ( true === isset( $_REQUEST['query_args']['posts_per_page'] ) ) {
$posts_per_page = $_REQUEST['query_args']['posts_per_page'];
}
/**
* Filter the number of posts per page.
*
* @module infinite-scroll
*
* @since 6.0.0
*
* @param int $posts_per_page The number of posts to display per page.
*/
return (int) apply_filters( 'infinite_scroll_posts_per_page', $posts_per_page );
}
/**
* Retrieve the query used with Infinite Scroll
*
* @global $wp_the_query
* @uses apply_filters
* @return object
*/
static function wp_query() {
global $wp_the_query;
/**
* Filter the Infinite Scroll query object.
*
* @module infinite-scroll
*
* @since 2.2.1
*
* @param WP_Query $wp_the_query WP Query.
*/
return apply_filters( 'infinite_scroll_query_object', $wp_the_query );
}
/**
* Has infinite scroll been triggered?
*/
static function got_infinity() {
/**
* Filter the parameter used to check if Infinite Scroll has been triggered.
*
* @module infinite-scroll
*
* @since 3.9.0
*
* @param bool isset( $_GET[ 'infinity' ] ) Return true if the "infinity" parameter is set.
*/
return apply_filters( 'infinite_scroll_got_infinity', isset( $_GET[ 'infinity' ] ) );
}
/**
* Is this guaranteed to be the last batch of posts?
*/
static function is_last_batch() {
/**
* Override whether or not this is the last batch for a request
*
* @module infinite-scroll
*
* @since 4.8.0
*
* @param bool|null null Bool if value should be overridden, null to determine from query
* @param object self::wp_query() WP_Query object for current request
* @param object self::get_settings() Infinite Scroll settings
*/
$override = apply_filters( 'infinite_scroll_is_last_batch', null, self::wp_query(), self::get_settings() );
if ( is_bool( $override ) ) {
return $override;
}
$entries = (int) self::wp_query()->found_posts;
$posts_per_page = self::posts_per_page();
// This is to cope with an issue in certain themes or setups where posts are returned but found_posts is 0.
if ( 0 == $entries ) {
return (bool) ( count( self::wp_query()->posts ) < $posts_per_page );
}
$paged = max( 1, self::wp_query()->get( 'paged' ) );
// Are there enough posts for more than the first page?
if ( $entries <= $posts_per_page ) {
return true;
}
// Calculate entries left after a certain number of pages
if ( $paged && $paged > 1 ) {
$entries -= $posts_per_page * $paged;
}
// Are there some entries left to display?
return $entries <= 0;
}
/**
* The more tag will be ignored by default if the blog page isn't our homepage.
* Let's force the $more global to false.
*/
function preserve_more_tag( $array ) {
global $more;
if ( self::got_infinity() )
$more = 0; //0 = show content up to the more tag. Add more link.
return $array;
}
/**
* Add a checkbox field to Settings > Reading
* for enabling infinite scroll.
*
* Only show if the current theme supports infinity.
*
* @uses current_theme_supports, add_settings_field, __, register_setting
* @action admin_init
* @return null
*/
function settings_api_init() {
if ( ! current_theme_supports( 'infinite-scroll' ) )
return;
// Add the setting field [infinite_scroll] and place it in Settings > Reading
add_settings_field( self::$option_name_enabled, '<span id="infinite-scroll-options">' . esc_html__( 'Infinite Scroll Behavior', 'jetpack' ) . '</span>', array( $this, 'infinite_setting_html' ), 'reading' );
register_setting( 'reading', self::$option_name_enabled, 'esc_attr' );
}
/**
* HTML code to display a checkbox true/false option
* for the infinite_scroll setting.
*/
function infinite_setting_html() {
$notice = '<em>' . __( 'We’ve changed this option to a click-to-scroll version for you since you have footer widgets in Appearance → Widgets, or your theme uses click-to-scroll as the default behavior.', 'jetpack' ) . '</em>';
// If the blog has footer widgets, show a notice instead of the checkbox
if ( self::get_settings()->footer_widgets || 'click' == self::get_settings()->requested_type ) {
echo '<label>' . $notice . '</label>';
} else {
echo '<label><input name="infinite_scroll" type="checkbox" value="1" ' . checked( 1, '' !== get_option( self::$option_name_enabled ), false ) . ' /> ' . esc_html__( 'Check to load posts as you scroll. Uncheck to show clickable button to load posts', 'jetpack' ) . '</label>';
echo '<p class="description">' . esc_html( sprintf( _n( 'Shows %s post on each load.', 'Shows %s posts on each load.', self::posts_per_page(), 'jetpack' ), number_format_i18n( self::posts_per_page() ) ) ) . '</p>';
}
}
/**
* Does the legwork to determine whether the feature is enabled.
*
* @uses current_theme_supports, self::archive_supports_infinity, self::get_settings, add_filter, wp_enqueue_script, plugins_url, wp_enqueue_style, add_action
* @action template_redirect
* @return null
*/
function action_template_redirect() {
// Check that we support infinite scroll, and are on the home page.
if ( ! current_theme_supports( 'infinite-scroll' ) || ! self::archive_supports_infinity() )
return;
$id = self::get_settings()->container;
// Check that we have an id.
if ( empty( $id ) )
return;
// Add our scripts.
wp_register_script(
'the-neverending-homepage',
Jetpack::get_file_url_for_environment(
'_inc/build/infinite-scroll/infinity.min.js',
'modules/infinite-scroll/infinity.js'
),
array( 'jquery' ),
'4.0.0',
true
);
// Add our default styles.
wp_register_style( 'the-neverending-homepage', plugins_url( 'infinity.css', __FILE__ ), array(), '20140422' );
// Make sure there are enough posts for IS
if ( self::is_last_batch() ) {
return;
}
// Add our scripts.
wp_enqueue_script( 'the-neverending-homepage' );
// Add our default styles.
wp_enqueue_style( 'the-neverending-homepage' );
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_spinner_scripts' ) );
add_action( 'wp_footer', array( $this, 'action_wp_footer_settings' ), 2 );
add_action( 'wp_footer', array( $this, 'action_wp_footer' ), 21 ); // Core prints footer scripts at priority 20, so we just need to be one later than that
add_filter( 'infinite_scroll_results', array( $this, 'filter_infinite_scroll_results' ), 10, 3 );
}
/**
* Enqueue spinner scripts.
*/
function enqueue_spinner_scripts() {
wp_enqueue_script( 'jquery.spin' );
}
/**
* Returns classes to be added to <body>. If it's enabled, 'infinite-scroll'. If set to continuous scroll, adds 'neverending' too.
*
* @since 4.7.0 No longer added as a 'body_class' filter but passed to JS environment and added using JS.
*
* @return string
*/
function body_class() {
$classes = '';
// Do not add infinity-scroll class if disabled through the Reading page
$disabled = '' === get_option( self::$option_name_enabled ) ? true : false;
if ( ! $disabled || 'click' == self::get_settings()->type ) {
$classes = 'infinite-scroll';
if ( 'scroll' == self::get_settings()->type )
$classes .= ' neverending';
}
return $classes;
}
/**
* In case IS is activated on search page, we have to exclude initially loaded posts which match the keyword by title, not the content as they are displayed before content-matching ones
*
* @uses self::wp_query
* @uses self::get_last_post_date
* @uses self::has_only_title_matching_posts
* @return array
*/
function get_excluded_posts() {
$excluded_posts = array();
//loop through posts returned by wp_query call
foreach( self::wp_query()->get_posts() as $post ) {
$orderby = isset( self::wp_query()->query_vars['orderby'] ) ? self::wp_query()->query_vars['orderby'] : '';
$post_date = ( ! empty( $post->post_date ) ? $post->post_date : false );
if ( 'modified' === $orderby || false === $post_date ) {
$post_date = $post->post_modified;
}
//in case all posts initially displayed match the keyword by title we add em all to excluded posts array
//else, we add only posts which are older than last_post_date param as newer are natually excluded by last_post_date condition in the SQL query
if ( self::has_only_title_matching_posts() || $post_date <= self::get_last_post_date() ) {
array_push( $excluded_posts, $post->ID );
}
}
return $excluded_posts;
}
/**
* In case IS is active on search, we have to exclude posts matched by title rather than by post_content in order to prevent dupes on next pages
*
* @uses self::wp_query
* @uses self::get_excluded_posts
* @return array
*/
function get_query_vars() {
$query_vars = self::wp_query()->query_vars;
//applies to search page only
if ( true === self::wp_query()->is_search() ) {
//set post__not_in array in query_vars in case it does not exists
if ( false === isset( $query_vars['post__not_in'] ) ) {
$query_vars['post__not_in'] = array();
}
//get excluded posts
$excluded = self::get_excluded_posts();
//merge them with other post__not_in posts (eg.: sticky posts)
$query_vars['post__not_in'] = array_merge( $query_vars['post__not_in'], $excluded );
}
return $query_vars;
}
/**
* This function checks whether all posts returned by initial wp_query match the keyword by title
* The code used in this function is borrowed from WP_Query class where it is used to construct like conditions for keywords
*
* @uses self::wp_query
* @return bool
*/
function has_only_title_matching_posts() {
//apply following logic for search page results only
if ( false === self::wp_query()->is_search() ) {
return false;
}
//grab the last posts in the stack as if the last one is title-matching the rest is title-matching as well
$post = end( self::wp_query()->posts );
//code inspired by WP_Query class
if ( preg_match_all( '/".*?("|$)|((?<=[\t ",+])|^)[^\t ",+]+/', self::wp_query()->get( 's' ), $matches ) ) {
$search_terms = self::wp_query()->query_vars['search_terms'];
// if the search string has only short terms or stopwords, or is 10+ terms long, match it as sentence
if ( empty( $search_terms ) || count( $search_terms ) > 9 ) {
$search_terms = array( self::wp_query()->get( 's' ) );
}
} else {
$search_terms = array( self::wp_query()->get( 's' ) );
}
//actual testing. As search query combines multiple keywords with AND, it's enough to check if any of the keywords is present in the title
$term = current( $search_terms );
if ( ! empty( $term ) && false !== strpos( $post->post_title, $term ) ) {
return true;
}
return false;
}
/**
* Grab the timestamp for the initial query's last post.
*
* This takes into account the query's 'orderby' parameter and returns
* false if the posts are not ordered by date.
*
* @uses self::got_infinity
* @uses self::has_only_title_matching_posts
* @uses self::wp_query
* @return string 'Y-m-d H:i:s' or false
*/
function get_last_post_date() {
if ( self::got_infinity() )
return;
if ( ! self::wp_query()->have_posts() ) {
return null;
}
//In case there are only title-matching posts in the initial WP_Query result, we don't want to use the last_post_date param yet
if ( true === self::has_only_title_matching_posts() ) {
return false;
}
$post = end( self::wp_query()->posts );
$orderby = isset( self::wp_query()->query_vars['orderby'] ) ?
self::wp_query()->query_vars['orderby'] : '';
$post_date = ( ! empty( $post->post_date ) ? $post->post_date : false );
switch ( $orderby ) {
case 'modified':
return $post->post_modified;
case 'date':
case '':
return $post_date;
default:
return false;
}
}
/**
* Returns the appropriate `wp_posts` table field for a given query's
* 'orderby' parameter, if applicable.
*
* @param optional object $query
* @uses self::wp_query
* @return string or false
*/
function get_query_sort_field( $query = null ) {
if ( empty( $query ) )
$query = self::wp_query();
$orderby = isset( $query->query_vars['orderby'] ) ? $query->query_vars['orderby'] : '';
switch ( $orderby ) {
case 'modified':
return 'post_modified';
case 'date':
case '':
return 'post_date';
default:
return false;
}
}
/**
* Create a where clause that will make sure post queries
* will always return results prior to (descending sort)
* or before (ascending sort) the last post date.
*
* @global $wpdb
* @param string $where
* @param object $query
* @uses apply_filters
* @filter posts_where
* @return string
*/
function query_time_filter( $where, $query ) {
if ( self::got_infinity() ) {
global $wpdb;
$sort_field = self::get_query_sort_field( $query );
if ( false == $sort_field )
return $where;
$last_post_date = $_REQUEST['last_post_date'];
// Sanitize timestamp
if ( empty( $last_post_date ) || !preg_match( '|\d{4}\-\d{2}\-\d{2}|', $last_post_date ) )
return $where;
$operator = 'ASC' == $_REQUEST['query_args']['order'] ? '>' : '<';
// Construct the date query using our timestamp
$clause = $wpdb->prepare( " AND {$wpdb->posts}.{$sort_field} {$operator} %s", $last_post_date );
/**
* Filter Infinite Scroll's SQL date query making sure post queries
* will always return results prior to (descending sort)
* or before (ascending sort) the last post date.
*
* @module infinite-scroll
*
* @param string $clause SQL Date query.
* @param object $query Query.
* @param string $operator Query operator.
* @param string $last_post_date Last Post Date timestamp.
*/
$where .= apply_filters( 'infinite_scroll_posts_where', $clause, $query, $operator, $last_post_date );
}
return $where;
}
/**
* Let's overwrite the default post_per_page setting to always display a fixed amount.
*
* @param object $query
* @uses is_admin, self::archive_supports_infinity, self::get_settings
* @return null
*/
function posts_per_page_query( $query ) {
if ( ! is_admin() && self::archive_supports_infinity() && $query->is_main_query() )
$query->set( 'posts_per_page', self::posts_per_page() );
}
/**
* Check if the IS output should be wrapped in a div.
* Setting value can be a boolean or a string specifying the class applied to the div.
*
* @uses self::get_settings
* @return bool
*/
function has_wrapper() {
return (bool) self::get_settings()->wrapper;
}
/**
* Returns the Ajax url
*
* @global $wp
* @uses home_url, add_query_arg, apply_filters
* @return string
*/
function ajax_url() {
$base_url = set_url_scheme( home_url( '/' ) );
$ajaxurl = add_query_arg( array( 'infinity' => 'scrolling' ), $base_url );
/**
* Filter the Infinite Scroll Ajax URL.
*
* @module infinite-scroll
*
* @since 2.0.0
*
* @param string $ajaxurl Infinite Scroll Ajax URL.
*/
return apply_filters( 'infinite_scroll_ajax_url', $ajaxurl );
}
/**
* Our own Ajax response, avoiding calling admin-ajax
*/
function ajax_response() {
// Only proceed if the url query has a key of "Infinity"
if ( ! self::got_infinity() )
return false;
// This should already be defined below, but make sure.
if ( ! defined( 'DOING_AJAX' ) ) {
define( 'DOING_AJAX', true );
}
@header( 'Content-Type: text/html; charset=' . get_option( 'blog_charset' ) );
send_nosniff_header();
/**
* Fires at the end of the Infinite Scroll Ajax response.
*
* @module infinite-scroll
*
* @since 2.0.0
*/
do_action( 'custom_ajax_infinite_scroll' );
die( '0' );
}
/**
* Alias for renamed class method.
*
* Previously, JS settings object was unnecessarily output in the document head.
* When the hook was changed, the method name no longer made sense.
*/
function action_wp_head() {
$this->action_wp_footer_settings();
}
/**
* Prints the relevant infinite scroll settings in JS.
*
* @global $wp_rewrite
* @uses self::get_settings, esc_js, esc_url_raw, self::has_wrapper, __, apply_filters, do_action, self::get_query_vars
* @action wp_footer
* @return string
*/
function action_wp_footer_settings() {
global $wp_rewrite;
global $currentday;
// Default click handle text
$click_handle_text = __( 'Older posts', 'jetpack' );
// If a single CPT is displayed, use its plural name instead of "posts"
// Could be empty (posts) or an array of multiple post types.
// In the latter two cases cases, the default text is used, leaving the `infinite_scroll_js_settings` filter for further customization.
$post_type = self::wp_query()->get( 'post_type' );
// If it's a taxonomy, try to change the button text.
if ( is_tax() ) {
// Get current taxonomy slug.
$taxonomy_slug = self::wp_query()->get( 'taxonomy' );
// Get taxonomy settings.
$taxonomy = get_taxonomy( $taxonomy_slug );
// Check if the taxonomy is attached to one post type only and use its plural name.
// If not, use "Posts" without confusing the users.
if ( count( $taxonomy->object_type ) < 2 ) {
$post_type = $taxonomy->object_type[0];
}
}
if ( is_string( $post_type ) && ! empty( $post_type ) ) {
$post_type = get_post_type_object( $post_type );
if ( is_object( $post_type ) && ! is_wp_error( $post_type ) ) {
if ( isset( $post_type->labels->name ) ) {
$cpt_text = $post_type->labels->name;
} elseif ( isset( $post_type->label ) ) {
$cpt_text = $post_type->label;
}
if ( isset( $cpt_text ) ) {
/* translators: %s is the name of a custom post type */
$click_handle_text = sprintf( __( 'More %s', 'jetpack' ), $cpt_text );
unset( $cpt_text );
}
}
}
unset( $post_type );
// Base JS settings
$js_settings = array(
'id' => self::get_settings()->container,
'ajaxurl' => esc_url_raw( self::ajax_url() ),
'type' => esc_js( self::get_settings()->type ),
'wrapper' => self::has_wrapper(),
'wrapper_class' => is_string( self::get_settings()->wrapper ) ? esc_js( self::get_settings()->wrapper ) : 'infinite-wrap',
'footer' => is_string( self::get_settings()->footer ) ? esc_js( self::get_settings()->footer ) : self::get_settings()->footer,
'click_handle' => esc_js( self::get_settings()->click_handle ),
'text' => esc_js( $click_handle_text ),
'totop' => esc_js( __( 'Scroll back to top', 'jetpack' ) ),
'currentday' => $currentday,
'order' => 'DESC',
'scripts' => array(),
'styles' => array(),
'google_analytics' => false,
'offset' => max( 1, self::wp_query()->get( 'paged' ) ), // Pass through the current page so we can use that to offset the first load.
'history' => array(
'host' => preg_replace( '#^http(s)?://#i', '', untrailingslashit( esc_url( get_home_url() ) ) ),
'path' => self::get_request_path(),
'use_trailing_slashes' => $wp_rewrite->use_trailing_slashes,
'parameters' => self::get_request_parameters(),
),
'query_args' => self::get_query_vars(),
'last_post_date' => self::get_last_post_date(),
'body_class' => self::body_class(),
);
// Optional order param
if ( isset( $_REQUEST['order'] ) ) {
$order = strtoupper( $_REQUEST['order'] );
if ( in_array( $order, array( 'ASC', 'DESC' ) ) )
$js_settings['order'] = $order;
}
/**
* Filter the Infinite Scroll JS settings outputted in the head.
*
* @module infinite-scroll
*
* @since 2.0.0
*
* @param array $js_settings Infinite Scroll JS settings.
*/
$js_settings = apply_filters( 'infinite_scroll_js_settings', $js_settings );
/**
* Fires before Infinite Scroll outputs inline JavaScript in the head.
*
* @module infinite-scroll
*
* @since 2.0.0
*/
do_action( 'infinite_scroll_wp_head' );
?>
<script type="text/javascript">
//<![CDATA[
var infiniteScroll = <?php echo json_encode( array( 'settings' => $js_settings ) ); ?>;
//]]>
</script>
<?php
}
/**
* Build path data for current request.
* Used for Google Analytics and pushState history tracking.
*
* @global $wp_rewrite
* @global $wp
* @uses user_trailingslashit, sanitize_text_field, add_query_arg
* @return string|bool
*/
private function get_request_path() {
global $wp_rewrite;
if ( $wp_rewrite->using_permalinks() ) {
global $wp;
// If called too early, bail
if ( ! isset( $wp->request ) )
return false;
// Determine path for paginated version of current request
if ( false != preg_match( '#' . $wp_rewrite->pagination_base . '/\d+/?$#i', $wp->request ) )
$path = preg_replace( '#' . $wp_rewrite->pagination_base . '/\d+$#i', $wp_rewrite->pagination_base . '/%d', $wp->request );
else
$path = $wp->request . '/' . $wp_rewrite->pagination_base . '/%d';
// Slashes everywhere we need them
if ( 0 !== strpos( $path, '/' ) )
$path = '/' . $path;
$path = user_trailingslashit( $path );
} else {
// Clean up raw $_REQUEST input
$path = array_map( 'sanitize_text_field', $_REQUEST );
$path = array_filter( $path );
$path['paged'] = '%d';
$path = add_query_arg( $path, '/' );
}
return empty( $path ) ? false : $path;
}
/**
* Return query string for current request, prefixed with '?'.
*
* @return string
*/
private function get_request_parameters() {
$uri = $_SERVER[ 'REQUEST_URI' ];
$uri = preg_replace( '/^[^?]*(\?.*$)/', '$1', $uri, 1, $count );
if ( $count != 1 )
return '';
return $uri;
}
/**
* Provide IS with a list of the scripts and stylesheets already present on the page.
* Since posts may contain require additional assets that haven't been loaded, this data will be used to track the additional assets.
*
* @global $wp_scripts, $wp_styles
* @action wp_footer
* @return string
*/
function action_wp_footer() {
global $wp_scripts, $wp_styles;
$scripts = is_a( $wp_scripts, 'WP_Scripts' ) ? $wp_scripts->done : array();
/**
* Filter the list of scripts already present on the page.
*
* @module infinite-scroll
*
* @since 2.1.2
*
* @param array $scripts Array of scripts present on the page.
*/
$scripts = apply_filters( 'infinite_scroll_existing_scripts', $scripts );
$styles = is_a( $wp_styles, 'WP_Styles' ) ? $wp_styles->done : array();
/**
* Filter the list of styles already present on the page.
*
* @module infinite-scroll
*
* @since 2.1.2
*
* @param array $styles Array of styles present on the page.
*/
$styles = apply_filters( 'infinite_scroll_existing_stylesheets', $styles );
?><script type="text/javascript">
jQuery.extend( infiniteScroll.settings.scripts, <?php echo json_encode( $scripts ); ?> );
jQuery.extend( infiniteScroll.settings.styles, <?php echo json_encode( $styles ); ?> );
</script><?php
}
/**
* Identify additional scripts required by the latest set of IS posts and provide the necessary data to the IS response handler.
*
* @global $wp_scripts
* @uses sanitize_text_field, add_query_arg
* @filter infinite_scroll_results
* @return array
*/
function filter_infinite_scroll_results( $results, $query_args, $wp_query ) {
// Don't bother unless there are posts to display
if ( 'success' != $results['type'] )
return $results;
// Parse and sanitize the script handles already output
$initial_scripts = isset( $_REQUEST['scripts'] ) && is_array( $_REQUEST['scripts'] ) ? array_map( 'sanitize_text_field', $_REQUEST['scripts'] ) : false;
if ( is_array( $initial_scripts ) ) {
global $wp_scripts;
// Identify new scripts needed by the latest set of IS posts
$new_scripts = array_diff( $wp_scripts->done, $initial_scripts );
// If new scripts are needed, extract relevant data from $wp_scripts
if ( ! empty( $new_scripts ) ) {
$results['scripts'] = array();
foreach ( $new_scripts as $handle ) {
// Abort if somehow the handle doesn't correspond to a registered script
if ( ! isset( $wp_scripts->registered[ $handle ] ) )
continue;
// Provide basic script data
$script_data = array(
'handle' => $handle,
'footer' => ( is_array( $wp_scripts->in_footer ) && in_array( $handle, $wp_scripts->in_footer ) ),
'extra_data' => $wp_scripts->print_extra_script( $handle, false )
);
// Base source
$src = $wp_scripts->registered[ $handle ]->src;
// Take base_url into account
if ( strpos( $src, 'http' ) !== 0 )
$src = $wp_scripts->base_url . $src;
// Version and additional arguments
if ( null === $wp_scripts->registered[ $handle ]->ver )
$ver = '';
else
$ver = $wp_scripts->registered[ $handle ]->ver ? $wp_scripts->registered[ $handle ]->ver : $wp_scripts->default_version;
if ( isset( $wp_scripts->args[ $handle ] ) )
$ver = $ver ? $ver . '&' . $wp_scripts->args[$handle] : $wp_scripts->args[$handle];
// Full script source with version info
$script_data['src'] = add_query_arg( 'ver', $ver, $src );
// Add script to data that will be returned to IS JS
array_push( $results['scripts'], $script_data );
}
}
}
// Expose additional script data to filters, but only include in final `$results` array if needed.
if ( ! isset( $results['scripts'] ) )
$results['scripts'] = array();
/**
* Filter the additional scripts required by the latest set of IS posts.
*
* @module infinite-scroll
*
* @since 2.1.2
*
* @param array $results['scripts'] Additional scripts required by the latest set of IS posts.
* @param array|bool $initial_scripts Set of scripts loaded on each page.
* @param array $results Array of Infinite Scroll results.
* @param array $query_args Array of Query arguments.
* @param WP_Query $wp_query WP Query.
*/
$results['scripts'] = apply_filters(
'infinite_scroll_additional_scripts',
$results['scripts'],
$initial_scripts,
$results,
$query_args,
$wp_query
);
if ( empty( $results['scripts'] ) )
unset( $results['scripts' ] );
// Parse and sanitize the style handles already output
$initial_styles = isset( $_REQUEST['styles'] ) && is_array( $_REQUEST['styles'] ) ? array_map( 'sanitize_text_field', $_REQUEST['styles'] ) : false;
if ( is_array( $initial_styles ) ) {
global $wp_styles;
// Identify new styles needed by the latest set of IS posts
$new_styles = array_diff( $wp_styles->done, $initial_styles );
// If new styles are needed, extract relevant data from $wp_styles
if ( ! empty( $new_styles ) ) {
$results['styles'] = array();
foreach ( $new_styles as $handle ) {
// Abort if somehow the handle doesn't correspond to a registered stylesheet
if ( ! isset( $wp_styles->registered[ $handle ] ) )
continue;
// Provide basic style data
$style_data = array(
'handle' => $handle,
'media' => 'all'
);
// Base source
$src = $wp_styles->registered[ $handle ]->src;
// Take base_url into account
if ( strpos( $src, 'http' ) !== 0 )
$src = $wp_styles->base_url . $src;
// Version and additional arguments
if ( null === $wp_styles->registered[ $handle ]->ver )
$ver = '';
else
$ver = $wp_styles->registered[ $handle ]->ver ? $wp_styles->registered[ $handle ]->ver : $wp_styles->default_version;
if ( isset($wp_styles->args[ $handle ] ) )
$ver = $ver ? $ver . '&' . $wp_styles->args[$handle] : $wp_styles->args[$handle];
// Full stylesheet source with version info
$style_data['src'] = add_query_arg( 'ver', $ver, $src );
// Parse stylesheet's conditional comments if present, converting to logic executable in JS
if ( isset( $wp_styles->registered[ $handle ]->extra['conditional'] ) && $wp_styles->registered[ $handle ]->extra['conditional'] ) {
// First, convert conditional comment operators to standard logical operators. %ver is replaced in JS with the IE version
$style_data['conditional'] = str_replace( array(
'lte',
'lt',
'gte',
'gt'
), array(
'%ver <=',
'%ver <',
'%ver >=',
'%ver >',
), $wp_styles->registered[ $handle ]->extra['conditional'] );
// Next, replace any !IE checks. These shouldn't be present since WP's conditional stylesheet implementation doesn't support them, but someone could be _doing_it_wrong().
$style_data['conditional'] = preg_replace( '#!\s*IE(\s*\d+){0}#i', '1==2', $style_data['conditional'] );
// Lastly, remove the IE strings
$style_data['conditional'] = str_replace( 'IE', '', $style_data['conditional'] );
}
// Parse requested media context for stylesheet
if ( isset( $wp_styles->registered[ $handle ]->args ) )
$style_data['media'] = esc_attr( $wp_styles->registered[ $handle ]->args );
// Add stylesheet to data that will be returned to IS JS
array_push( $results['styles'], $style_data );
}
}
}
// Expose additional stylesheet data to filters, but only include in final `$results` array if needed.
if ( ! isset( $results['styles'] ) )
$results['styles'] = array();
/**
* Filter the additional styles required by the latest set of IS posts.
*
* @module infinite-scroll
*
* @since 2.1.2
*
* @param array $results['styles'] Additional styles required by the latest set of IS posts.
* @param array|bool $initial_styles Set of styles loaded on each page.
* @param array $results Array of Infinite Scroll results.
* @param array $query_args Array of Query arguments.
* @param WP_Query $wp_query WP Query.
*/
$results['styles'] = apply_filters(
'infinite_scroll_additional_stylesheets',
$results['styles'],
$initial_styles,
$results,
$query_args,
$wp_query
);
if ( empty( $results['styles'] ) )
unset( $results['styles' ] );
// Lastly, return the IS results array
return $results;
}
/**
* Runs the query and returns the results via JSON.
* Triggered by an AJAX request.
*
* @global $wp_query
* @global $wp_the_query
* @uses current_theme_supports, get_option, self::wp_query, current_user_can, apply_filters, self::get_settings, add_filter, WP_Query, remove_filter, have_posts, wp_head, do_action, add_action, this::render, this::has_wrapper, esc_attr, wp_footer, sharing_register_post_for_share_counts, get_the_id
* @return string or null
*/
function query() {
global $wp_customize;
global $wp_version;
if ( ! isset( $_REQUEST['page'] ) || ! current_theme_supports( 'infinite-scroll' ) )
die;
$page = (int) $_REQUEST['page'];
// Sanitize and set $previousday. Expected format: dd.mm.yy
if ( preg_match( '/^\d{2}\.\d{2}\.\d{2}$/', $_REQUEST['currentday'] ) ) {
global $previousday;
$previousday = $_REQUEST['currentday'];
}
$sticky = get_option( 'sticky_posts' );
$post__not_in = self::wp_query()->get( 'post__not_in' );
//we have to take post__not_in args into consideration here not only sticky posts
if ( true === isset( $_REQUEST['query_args']['post__not_in'] ) ) {
$post__not_in = array_merge( $post__not_in, array_map( 'intval', (array) $_REQUEST['query_args']['post__not_in'] ) );
}
if ( ! empty( $post__not_in ) )
$sticky = array_unique( array_merge( $sticky, $post__not_in ) );
$post_status = array( 'publish' );
if ( current_user_can( 'read_private_posts' ) )
array_push( $post_status, 'private' );
$order = in_array( $_REQUEST['order'], array( 'ASC', 'DESC' ) ) ? $_REQUEST['order'] : 'DESC';
$query_args = array_merge( self::wp_query()->query_vars, array(
'paged' => $page,
'post_status' => $post_status,
'posts_per_page' => self::posts_per_page(),
'post__not_in' => ( array ) $sticky,
'order' => $order
) );
// 4.0 ?s= compatibility, see https://core.trac.wordpress.org/ticket/11330#comment:50
if ( empty( $query_args['s'] ) && ! isset( self::wp_query()->query['s'] ) ) {
unset( $query_args['s'] );
}
// By default, don't query for a specific page of a paged post object.
// This argument can come from merging self::wp_query() into $query_args above.
// Since IS is only used on archives, we should always display the first page of any paged content.
unset( $query_args['page'] );
/**
* Filter the array of main query arguments.
*
* @module infinite-scroll
*
* @since 2.0.1
*
* @param array $query_args Array of Query arguments.
*/
$query_args = apply_filters( 'infinite_scroll_query_args', $query_args );
// Add query filter that checks for posts below the date
add_filter( 'posts_where', array( $this, 'query_time_filter' ), 10, 2 );
$GLOBALS['wp_the_query'] = $GLOBALS['wp_query'] = $infinite_scroll_query = new WP_Query();
$infinite_scroll_query->query( $query_args );
remove_filter( 'posts_where', array( $this, 'query_time_filter' ), 10, 2 );
$results = array();
if ( have_posts() ) {
// Fire wp_head to ensure that all necessary scripts are enqueued. Output isn't used, but scripts are extracted in self::action_wp_footer.
ob_start();
wp_head();
while ( ob_get_length() ) {
ob_end_clean();
}
$results['type'] = 'success';
/**
* Gather renderer callbacks. These will be called in order and allow multiple callbacks to be queued. Once content is found, no futher callbacks will run.
*
* @module infinite-scroll
*
* @since 6.0.0
*/
$callbacks = apply_filters( 'infinite_scroll_render_callbacks', array(
self::get_settings()->render, // This is the setting callback e.g. from add theme support.
) );
// Append fallback callback. That rhymes.
$callbacks[] = array( $this, 'render' );
foreach ( $callbacks as $callback ) {
if ( false !== $callback && is_callable( $callback ) ) {
rewind_posts();
ob_start();
add_action( 'infinite_scroll_render', $callback );
/**
* Fires when rendering Infinite Scroll posts.
*
* @module infinite-scroll
*
* @since 2.0.0
*/
do_action( 'infinite_scroll_render' );
$results['html'] = ob_get_clean();
remove_action( 'infinite_scroll_render', $callback );
}
if ( ! empty( $results['html'] ) ) {
break;
}
}
// If primary and fallback rendering methods fail, prevent further IS rendering attempts. Otherwise, wrap the output if requested.
if ( empty( $results['html'] ) ) {
unset( $results['html'] );
/**
* Fires when Infinite Scoll doesn't render any posts.
*
* @module infinite-scroll
*
* @since 2.0.0
*/
do_action( 'infinite_scroll_empty' );
$results['type'] = 'empty';
} elseif ( $this->has_wrapper() ) {
$wrapper_classes = is_string( self::get_settings()->wrapper ) ? self::get_settings()->wrapper : 'infinite-wrap';
$wrapper_classes .= ' infinite-view-' . $page;
$wrapper_classes = trim( $wrapper_classes );
$results['html'] = '<div class="' . esc_attr( $wrapper_classes ) . '" id="infinite-view-' . $page . '" data-page-num="' . $page . '">' . $results['html'] . '</div>';
}
// Fire wp_footer to ensure that all necessary scripts are enqueued. Output isn't used, but scripts are extracted in self::action_wp_footer.
ob_start();
wp_footer();
while ( ob_get_length() ) {
ob_end_clean();
}
if ( 'success' == $results['type'] ) {
global $currentday;
$results['lastbatch'] = self::is_last_batch();
$results['currentday'] = $currentday;
}
// Loop through posts to capture sharing data for new posts loaded via Infinite Scroll
if ( 'success' == $results['type'] && function_exists( 'sharing_register_post_for_share_counts' ) ) {
global $jetpack_sharing_counts;
while( have_posts() ) {
the_post();
sharing_register_post_for_share_counts( get_the_ID() );
}
$results['postflair'] = array_flip( $jetpack_sharing_counts );
}
} else {
/** This action is already documented in modules/infinite-scroll/infinity.php */
do_action( 'infinite_scroll_empty' );
$results['type'] = 'empty';
}
// This should be removed when WordPress 4.8 is released.
if ( version_compare( $wp_version, '4.7', '<' ) && is_customize_preview() ) {
$wp_customize->remove_preview_signature();
}
wp_send_json(
/**
* Filter the Infinite Scroll results.
*
* @module infinite-scroll
*
* @since 2.0.0
*
* @param array $results Array of Infinite Scroll results.
* @param array $query_args Array of main query arguments.
* @param WP_Query $wp_query WP Query.
*/
apply_filters( 'infinite_scroll_results', $results, $query_args, self::wp_query() )
);
}
/**
* Update the $allowed_vars array with the standard WP public and private
* query vars, as well as taxonomy vars
*
* @global $wp
* @param array $allowed_vars
* @filter infinite_scroll_allowed_vars
* @return array
*/
function allowed_query_vars( $allowed_vars ) {
global $wp;
$allowed_vars += $wp->public_query_vars;
$allowed_vars += $wp->private_query_vars;
$allowed_vars += $this->get_taxonomy_vars();
foreach ( array_keys( $allowed_vars, 'paged' ) as $key ) {
unset( $allowed_vars[ $key ] );
}
return array_unique( $allowed_vars );
}
/**
* Returns an array of stock and custom taxonomy query vars
*
* @global $wp_taxonomies
* @return array
*/
function get_taxonomy_vars() {
global $wp_taxonomies;
$taxonomy_vars = array();
foreach ( $wp_taxonomies as $taxonomy => $t ) {
if ( $t->query_var )
$taxonomy_vars[] = $t->query_var;
}
// still needed?
$taxonomy_vars[] = 'tag_id';
return $taxonomy_vars;
}
/**
* Update the $query_args array with the parameters provided via AJAX/GET.
*
* @param array $query_args
* @filter infinite_scroll_query_args
* @return array
*/
function inject_query_args( $query_args ) {
/**
* Filter the array of allowed Infinite Scroll query arguments.
*
* @module infinite-scroll
*
* @since 2.6.0
*
* @param array $args Array of allowed Infinite Scroll query arguments.
* @param array $query_args Array of query arguments.
*/
$allowed_vars = apply_filters( 'infinite_scroll_allowed_vars', array(), $query_args );
$query_args = array_merge( $query_args, array(
'suppress_filters' => false,
) );
if ( is_array( $_REQUEST[ 'query_args' ] ) ) {
foreach ( $_REQUEST[ 'query_args' ] as $var => $value ) {
if ( in_array( $var, $allowed_vars ) && ! empty( $value ) )
$query_args[ $var ] = $value;
}
}
return $query_args;
}
/**
* Rendering fallback used when themes don't specify their own handler.
*
* @uses have_posts, the_post, get_template_part, get_post_format
* @action infinite_scroll_render
* @return string
*/
function render() {
while ( have_posts() ) {
the_post();
get_template_part( 'content', get_post_format() );
}
}
/**
* Allow plugins to filter what archives Infinite Scroll supports
*
* @uses current_theme_supports, is_home, is_archive, apply_filters, self::get_settings
* @return bool
*/
public static function archive_supports_infinity() {
$supported = current_theme_supports( 'infinite-scroll' ) && ( is_home() || is_archive() || is_search() );
// Disable when previewing a non-active theme in the customizer
if ( is_customize_preview() && ! $GLOBALS['wp_customize']->is_theme_active() ) {
return false;
}
/**
* Allow plugins to filter what archives Infinite Scroll supports.
*
* @module infinite-scroll
*
* @since 2.0.0
*
* @param bool $supported Does the Archive page support Infinite Scroll.
* @param object self::get_settings() IS settings provided by theme.
*/
return (bool) apply_filters( 'infinite_scroll_archive_supported', $supported, self::get_settings() );
}
/**
* The Infinite Blog Footer
*
* @uses self::get_settings, self::archive_supports_infinity, self::default_footer
* @return string or null
*/
function footer() {
// Bail if theme requested footer not show
if ( false == self::get_settings()->footer )
return;
// We only need the new footer for the 'scroll' type
if ( 'scroll' != self::get_settings()->type || ! self::archive_supports_infinity() )
return;
if ( self::is_last_batch() ) {
return;
}
// Display a footer, either user-specified or a default
if ( false !== self::get_settings()->footer_callback && is_callable( self::get_settings()->footer_callback ) )
call_user_func( self::get_settings()->footer_callback, self::get_settings() );
else
self::default_footer();
}
/**
* Render default IS footer
*
* @uses __, wp_get_theme, apply_filters, home_url, esc_attr, get_bloginfo, bloginfo
* @return string
*/
private function default_footer() {
$credits = sprintf(
'<a href="https://wordpress.org/" target="_blank" rel="generator">%1$s</a> ',
__( 'Proudly powered by WordPress', 'jetpack' )
);
$credits .= sprintf(
/* translators: %1$s is the name of a theme */
__( 'Theme: %1$s.', 'jetpack' ),
wp_get_theme()->Name
);
/**
* Filter Infinite Scroll's credit text.
*
* @module infinite-scroll
*
* @since 2.0.0
*
* @param string $credits Infinite Scroll credits.
*/
$credits = apply_filters( 'infinite_scroll_credit', $credits );
?>
<div id="infinite-footer">
<div class="container">
<div class="blog-info">
<a id="infinity-blog-title" href="<?php echo home_url( '/' ); ?>" rel="home">
<?php bloginfo( 'name' ); ?>
</a>
</div>
<div class="blog-credits">
<?php echo $credits; ?>
</div>
</div>
</div><!-- #infinite-footer -->
<?php
}
/**
* Ensure that IS doesn't interfere with Grunion by stripping IS query arguments from the Grunion redirect URL.
* When arguments are present, Grunion redirects to the IS AJAX endpoint.
*
* @param string $url
* @uses remove_query_arg
* @filter grunion_contact_form_redirect_url
* @return string
*/
public function filter_grunion_redirect_url( $url ) {
// Remove IS query args, if present
if ( false !== strpos( $url, 'infinity=scrolling' ) ) {
$url = remove_query_arg( array(
'infinity',
'action',
'page',
'order',
'scripts',
'styles'
), $url );
}
return $url;
}
};
/**
* Initialize The_Neverending_Home_Page
*/
function the_neverending_home_page_init() {
if ( ! current_theme_supports( 'infinite-scroll' ) )
return;
new The_Neverending_Home_Page;
}
add_action( 'init', 'the_neverending_home_page_init', 20 );
/**
* Check whether the current theme is infinite-scroll aware.
* If so, include the files which add theme support.
*/
function the_neverending_home_page_theme_support() {
$theme_name = get_stylesheet();
/**
* Filter the path to the Infinite Scroll compatibility file.
*
* @module infinite-scroll
*
* @since 2.0.0
*
* @param string $str IS compatibility file path.
* @param string $theme_name Theme name.
*/
$customization_file = apply_filters( 'infinite_scroll_customization_file', dirname( __FILE__ ) . "/themes/{$theme_name}.php", $theme_name );
if ( is_readable( $customization_file ) )
require_once( $customization_file );
}
add_action( 'after_setup_theme', 'the_neverending_home_page_theme_support', 5 );
/**
* Early accommodation of the Infinite Scroll AJAX request
*/
if ( The_Neverending_Home_Page::got_infinity() ) {
/**
* If we're sure this is an AJAX request (i.e. the HTTP_X_REQUESTED_WITH header says so),
* indicate it as early as possible for actions like init
*/
if ( ! defined( 'DOING_AJAX' ) &&
isset( $_SERVER['HTTP_X_REQUESTED_WITH'] ) &&
strtoupper( $_SERVER['HTTP_X_REQUESTED_WITH'] ) == 'XMLHTTPREQUEST'
) {
define( 'DOING_AJAX', true );
}
// Don't load the admin bar when doing the AJAX response.
show_admin_bar( false );
}
|