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