-
Notifications
You must be signed in to change notification settings - Fork 797
/
infinity.php
1744 lines (1494 loc) · 55 KB
/
infinity.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
use Automattic\Jetpack\Assets;
use Automattic\Jetpack\Redirect;
/*
Plugin Name: The Neverending Home Page.
Plugin URI: https://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: https://automattic.com/
License: GNU General Public License v2 or later
License URI: https://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( 'customize_preview_init', array( $this, 'init_customizer_assets' ) );
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' ) );
add_filter( 'infinite_scroll_additional_scripts', array( $this, 'add_mejs_config' ) );
// 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:
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;
if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
// This setting is no longer configurable in wp-admin on WordPress.com -- leave a pointer
add_settings_field( self::$option_name_enabled,
'<span id="infinite-scroll-options">' . esc_html__( 'Infinite Scroll Behavior', 'jetpack' ) . '</span>',
array( $this, 'infinite_setting_html_calypso_placeholder' ),
'reading'
);
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' );
}
function infinite_setting_html_calypso_placeholder() {
$details = get_blog_details();
$writing_url = Redirect::get_url( 'calypso-settings-writing', array( 'site' => $details->domain ) );
echo '<span>' . sprintf(
/* translators: Variables are the enclosing link to the settings page */
esc_html__( 'This option has moved. You can now manage it %1$shere%2$s.', 'jetpack' ),
'<a href="' . esc_url( $writing_url ) . '">',
'</a>'
) . '</span>';
}
/**
* 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',
Assets::get_file_url_for_environment(
'_inc/build/infinite-scroll/infinity.min.js',
'modules/infinite-scroll/infinity.js'
),
array(),
JETPACK__VERSION . '-is5.0.0', // Added for ability to cachebust on WP.com.
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_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 );
}
/**
* Initialize the Customizer logic separately from the main JS.
*
* @since 8.4.0
*/
public function init_customizer_assets() {
// Add our scripts.
wp_register_script(
'the-neverending-homepage-customizer',
Assets::get_file_url_for_environment(
'_inc/build/infinite-scroll/infinity-customizer.min.js',
'modules/infinite-scroll/infinity-customizer.js'
),
array( 'customize-base' ),
JETPACK__VERSION . '-is5.0.0', // Added for ability to cachebust on WP.com.
true
);
wp_enqueue_script( 'the-neverending-homepage-customizer' );
}
/**
* 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 return posts
* in the correct order, without duplicates, if a new post is added
* and we're sorting by 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 ( 'post_date' !== $sort_field || 'DESC' !== $_REQUEST['query_args']['order'] ) {
return $where;
}
$query_before = sanitize_text_field( wp_unslash( $_REQUEST['query_before'] ) );
if ( empty( $query_before ) ) {
return $where;
}
// Construct the date query using our timestamp
$clause = $wpdb->prepare( " AND {$wpdb->posts}.post_date <= %s", $query_before );
/**
* 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 @deprecated Query operator.
* @param string $last_post_date @deprecated Last Post Date timestamp.
*/
$operator = 'ASC' === $_REQUEST['query_args']['order'] ? '>' : '<';
$last_post_date = sanitize_text_field( wp_unslash( $_REQUEST['last_post_date'] ) );
$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(),
'query_before' => current_time( 'mysql' ),
'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 = JSON.parse( decodeURIComponent( '<?php echo
rawurlencode( 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.