jetpack / modules / infinite-scroll.php

infinite-scroll.php in Jetpack – WP Security, Backup, Speed, & Growth 12.1, at modules/infinite-scroll.php

244 lines 8.1 KB

Raw Download Zip

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Module Name: Infinite Scroll
4	* Module Description: Automatically load new content when a visitor scrolls
5	* Sort Order: 26
6	* First Introduced: 2.0
7	* Requires Connection: No
8	* Auto Activate: No
9	* Module Tags: Appearance
10	* Feature: Appearance
11	* Additional Search Queries: scroll, infinite, infinite scroll
12	*/
13
14	use Automattic\Jetpack\Stats\Options as Stats_Options;
15
16	/**
17	* Jetpack-specific elements of Infinite Scroll
18	*/
19	class Jetpack_Infinite_Scroll_Extras {
20	/**
21	* Class variable singleton.
22	*
23	* @var Jetpack_Infinite_Scroll_Extras
24	*/
25	private static $instance = null;
26
27	/**
28	* Option names.
29	*
30	* @var string
31	*/
32	private $option_name_google_analytics = 'infinite_scroll_google_analytics';
33
34	/**
35	* Singleton implementation
36	*
37	* @return object
38	*/
39	public static function instance() {
40	if ( ! self::$instance instanceof Jetpack_Infinite_Scroll_Extras ) {
41	self::$instance = new Jetpack_Infinite_Scroll_Extras();
42	}
43
44	return self::$instance;
45	}
46
47	/**
48	* Register actions and filters
49	*
50	* @uses add_action, add_filter
51	*/
52	private function __construct() {
53	add_action( 'jetpack_modules_loaded', array( $this, 'action_jetpack_modules_loaded' ) );
54
55	add_action( 'admin_init', array( $this, 'action_admin_init' ), 11 );
56
57	add_action( 'after_setup_theme', array( $this, 'action_after_setup_theme' ), 5 );
58
59	add_filter( 'infinite_scroll_js_settings', array( $this, 'filter_infinite_scroll_js_settings' ) );
60
61	add_action( 'wp_enqueue_scripts', array( $this, 'action_wp_enqueue_scripts' ) );
62	}
63
64	/**
65	* Enable "Configure" button on module card
66	*
67	* @uses Jetpack::enable_module_configurable
68	* @action jetpack_modules_loaded
69	*/
70	public function action_jetpack_modules_loaded() {
71	Jetpack::enable_module_configurable( __FILE__ );
72	}
73
74	/**
75	* Register Google Analytics setting
76	*
77	* @uses add_settings_field, __, register_setting
78	* @action admin_init
79	*/
80	public function action_admin_init() {
81	if ( ! Jetpack_Plan::supports( 'google-analytics' ) ) {
82	return;
83	}
84
85	add_settings_field( $this->option_name_google_analytics, '<span id="infinite-scroll-google-analytics">' . __( 'Use Google Analytics with Infinite Scroll', 'jetpack' ) . '</span>', array( $this, 'setting_google_analytics' ), 'reading' );
86	register_setting( 'reading', $this->option_name_google_analytics, array( $this, 'sanitize_boolean_value' ) );
87	}
88
89	/**
90	* Render Google Analytics option
91	*
92	* @uses checked, get_option, __
93	*/
94	public function setting_google_analytics() {
95	echo '<label><input name="infinite_scroll_google_analytics" type="checkbox" value="1" ' . checked( true, (bool) get_option( $this->option_name_google_analytics, false ), false ) . ' /> ' . esc_html__( 'Track each scroll load (7 posts by default) as a page view in Google Analytics', 'jetpack' ) . '</label>';
96	echo '<p class="description">' . esc_html__( 'Check the box above to record each new set of posts loaded via Infinite Scroll as a page view in Google Analytics.', 'jetpack' ) . '</p>';
97	}
98
99	/**
100	* Sanitize value as a boolean
101	*
102	* @param mixed $value - the value we're sanitizing.
103	* @return bool
104	*/
105	public function sanitize_boolean_value( $value ) {
106	return (bool) $value;
107	}
108
109	/**
110	* Load theme's infinite scroll annotation file, if present in the IS plugin.
111	* The `setup_theme` action is used because the annotation files should be using `after_setup_theme` to register support for IS.
112	*
113	* As released in Jetpack 2.0, a child theme's parent wasn't checked for in the plugin's bundled support, hence the convoluted way the parent is checked for now.
114	*
115	* @uses is_admin, wp_get_theme, apply_filters
116	* @action setup_theme
117	* @return null
118	*/
119	public function action_after_setup_theme() {
120	$theme = wp_get_theme();
121
122	if ( ! $theme instanceof WP_Theme && ! is_array( $theme ) ) {
123	return;
124	}
125
126	/** This filter is already documented in modules/infinite-scroll/infinity.php */
127	$customization_file = apply_filters( 'infinite_scroll_customization_file', __DIR__ . "/infinite-scroll/themes/{$theme['Stylesheet']}.php", $theme['Stylesheet'] );
128
129	if ( is_readable( $customization_file ) ) {
130	require_once $customization_file;
131	} elseif ( ! empty( $theme['Template'] ) ) {
132	$customization_file = __DIR__ . "/infinite-scroll/themes/{$theme['Template']}.php";
133
134	if ( is_readable( $customization_file ) ) {
135	require_once $customization_file;
136	}
137	}
138	}
139
140	/**
141	* Modify Infinite Scroll configuration information
142	*
143	* @uses Jetpack::get_active_modules, is_user_logged_in, stats_get_options, Jetpack_Options::get_option, get_option, JETPACK__API_VERSION, JETPACK__VERSION
144	* @filter infinite_scroll_js_settings
145	*
146	* @param array $settings - the settings.
147	* @return array
148	*/
149	public function filter_infinite_scroll_js_settings( $settings ) {
150	// Provide WP Stats info for tracking Infinite Scroll loads
151	// Abort if Stats module isn't active
152	if ( in_array( 'stats', Jetpack::get_active_modules(), true ) ) {
153	// Abort if user is logged in but logged-in users shouldn't be tracked.
154	if ( is_user_logged_in() ) {
155	$stats_options = Stats_Options::get_options();
156	$track_loggedin_users = isset( $stats_options['count_roles'] ) ? (bool) $stats_options['count_roles'] : false;
157
158	if ( ! $track_loggedin_users ) {
159	return $settings;
160	}
161	}
162
163	// We made it this far, so gather the data needed to track IS views
164	$settings['stats'] = 'blog=' . Jetpack_Options::get_option( 'id' ) . '&host=' . wp_parse_url( get_option( 'home' ), PHP_URL_HOST ) . '&v=ext&j=' . JETPACK__API_VERSION . ':' . JETPACK__VERSION;
165
166	// Pagetype parameter
167	$settings['stats'] .= '&x_pagetype=infinite';
168	if ( 'click' === $settings['type'] ) {
169	$settings['stats'] .= '-click';
170	}
171
172	$settings['stats'] .= '-jetpack';
173	}
174
175	// Check if Google Analytics tracking is requested.
176	$settings['google_analytics'] = Jetpack_Plan::supports( 'google-analytics' ) && Jetpack_Options::get_option_and_ensure_autoload( $this->option_name_google_analytics, 0 );
177
178	return $settings;
179	}
180
181	/**
182	* Always load certain scripts when IS is enabled, as they can't be loaded after `document.ready` fires, meaning they can't leverage IS's script loader.
183	*
184	* @global $videopress
185	* @uses do_action()
186	* @uses apply_filters()
187	* @uses wp_enqueue_style()
188	* @uses wp_enqueue_script()
189	* @action wp_enqueue_scripts
190	* @return null
191	*/
192	public function action_wp_enqueue_scripts() {
193	// Do not load scripts and styles on singular pages and static pages
194	$load_scripts_and_styles = ! ( is_singular() \|\| is_page() );
195	if (
196	/**
197	* Allow plugins to enqueue all Infinite Scroll scripts and styles on singular pages as well.
198	*
199	* @module infinite-scroll
200	*
201	* @since 3.1.0
202	*
203	* @param bool $load_scripts_and_styles Should scripts and styles be loaded on singular pahes and static pages. Default to false.
204	*/
205	! apply_filters( 'jetpack_infinite_scroll_load_scripts_and_styles', $load_scripts_and_styles )
206	) {
207	return;
208	}
209
210	// VideoPress stand-alone plugin
211	global $videopress;
212	if ( ! empty( $videopress ) && The_Neverending_Home_Page::archive_supports_infinity() && is_a( $videopress, 'VideoPress' ) && method_exists( $videopress, 'enqueue_scripts' ) ) {
213	$videopress->enqueue_scripts();
214	}
215
216	// VideoPress Jetpack module
217	if ( Jetpack::is_module_active( 'videopress' ) ) {
218	wp_enqueue_script( 'videopress' );
219	}
220
221	// Fire the post_gallery action early so Carousel scripts are present.
222	if ( Jetpack::is_module_active( 'carousel' ) ) {
223	/** This filter is already documented in core/wp-includes/media.php */
224	do_action( 'post_gallery', '', '', 0 );
225	}
226
227	// Always enqueue Tiled Gallery scripts when both IS and Tiled Galleries are enabled
228	if ( Jetpack::is_module_active( 'tiled-gallery' ) ) {
229	Jetpack_Tiled_Gallery::default_scripts_and_styles();
230	}
231	}
232	}
233	Jetpack_Infinite_Scroll_Extras::instance();
234
235	/**
236	* Load main IS file
237	*/
238	require_once __DIR__ . '/infinite-scroll/infinity.php';
239
240	/**
241	* Remove the IS annotation loading function bundled with the IS plugin in favor of the Jetpack-specific version in Jetpack_Infinite_Scroll_Extras::action_after_setup_theme();
242	*/
243	remove_action( 'after_setup_theme', 'the_neverending_home_page_theme_support', 5 );
244