← All changes | modules/infinite-scroll.php +248 -0 16.2-beta → 16.3 View file →

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