jetpack-carousel-rtl.css
2 years ago
jetpack-carousel.css
3 years ago
jetpack-carousel.js
1 year ago
jetpack-carousel.php
1 year ago
readme.md
5 years ago
swiper-bundle.css
5 years ago
swiper-bundle.js
4 years ago
jetpack-carousel.php
1530 lines
| 1 | <?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName |
| 2 | /** |
| 3 | * Module: Jetpack Carousel |
| 4 | * |
| 5 | * @package automattic/jetpack |
| 6 | */ |
| 7 | |
| 8 | use Automattic\Jetpack\Assets; |
| 9 | use Automattic\Jetpack\Stats\Options as Stats_Options; |
| 10 | use Automattic\Jetpack\Status; |
| 11 | /** |
| 12 | * Jetpack_Carousel class. |
| 13 | */ |
| 14 | class Jetpack_Carousel { |
| 15 | /** |
| 16 | * Defines Carousel pre-built widths |
| 17 | * |
| 18 | * @var array |
| 19 | */ |
| 20 | public $prebuilt_widths = array( 370, 700, 1000, 1200, 1400, 2000 ); |
| 21 | |
| 22 | /** |
| 23 | * Localization strings and other data for the JavaScript |
| 24 | * |
| 25 | * @var array |
| 26 | */ |
| 27 | public $localize_strings; |
| 28 | |
| 29 | /** |
| 30 | * Represents whether or not this is the first load of Carousel on a page. Default is true. |
| 31 | * |
| 32 | * @var bool |
| 33 | */ |
| 34 | public $first_run = true; |
| 35 | |
| 36 | /** |
| 37 | * Determines whether or not to set in the gallery. Default is false. |
| 38 | * |
| 39 | * @deprecated since 10.8 |
| 40 | * |
| 41 | * @var bool |
| 42 | */ |
| 43 | public $in_gallery = false; |
| 44 | |
| 45 | /** |
| 46 | * Determines whether the Jetpack class and method exists. Default is true. |
| 47 | * |
| 48 | * @var bool |
| 49 | */ |
| 50 | public $in_jetpack = true; |
| 51 | |
| 52 | /** |
| 53 | * Determines whether or not a single image gallery is enabled. Default is false. |
| 54 | * |
| 55 | * @var bool |
| 56 | */ |
| 57 | public $single_image_gallery_enabled = false; |
| 58 | |
| 59 | /** |
| 60 | * Determines whether images that link to themselves should be replaced with a one image gallery. Default is false. |
| 61 | * |
| 62 | * @var bool |
| 63 | */ |
| 64 | public $single_image_gallery_enabled_media_file = false; |
| 65 | |
| 66 | /** |
| 67 | * Constructor. |
| 68 | */ |
| 69 | public function __construct() { |
| 70 | add_action( 'init', array( $this, 'init' ) ); |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Initialize class |
| 75 | */ |
| 76 | public function init() { |
| 77 | if ( $this->maybe_disable_jp_carousel() ) { |
| 78 | return; |
| 79 | } |
| 80 | |
| 81 | $this->in_jetpack = ( class_exists( 'Jetpack' ) && method_exists( 'Jetpack', 'enable_module_configurable' ) ) ? true : false; |
| 82 | |
| 83 | $this->single_image_gallery_enabled = ! $this->maybe_disable_jp_carousel_single_images(); |
| 84 | $this->single_image_gallery_enabled_media_file = $this->maybe_enable_jp_carousel_single_images_media_file(); |
| 85 | |
| 86 | if ( is_admin() ) { |
| 87 | // Register the Carousel-related related settings. |
| 88 | add_action( 'admin_init', array( $this, 'register_settings' ), 5 ); |
| 89 | if ( ! $this->in_jetpack ) { |
| 90 | if ( 0 === $this->test_1or0_option( get_option( 'carousel_enable_it' ), true ) ) { |
| 91 | return; // Carousel disabled, abort early, but still register setting so user can switch it back on. |
| 92 | } |
| 93 | } |
| 94 | // If in admin, register the ajax endpoints. |
| 95 | add_action( 'wp_ajax_get_attachment_comments', array( $this, 'get_attachment_comments' ) ); |
| 96 | add_action( 'wp_ajax_nopriv_get_attachment_comments', array( $this, 'get_attachment_comments' ) ); |
| 97 | add_action( 'wp_ajax_post_attachment_comment', array( $this, 'post_attachment_comment' ) ); |
| 98 | add_action( 'wp_ajax_nopriv_post_attachment_comment', array( $this, 'post_attachment_comment' ) ); |
| 99 | |
| 100 | // Disable core lightbox when Carousel is enabled. |
| 101 | add_action( 'wp_theme_json_data_theme', array( $this, 'disable_core_lightbox' ) ); |
| 102 | } else { |
| 103 | if ( ! $this->in_jetpack ) { |
| 104 | if ( 0 === $this->test_1or0_option( get_option( 'carousel_enable_it' ), true ) ) { |
| 105 | return; // Carousel disabled, abort early. |
| 106 | } |
| 107 | } |
| 108 | // If on front-end, do the Carousel thang. |
| 109 | /** |
| 110 | * Filter the array of default prebuilt widths used in Carousel. |
| 111 | * |
| 112 | * @module carousel |
| 113 | * |
| 114 | * @since 1.6.0 |
| 115 | * |
| 116 | * @param array $this->prebuilt_widths Array of default widths. |
| 117 | */ |
| 118 | $this->prebuilt_widths = apply_filters( 'jp_carousel_widths', $this->prebuilt_widths ); |
| 119 | // below: load later than other callbacks hooked it (e.g. 3rd party plugins handling gallery shortcode). |
| 120 | add_filter( 'post_gallery', array( $this, 'check_if_shortcode_processed_and_enqueue_assets' ), 1000, 2 ); |
| 121 | add_filter( 'post_gallery', array( $this, 'set_in_gallery' ), -1000 ); |
| 122 | add_filter( 'gallery_style', array( $this, 'add_data_to_container' ) ); |
| 123 | add_filter( 'wp_get_attachment_image_attributes', array( $this, 'add_data_to_images' ), 10, 2 ); |
| 124 | add_filter( 'jetpack_tiled_galleries_block_content', array( $this, 'add_data_img_tags_and_enqueue_assets' ) ); |
| 125 | if ( $this->single_image_gallery_enabled ) { |
| 126 | add_filter( 'the_content', array( $this, 'add_data_img_tags_and_enqueue_assets' ) ); |
| 127 | } |
| 128 | |
| 129 | // `is_amp_request()` can't be called until the 'wp' filter. |
| 130 | add_action( 'wp', array( $this, 'check_amp_support' ) ); |
| 131 | |
| 132 | // Disable core lightbox when Carousel is enabled. |
| 133 | add_action( 'wp_theme_json_data_theme', array( $this, 'disable_core_lightbox' ) ); |
| 134 | } |
| 135 | |
| 136 | if ( $this->in_jetpack ) { |
| 137 | Jetpack::enable_module_configurable( dirname( __DIR__ ) . '/carousel.php' ); |
| 138 | } |
| 139 | } |
| 140 | |
| 141 | /** |
| 142 | * Check AMP and add filters. |
| 143 | */ |
| 144 | public function check_amp_support() { |
| 145 | if ( |
| 146 | ! class_exists( 'Jetpack_AMP_Support' ) |
| 147 | || ! Jetpack_AMP_Support::is_amp_request() |
| 148 | ) { |
| 149 | add_filter( 'render_block_core/gallery', array( $this, 'filter_gallery_block_render' ), 10, 2 ); |
| 150 | add_filter( 'render_block_jetpack/tiled-gallery', array( $this, 'filter_gallery_block_render' ), 10, 2 ); |
| 151 | } |
| 152 | } |
| 153 | |
| 154 | /** |
| 155 | * Returns the value of the applied jp_carousel_maybe_disable filter |
| 156 | * |
| 157 | * @since 1.6.0 |
| 158 | * |
| 159 | * @return bool - Should Carousel be disabled? Default to false. |
| 160 | */ |
| 161 | public function maybe_disable_jp_carousel() { |
| 162 | /** |
| 163 | * Allow third-party plugins or themes to disable Carousel. |
| 164 | * |
| 165 | * @module carousel |
| 166 | * |
| 167 | * @since 1.6.0 |
| 168 | * |
| 169 | * @param bool false Should Carousel be disabled? Default to false. |
| 170 | */ |
| 171 | return apply_filters( 'jp_carousel_maybe_disable', false ); |
| 172 | } |
| 173 | |
| 174 | /** |
| 175 | * Returns the value of the applied jp_carousel_maybe_disable_single_images filter |
| 176 | * |
| 177 | * @since 4.5.0 |
| 178 | * |
| 179 | * @return bool - Should Carousel be disabled for single images? Default to false. |
| 180 | */ |
| 181 | public function maybe_disable_jp_carousel_single_images() { |
| 182 | /** |
| 183 | * Allow third-party plugins or themes to disable Carousel for single images. |
| 184 | * |
| 185 | * @module carousel |
| 186 | * |
| 187 | * @since 4.5.0 |
| 188 | * |
| 189 | * @param bool false Should Carousel be disabled for single images? Default to false. |
| 190 | */ |
| 191 | return apply_filters( 'jp_carousel_maybe_disable_single_images', false ); |
| 192 | } |
| 193 | |
| 194 | /** |
| 195 | * Returns the value of the applied jp_carousel_load_for_images_linked_to_file filter |
| 196 | * |
| 197 | * @since 4.5.0 |
| 198 | * |
| 199 | * @return bool - Should Carousel be enabled for single images linking to 'Media File'? Default to false. |
| 200 | */ |
| 201 | public function maybe_enable_jp_carousel_single_images_media_file() { |
| 202 | /** |
| 203 | * Allow third-party plugins or themes to enable Carousel |
| 204 | * for single images linking to 'Media File' (full size image). |
| 205 | * |
| 206 | * @module carousel |
| 207 | * |
| 208 | * @since 4.5.0 |
| 209 | * |
| 210 | * @param bool false Should Carousel be enabled for single images linking to 'Media File'? Default to false. |
| 211 | */ |
| 212 | return apply_filters( 'jp_carousel_load_for_images_linked_to_file', false ); |
| 213 | } |
| 214 | |
| 215 | /** |
| 216 | * Disable the "Lightbox" option offered in WordPress core |
| 217 | * whenever Jetpack's Carousel feature is enabled. |
| 218 | * |
| 219 | * @since 13.3 |
| 220 | * |
| 221 | * @param WP_Theme_JSON_Data $theme_json Class to access and update theme.json data. |
| 222 | */ |
| 223 | public function disable_core_lightbox( $theme_json ) { |
| 224 | return $theme_json->update_with( |
| 225 | array( |
| 226 | 'version' => 2, |
| 227 | 'settings' => array( |
| 228 | 'blocks' => array( |
| 229 | 'core/image' => array( |
| 230 | 'lightbox' => array( |
| 231 | 'allowEditing' => false, |
| 232 | 'enabled' => false, |
| 233 | ), |
| 234 | ), |
| 235 | ), |
| 236 | ), |
| 237 | ) |
| 238 | ); |
| 239 | } |
| 240 | |
| 241 | /** |
| 242 | * Returns the value of the applied jp_carousel_asset_version filter |
| 243 | * |
| 244 | * @since 1.6.0 |
| 245 | * |
| 246 | * @param string $version Asset version. |
| 247 | * |
| 248 | * @return string |
| 249 | */ |
| 250 | public function asset_version( $version ) { |
| 251 | /** |
| 252 | * Filter the version string used when enqueuing Carousel assets. |
| 253 | * |
| 254 | * @module carousel |
| 255 | * |
| 256 | * @since 1.6.0 |
| 257 | * |
| 258 | * @param string $version Asset version. |
| 259 | */ |
| 260 | return apply_filters( 'jp_carousel_asset_version', $version ); |
| 261 | } |
| 262 | |
| 263 | /** |
| 264 | * Displays a message on top of gallery if carousel has bailed. |
| 265 | * |
| 266 | * @param string $output Gallery shortcode output. |
| 267 | * |
| 268 | * @return string Shortcode output with bail message prepended. |
| 269 | */ |
| 270 | public function display_bail_message( $output = '' ) { |
| 271 | $message = '<div class="jp-carousel-msg"><p>'; |
| 272 | $message .= __( 'Jetpack\'s Carousel has been disabled, because another plugin or your theme is overriding the [gallery] shortcode.', 'jetpack' ); |
| 273 | $message .= '</p></div>'; |
| 274 | // put before gallery output. |
| 275 | $output = $message . $output; |
| 276 | return $output; |
| 277 | } |
| 278 | |
| 279 | /** |
| 280 | * Determine whether Carousel is enabled, and adjust filters and enqueue assets accordingly. |
| 281 | * |
| 282 | * If no other filter hook produced output for the gallery shortcode or something returns true for |
| 283 | * the `jp_carousel_force_enable` filter, Carousel is enabled and we queue our assets. Otherwise |
| 284 | * it's disabled and we remove some of our subsequent filter hooks. |
| 285 | * |
| 286 | * @since 1.9.0 |
| 287 | * |
| 288 | * @param string $output Gallery shortcode output. |
| 289 | * |
| 290 | * @return string Gallery shortcode output. |
| 291 | */ |
| 292 | public function check_if_shortcode_processed_and_enqueue_assets( $output ) { |
| 293 | if ( |
| 294 | class_exists( 'Jetpack_AMP_Support' ) |
| 295 | && Jetpack_AMP_Support::is_amp_request() |
| 296 | ) { |
| 297 | return $output; |
| 298 | } |
| 299 | |
| 300 | if ( |
| 301 | ! empty( $output ) && |
| 302 | /** |
| 303 | * Allow third-party plugins or themes to force-enable Carousel. |
| 304 | * |
| 305 | * @module carousel |
| 306 | * |
| 307 | * @since 1.9.0 |
| 308 | * |
| 309 | * @param bool false Should we force enable Carousel? Default to false. |
| 310 | */ |
| 311 | ! apply_filters( 'jp_carousel_force_enable', false ) |
| 312 | ) { |
| 313 | // Bail because someone is overriding the [gallery] shortcode. |
| 314 | remove_filter( 'gallery_style', array( $this, 'add_data_to_container' ) ); |
| 315 | remove_filter( 'wp_get_attachment_image_attributes', array( $this, 'add_data_to_images' ) ); |
| 316 | remove_filter( 'the_content', array( $this, 'add_data_img_tags_and_enqueue_assets' ) ); |
| 317 | // Display message that carousel has bailed, if user is super_admin, and if we're not on WordPress.com. |
| 318 | if ( |
| 319 | is_super_admin() && |
| 320 | ! ( defined( 'IS_WPCOM' ) && IS_WPCOM ) |
| 321 | ) { |
| 322 | add_filter( 'post_gallery', array( $this, 'display_bail_message' ) ); |
| 323 | } |
| 324 | return $output; |
| 325 | } |
| 326 | |
| 327 | /** |
| 328 | * Fires when thumbnails are shown in Carousel. |
| 329 | * |
| 330 | * @module carousel |
| 331 | * |
| 332 | * @since 1.6.0 |
| 333 | */ |
| 334 | do_action( 'jp_carousel_thumbnails_shown' ); |
| 335 | |
| 336 | $this->enqueue_assets(); |
| 337 | |
| 338 | return $output; |
| 339 | } |
| 340 | |
| 341 | /** |
| 342 | * Check if the content of a post uses gallery blocks. To be used by 'the_content' filter. |
| 343 | * |
| 344 | * @since 6.8.0 |
| 345 | * @deprecated since 11.3 We now hook into the 'block_render_{block_name}' hook to add markup. |
| 346 | * |
| 347 | * @param string $content Post content. |
| 348 | * |
| 349 | * @return string $content Post content. |
| 350 | */ |
| 351 | public function check_content_for_blocks( $content ) { |
| 352 | _deprecated_function( __METHOD__, 'jetpack-11.3' ); |
| 353 | |
| 354 | if ( |
| 355 | class_exists( 'Jetpack_AMP_Support' ) |
| 356 | && Jetpack_AMP_Support::is_amp_request() |
| 357 | ) { |
| 358 | return $content; |
| 359 | } |
| 360 | |
| 361 | if ( has_block( 'gallery', $content ) || has_block( 'jetpack/tiled-gallery', $content ) ) { |
| 362 | $this->enqueue_assets(); |
| 363 | $content = $this->add_data_to_container( $content ); |
| 364 | } |
| 365 | |
| 366 | return $content; |
| 367 | } |
| 368 | |
| 369 | /** |
| 370 | * Enrich the gallery block content using the render_block_{$this->name} filter. |
| 371 | * This function is triggered after block render to make sure we track galleries within |
| 372 | * reusable blocks. |
| 373 | * |
| 374 | * @see https://developer.wordpress.org/reference/hooks/render_block_this-name/ |
| 375 | * |
| 376 | * @param string $block_content The rendered HTML for the carousel or gallery block. |
| 377 | * @param array $block The parsed block details for the block. |
| 378 | * @return string The fully-processed HTML for the carousel or gallery block. |
| 379 | * |
| 380 | * @since 11.3 |
| 381 | */ |
| 382 | public function filter_gallery_block_render( $block_content, $block ) { |
| 383 | global $post; |
| 384 | |
| 385 | if ( empty( $block['blockName'] ) || ! in_array( $block['blockName'], array( 'core/gallery', 'jetpack/tiled-gallery' ), true ) ) { |
| 386 | return $block_content; |
| 387 | } |
| 388 | |
| 389 | $this->enqueue_assets(); |
| 390 | |
| 391 | if ( ! isset( $post ) ) { |
| 392 | return $block_content; |
| 393 | } |
| 394 | |
| 395 | $blog_id = (int) get_current_blog_id(); |
| 396 | |
| 397 | $extra_data = array( |
| 398 | 'data-carousel-extra' => array( |
| 399 | 'blog_id' => $blog_id, |
| 400 | 'permalink' => get_permalink( $post->ID ), |
| 401 | ), |
| 402 | ); |
| 403 | |
| 404 | /** |
| 405 | * Filter the data added to the Gallery container. |
| 406 | * |
| 407 | * @module carousel |
| 408 | * |
| 409 | * @since 1.6.0 |
| 410 | * |
| 411 | * @param array $extra_data Array of data about the site and the post. |
| 412 | */ |
| 413 | $extra_data = apply_filters( 'jp_carousel_add_data_to_container', $extra_data ); |
| 414 | $extra_data = (array) $extra_data; |
| 415 | |
| 416 | if ( empty( $extra_data ) ) { |
| 417 | return $block_content; |
| 418 | } |
| 419 | |
| 420 | $extra_attributes = implode( |
| 421 | ' ', |
| 422 | array_map( |
| 423 | function ( $data_key, $data_values ) { |
| 424 | return esc_attr( $data_key ) . "='" . wp_json_encode( $data_values ) . "'"; |
| 425 | }, |
| 426 | array_keys( $extra_data ), |
| 427 | array_values( $extra_data ) |
| 428 | ) |
| 429 | ); |
| 430 | |
| 431 | // Add extra attributes to first HTML element (which may have leading whitespace) |
| 432 | return preg_replace( |
| 433 | '/^(\s*<(div|ul|figure))/', |
| 434 | '$1 ' . $extra_attributes . ' ', |
| 435 | $block_content, |
| 436 | 1 |
| 437 | ); |
| 438 | } |
| 439 | |
| 440 | /** |
| 441 | * Enqueueing Carousel assets. |
| 442 | */ |
| 443 | public function enqueue_assets() { |
| 444 | if ( $this->first_run ) { |
| 445 | wp_enqueue_script( |
| 446 | 'jetpack-carousel', |
| 447 | Assets::get_file_url_for_environment( |
| 448 | '_inc/build/carousel/jetpack-carousel.min.js', |
| 449 | 'modules/carousel/jetpack-carousel.js' |
| 450 | ), |
| 451 | array(), |
| 452 | $this->asset_version( JETPACK__VERSION ), |
| 453 | true |
| 454 | ); |
| 455 | |
| 456 | $swiper_library_path = array( |
| 457 | 'url' => Assets::get_file_url_for_environment( |
| 458 | '_inc/build/carousel/swiper-bundle.min.js', |
| 459 | 'modules/carousel/swiper-bundle.js' |
| 460 | ), |
| 461 | ); |
| 462 | wp_localize_script( 'jetpack-carousel', 'jetpackSwiperLibraryPath', $swiper_library_path ); |
| 463 | |
| 464 | // Note: using home_url() instead of admin_url() for ajaxurl to be sure to get same domain on wpcom when using mapped domains (also works on self-hosted). |
| 465 | // Also: not hardcoding path since there is no guarantee site is running on site root in self-hosted context. |
| 466 | $is_logged_in = is_user_logged_in(); |
| 467 | $comment_registration = (int) get_option( 'comment_registration' ); |
| 468 | $require_name_email = (int) get_option( 'require_name_email' ); |
| 469 | $localize_strings = array( |
| 470 | 'widths' => $this->prebuilt_widths, |
| 471 | 'is_logged_in' => $is_logged_in, |
| 472 | 'lang' => strtolower( substr( get_locale(), 0, 2 ) ), |
| 473 | 'ajaxurl' => set_url_scheme( admin_url( 'admin-ajax.php' ) ), |
| 474 | 'nonce' => wp_create_nonce( 'carousel_nonce' ), |
| 475 | 'display_exif' => $this->test_1or0_option( Jetpack_Options::get_option_and_ensure_autoload( 'carousel_display_exif', true ) ), |
| 476 | 'display_comments' => $this->test_1or0_option( Jetpack_Options::get_option_and_ensure_autoload( 'carousel_display_comments', true ) ), |
| 477 | 'single_image_gallery' => $this->single_image_gallery_enabled, |
| 478 | 'single_image_gallery_media_file' => $this->single_image_gallery_enabled_media_file, |
| 479 | 'background_color' => $this->carousel_background_color_sanitize( Jetpack_Options::get_option_and_ensure_autoload( 'carousel_background_color', '' ) ), |
| 480 | 'comment' => __( 'Comment', 'jetpack' ), |
| 481 | 'post_comment' => __( 'Post Comment', 'jetpack' ), |
| 482 | 'write_comment' => __( 'Write a Comment...', 'jetpack' ), |
| 483 | 'loading_comments' => __( 'Loading Comments...', 'jetpack' ), |
| 484 | 'image_label' => __( 'Open image in full-screen.', 'jetpack' ), |
| 485 | 'download_original' => sprintf( |
| 486 | /* translators: %1s is the full-size image width, and %2s is the height. */ |
| 487 | __( 'View full size <span class="photo-size">%1$s<span class="photo-size-times">×</span>%2$s</span>', 'jetpack' ), |
| 488 | '{0}', |
| 489 | '{1}' |
| 490 | ), |
| 491 | 'no_comment_text' => __( 'Please be sure to submit some text with your comment.', 'jetpack' ), |
| 492 | 'no_comment_email' => __( 'Please provide an email address to comment.', 'jetpack' ), |
| 493 | 'no_comment_author' => __( 'Please provide your name to comment.', 'jetpack' ), |
| 494 | 'comment_post_error' => __( 'Sorry, but there was an error posting your comment. Please try again later.', 'jetpack' ), |
| 495 | 'comment_approved' => __( 'Your comment was approved.', 'jetpack' ), |
| 496 | 'comment_unapproved' => __( 'Your comment is in moderation.', 'jetpack' ), |
| 497 | 'camera' => __( 'Camera', 'jetpack' ), |
| 498 | 'aperture' => __( 'Aperture', 'jetpack' ), |
| 499 | 'shutter_speed' => __( 'Shutter Speed', 'jetpack' ), |
| 500 | 'focal_length' => __( 'Focal Length', 'jetpack' ), |
| 501 | 'copyright' => __( 'Copyright', 'jetpack' ), |
| 502 | 'comment_registration' => $comment_registration, |
| 503 | 'require_name_email' => $require_name_email, |
| 504 | /** This action is documented in core/src/wp-includes/link-template.php */ |
| 505 | 'login_url' => wp_login_url( apply_filters( 'the_permalink', get_permalink() ) ), |
| 506 | 'blog_id' => (int) get_current_blog_id(), |
| 507 | 'meta_data' => array( 'camera', 'aperture', 'shutter_speed', 'focal_length', 'copyright' ), |
| 508 | ); |
| 509 | |
| 510 | /** |
| 511 | * Handle WP stats for images in full-screen. |
| 512 | * Build string with tracking info. |
| 513 | */ |
| 514 | |
| 515 | /** |
| 516 | * Filter if Jetpack should enable stats collection on carousel views |
| 517 | * |
| 518 | * @module carousel |
| 519 | * |
| 520 | * @since 4.3.2 |
| 521 | * |
| 522 | * @param bool Enable Jetpack Carousel stat collection. Default false. |
| 523 | */ |
| 524 | if ( apply_filters( 'jetpack_enable_carousel_stats', false ) && in_array( 'stats', Jetpack::get_active_modules(), true ) && ! ( new Status() )->is_offline_mode() ) { |
| 525 | $localize_strings['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; |
| 526 | |
| 527 | // Set the stats as empty if user is logged in but logged-in users shouldn't be tracked. |
| 528 | if ( is_user_logged_in() ) { |
| 529 | $stats_options = Stats_Options::get_options(); |
| 530 | $track_loggedin_users = isset( $stats_options['count_roles'] ) ? (bool) $stats_options['count_roles'] : false; |
| 531 | |
| 532 | if ( ! $track_loggedin_users ) { |
| 533 | $localize_strings['stats'] = ''; |
| 534 | } |
| 535 | } |
| 536 | } |
| 537 | |
| 538 | /** |
| 539 | * Filter the strings passed to the Carousel's js file. |
| 540 | * |
| 541 | * @module carousel |
| 542 | * |
| 543 | * @since 1.6.0 |
| 544 | * |
| 545 | * @param array $localize_strings Array of strings passed to the Jetpack js file. |
| 546 | */ |
| 547 | $localize_strings = apply_filters( 'jp_carousel_localize_strings', $localize_strings ); |
| 548 | wp_localize_script( 'jetpack-carousel', 'jetpackCarouselStrings', $localize_strings ); |
| 549 | wp_enqueue_style( |
| 550 | 'jetpack-carousel-swiper-css', |
| 551 | plugins_url( 'swiper-bundle.css', __FILE__ ), |
| 552 | array(), |
| 553 | $this->asset_version( JETPACK__VERSION ) |
| 554 | ); |
| 555 | wp_enqueue_style( 'jetpack-carousel', plugins_url( 'jetpack-carousel.css', __FILE__ ), array(), $this->asset_version( JETPACK__VERSION ) ); |
| 556 | wp_style_add_data( 'jetpack-carousel', 'rtl', 'replace' ); |
| 557 | |
| 558 | /** |
| 559 | * Fires after carousel assets are enqueued for the first time. |
| 560 | * Allows for adding additional assets to the carousel page. |
| 561 | * |
| 562 | * @module carousel |
| 563 | * |
| 564 | * @since 1.6.0 |
| 565 | * |
| 566 | * @param bool $first_run First load if Carousel on the page. |
| 567 | * @param array $localized_strings Array of strings passed to the Jetpack js file. |
| 568 | */ |
| 569 | do_action( 'jp_carousel_enqueue_assets', $this->first_run, $localize_strings ); |
| 570 | |
| 571 | // Add the carousel skeleton to the page. |
| 572 | $this->localize_strings = $localize_strings; |
| 573 | add_action( 'wp_footer', array( $this, 'add_carousel_skeleton' ) ); |
| 574 | |
| 575 | $this->first_run = false; |
| 576 | } |
| 577 | } |
| 578 | |
| 579 | /** |
| 580 | * Generate the HTML skeleton that will be picked up by the Carousel JS and used for showing the carousel. |
| 581 | */ |
| 582 | public function add_carousel_skeleton() { |
| 583 | $localize_strings = $this->localize_strings; |
| 584 | $is_light = ( 'white' === $localize_strings['background_color'] ); |
| 585 | // Determine whether to fall back to standard local comments. |
| 586 | $use_local_comments = ! isset( $localize_strings['jetpack_comments_iframe_src'] ) || empty( $localize_strings['jetpack_comments_iframe_src'] ); |
| 587 | $current_user = wp_get_current_user(); |
| 588 | $require_name_email = (int) get_option( 'require_name_email' ); |
| 589 | /* translators: %s is replaced with a field name in the form, e.g. "Email" */ |
| 590 | $required = ( $require_name_email ) ? __( '%s (Required)', 'jetpack' ) : '%s'; |
| 591 | ?> |
| 592 | <div id="jp-carousel-loading-overlay"> |
| 593 | <div id="jp-carousel-loading-wrapper"> |
| 594 | <span id="jp-carousel-library-loading"> </span> |
| 595 | </div> |
| 596 | </div> |
| 597 | <div class="jp-carousel-overlay<?php echo( $is_light ? ' jp-carousel-light' : '' ); ?>" style="display: none;"> |
| 598 | |
| 599 | <div class="jp-carousel-container<?php echo( $is_light ? ' jp-carousel-light' : '' ); ?>"> |
| 600 | <!-- The Carousel Swiper --> |
| 601 | <div |
| 602 | class="jp-carousel-wrap swiper-container jp-carousel-swiper-container jp-carousel-transitions" |
| 603 | itemscope |
| 604 | itemtype="https://schema.org/ImageGallery"> |
| 605 | <div class="jp-carousel swiper-wrapper"></div> |
| 606 | <div class="jp-swiper-button-prev swiper-button-prev"> |
| 607 | <svg width="25" height="24" viewBox="0 0 25 24" fill="none" xmlns="http://www.w3.org/2000/svg"> |
| 608 | <mask id="maskPrev" mask-type="alpha" maskUnits="userSpaceOnUse" x="8" y="6" width="9" height="12"> |
| 609 | <path d="M16.2072 16.59L11.6496 12L16.2072 7.41L14.8041 6L8.8335 12L14.8041 18L16.2072 16.59Z" fill="white"/> |
| 610 | </mask> |
| 611 | <g mask="url(#maskPrev)"> |
| 612 | <rect x="0.579102" width="23.8823" height="24" fill="#FFFFFF"/> |
| 613 | </g> |
| 614 | </svg> |
| 615 | </div> |
| 616 | <div class="jp-swiper-button-next swiper-button-next"> |
| 617 | <svg width="25" height="24" viewBox="0 0 25 24" fill="none" xmlns="http://www.w3.org/2000/svg"> |
| 618 | <mask id="maskNext" mask-type="alpha" maskUnits="userSpaceOnUse" x="8" y="6" width="8" height="12"> |
| 619 | <path d="M8.59814 16.59L13.1557 12L8.59814 7.41L10.0012 6L15.9718 12L10.0012 18L8.59814 16.59Z" fill="white"/> |
| 620 | </mask> |
| 621 | <g mask="url(#maskNext)"> |
| 622 | <rect x="0.34375" width="23.8822" height="24" fill="#FFFFFF"/> |
| 623 | </g> |
| 624 | </svg> |
| 625 | </div> |
| 626 | </div> |
| 627 | <!-- The main close buton --> |
| 628 | <div class="jp-carousel-close-hint"> |
| 629 | <svg width="25" height="24" viewBox="0 0 25 24" fill="none" xmlns="http://www.w3.org/2000/svg"> |
| 630 | <mask id="maskClose" mask-type="alpha" maskUnits="userSpaceOnUse" x="5" y="5" width="15" height="14"> |
| 631 | <path d="M19.3166 6.41L17.9135 5L12.3509 10.59L6.78834 5L5.38525 6.41L10.9478 12L5.38525 17.59L6.78834 19L12.3509 13.41L17.9135 19L19.3166 17.59L13.754 12L19.3166 6.41Z" fill="white"/> |
| 632 | </mask> |
| 633 | <g mask="url(#maskClose)"> |
| 634 | <rect x="0.409668" width="23.8823" height="24" fill="#FFFFFF"/> |
| 635 | </g> |
| 636 | </svg> |
| 637 | </div> |
| 638 | <!-- Image info, comments and meta --> |
| 639 | <div class="jp-carousel-info"> |
| 640 | <div class="jp-carousel-info-footer"> |
| 641 | <div class="jp-carousel-pagination-container"> |
| 642 | <div class="jp-swiper-pagination swiper-pagination"></div> |
| 643 | <div class="jp-carousel-pagination"></div> |
| 644 | </div> |
| 645 | <div class="jp-carousel-photo-title-container"> |
| 646 | <h2 class="jp-carousel-photo-caption"></h2> |
| 647 | </div> |
| 648 | <div class="jp-carousel-photo-icons-container"> |
| 649 | <a href="#" class="jp-carousel-icon-btn jp-carousel-icon-info" aria-label="<?php esc_attr_e( 'Toggle photo metadata visibility', 'jetpack' ); ?>"> |
| 650 | <span class="jp-carousel-icon"> |
| 651 | <svg width="25" height="24" viewBox="0 0 25 24" fill="none" xmlns="http://www.w3.org/2000/svg"> |
| 652 | <mask id="maskInfo" mask-type="alpha" maskUnits="userSpaceOnUse" x="2" y="2" width="21" height="20"> |
| 653 | <path fill-rule="evenodd" clip-rule="evenodd" d="M12.7537 2C7.26076 2 2.80273 6.48 2.80273 12C2.80273 17.52 7.26076 22 12.7537 22C18.2466 22 22.7046 17.52 22.7046 12C22.7046 6.48 18.2466 2 12.7537 2ZM11.7586 7V9H13.7488V7H11.7586ZM11.7586 11V17H13.7488V11H11.7586ZM4.79292 12C4.79292 16.41 8.36531 20 12.7537 20C17.142 20 20.7144 16.41 20.7144 12C20.7144 7.59 17.142 4 12.7537 4C8.36531 4 4.79292 7.59 4.79292 12Z" fill="white"/> |
| 654 | </mask> |
| 655 | <g mask="url(#maskInfo)"> |
| 656 | <rect x="0.8125" width="23.8823" height="24" fill="#FFFFFF"/> |
| 657 | </g> |
| 658 | </svg> |
| 659 | </span> |
| 660 | </a> |
| 661 | <?php if ( $localize_strings['display_comments'] ) : ?> |
| 662 | <a href="#" class="jp-carousel-icon-btn jp-carousel-icon-comments" aria-label="<?php esc_attr_e( 'Toggle photo comments visibility', 'jetpack' ); ?>"> |
| 663 | <span class="jp-carousel-icon"> |
| 664 | <svg width="25" height="24" viewBox="0 0 25 24" fill="none" xmlns="http://www.w3.org/2000/svg"> |
| 665 | <mask id="maskComments" mask-type="alpha" maskUnits="userSpaceOnUse" x="2" y="2" width="21" height="20"> |
| 666 | <path fill-rule="evenodd" clip-rule="evenodd" d="M4.3271 2H20.2486C21.3432 2 22.2388 2.9 22.2388 4V16C22.2388 17.1 21.3432 18 20.2486 18H6.31729L2.33691 22V4C2.33691 2.9 3.2325 2 4.3271 2ZM6.31729 16H20.2486V4H4.3271V18L6.31729 16Z" fill="white"/> |
| 667 | </mask> |
| 668 | <g mask="url(#maskComments)"> |
| 669 | <rect x="0.34668" width="23.8823" height="24" fill="#FFFFFF"/> |
| 670 | </g> |
| 671 | </svg> |
| 672 | |
| 673 | <span class="jp-carousel-has-comments-indicator" aria-label="<?php esc_attr_e( 'This image has comments.', 'jetpack' ); ?>"></span> |
| 674 | </span> |
| 675 | </a> |
| 676 | <?php endif; ?> |
| 677 | </div> |
| 678 | </div> |
| 679 | <div class="jp-carousel-info-extra"> |
| 680 | <div class="jp-carousel-info-content-wrapper"> |
| 681 | <div class="jp-carousel-photo-title-container"> |
| 682 | <h2 class="jp-carousel-photo-title"></h2> |
| 683 | </div> |
| 684 | <div class="jp-carousel-comments-wrapper"> |
| 685 | <?php if ( $localize_strings['display_comments'] ) : ?> |
| 686 | <div id="jp-carousel-comments-loading"> |
| 687 | <span><?php echo esc_html( $localize_strings['loading_comments'] ); ?></span> |
| 688 | </div> |
| 689 | <div class="jp-carousel-comments"></div> |
| 690 | <div id="jp-carousel-comment-form-container"> |
| 691 | <span id="jp-carousel-comment-form-spinner"> </span> |
| 692 | <div id="jp-carousel-comment-post-results"></div> |
| 693 | <?php if ( $use_local_comments ) : ?> |
| 694 | <?php if ( ! $localize_strings['is_logged_in'] && $localize_strings['comment_registration'] ) : ?> |
| 695 | <div id="jp-carousel-comment-form-commenting-as"> |
| 696 | <p id="jp-carousel-commenting-as"> |
| 697 | <?php |
| 698 | echo wp_kses( |
| 699 | __( 'You must be <a href="#" class="jp-carousel-comment-login">logged in</a> to post a comment.', 'jetpack' ), |
| 700 | array( |
| 701 | 'a' => array( |
| 702 | 'href' => array(), |
| 703 | 'class' => array(), |
| 704 | ), |
| 705 | ) |
| 706 | ); |
| 707 | ?> |
| 708 | </p> |
| 709 | </div> |
| 710 | <?php else : ?> |
| 711 | <form id="jp-carousel-comment-form"> |
| 712 | <label for="jp-carousel-comment-form-comment-field" class="screen-reader-text"><?php echo esc_attr( $localize_strings['write_comment'] ); ?></label> |
| 713 | <textarea |
| 714 | name="comment" |
| 715 | class="jp-carousel-comment-form-field jp-carousel-comment-form-textarea" |
| 716 | id="jp-carousel-comment-form-comment-field" |
| 717 | placeholder="<?php echo esc_attr( $localize_strings['write_comment'] ); ?>" |
| 718 | ></textarea> |
| 719 | <div id="jp-carousel-comment-form-submit-and-info-wrapper"> |
| 720 | <div id="jp-carousel-comment-form-commenting-as"> |
| 721 | <?php if ( $localize_strings['is_logged_in'] ) : ?> |
| 722 | <p id="jp-carousel-commenting-as"> |
| 723 | <?php |
| 724 | printf( |
| 725 | /* translators: %s is replaced with the user's display name */ |
| 726 | esc_html__( 'Commenting as %s', 'jetpack' ), |
| 727 | esc_html( $current_user->data->display_name ) |
| 728 | ); |
| 729 | ?> |
| 730 | </p> |
| 731 | <?php else : ?> |
| 732 | <fieldset> |
| 733 | <label for="jp-carousel-comment-form-email-field"><?php echo esc_html( sprintf( $required, __( 'Email', 'jetpack' ) ) ); ?></label> |
| 734 | <input type="text" name="email" class="jp-carousel-comment-form-field jp-carousel-comment-form-text-field" id="jp-carousel-comment-form-email-field" /> |
| 735 | </fieldset> |
| 736 | <fieldset> |
| 737 | <label for="jp-carousel-comment-form-author-field"><?php echo esc_html( sprintf( $required, __( 'Name', 'jetpack' ) ) ); ?></label> |
| 738 | <input type="text" name="author" class="jp-carousel-comment-form-field jp-carousel-comment-form-text-field" id="jp-carousel-comment-form-author-field" /> |
| 739 | </fieldset> |
| 740 | <fieldset> |
| 741 | <label for="jp-carousel-comment-form-url-field"><?php esc_html_e( 'Website', 'jetpack' ); ?></label> |
| 742 | <input type="text" name="url" class="jp-carousel-comment-form-field jp-carousel-comment-form-text-field" id="jp-carousel-comment-form-url-field" /> |
| 743 | </fieldset> |
| 744 | <?php endif ?> |
| 745 | </div> |
| 746 | <input |
| 747 | type="submit" |
| 748 | name="submit" |
| 749 | class="jp-carousel-comment-form-button" |
| 750 | id="jp-carousel-comment-form-button-submit" |
| 751 | value="<?php echo esc_attr( $localize_strings['post_comment'] ); ?>" /> |
| 752 | </div> |
| 753 | </form> |
| 754 | <?php endif ?> |
| 755 | <?php endif ?> |
| 756 | </div> |
| 757 | <?php endif ?> |
| 758 | </div> |
| 759 | <div class="jp-carousel-image-meta"> |
| 760 | <div class="jp-carousel-title-and-caption"> |
| 761 | <div class="jp-carousel-photo-info"> |
| 762 | <h3 class="jp-carousel-caption" itemprop="caption description"></h3> |
| 763 | </div> |
| 764 | |
| 765 | <div class="jp-carousel-photo-description"></div> |
| 766 | </div> |
| 767 | <ul class="jp-carousel-image-exif" style="display: none;"></ul> |
| 768 | <a class="jp-carousel-image-download" href="#" target="_blank" style="display: none;"> |
| 769 | <svg width="25" height="24" viewBox="0 0 25 24" fill="none" xmlns="http://www.w3.org/2000/svg"> |
| 770 | <mask id="mask0" mask-type="alpha" maskUnits="userSpaceOnUse" x="3" y="3" width="19" height="18"> |
| 771 | <path fill-rule="evenodd" clip-rule="evenodd" d="M5.84615 5V19H19.7775V12H21.7677V19C21.7677 20.1 20.8721 21 19.7775 21H5.84615C4.74159 21 3.85596 20.1 3.85596 19V5C3.85596 3.9 4.74159 3 5.84615 3H12.8118V5H5.84615ZM14.802 5V3H21.7677V10H19.7775V6.41L9.99569 16.24L8.59261 14.83L18.3744 5H14.802Z" fill="white"/> |
| 772 | </mask> |
| 773 | <g mask="url(#mask0)"> |
| 774 | <rect x="0.870605" width="23.8823" height="24" fill="#FFFFFF"/> |
| 775 | </g> |
| 776 | </svg> |
| 777 | <span class="jp-carousel-download-text"></span> |
| 778 | </a> |
| 779 | <div class="jp-carousel-image-map" style="display: none;"></div> |
| 780 | </div> |
| 781 | </div> |
| 782 | </div> |
| 783 | </div> |
| 784 | </div> |
| 785 | |
| 786 | </div> |
| 787 | <?php |
| 788 | } |
| 789 | |
| 790 | /** |
| 791 | * Sets the "in_gallery" flag when the first gallery is encountered (unless in AMP mode). |
| 792 | * |
| 793 | * @deprecated since 10.8 |
| 794 | * |
| 795 | * @param string $output Gallery shortcode output. Passed through unchanged. |
| 796 | * |
| 797 | * @return string |
| 798 | */ |
| 799 | public function set_in_gallery( $output ) { |
| 800 | if ( |
| 801 | class_exists( 'Jetpack_AMP_Support' ) |
| 802 | && Jetpack_AMP_Support::is_amp_request() |
| 803 | ) { |
| 804 | return $output; |
| 805 | } |
| 806 | $this->in_gallery = true; |
| 807 | return $output; |
| 808 | } |
| 809 | |
| 810 | /** |
| 811 | * Adds data-* attributes required by carousel to img tags in post HTML |
| 812 | * content. To be used by 'the_content' filter. |
| 813 | * |
| 814 | * @see add_data_to_images() |
| 815 | * @see wp_make_content_images_responsive() in wp-includes/media.php |
| 816 | * |
| 817 | * @param string $content HTML content of the post. |
| 818 | * @return string |
| 819 | */ |
| 820 | public function add_data_img_tags_and_enqueue_assets( $content ) { |
| 821 | if ( |
| 822 | class_exists( 'Jetpack_AMP_Support' ) |
| 823 | && Jetpack_AMP_Support::is_amp_request() |
| 824 | ) { |
| 825 | return $this->maybe_add_amp_lightbox( $content ); |
| 826 | } |
| 827 | |
| 828 | if ( ! preg_match_all( '/<img [^>]+>/', $content, $matches ) ) { |
| 829 | return $content; |
| 830 | } |
| 831 | $selected_images = array(); |
| 832 | foreach ( $matches[0] as $image_html ) { |
| 833 | if ( |
| 834 | preg_match( '/(wp-image-|data-id=)\"?([0-9]+)\"?/i', $image_html, $class_id ) |
| 835 | && ! preg_match( '/wp-block-jetpack-slideshow_image/', $image_html ) |
| 836 | ) { |
| 837 | /** |
| 838 | * Allow filtering the attachment ID used to fetch and populate metadata about an image in a gallery. |
| 839 | * |
| 840 | * @module carousel |
| 841 | * |
| 842 | * @since 12.6 |
| 843 | * |
| 844 | * @param int $attachment_id Attachment ID pulled from image HTML. |
| 845 | * @param string $image_html Full HTML image tag. |
| 846 | */ |
| 847 | $attachment_id = absint( |
| 848 | apply_filters( |
| 849 | 'jetpack_carousel_image_attachment_id', |
| 850 | $class_id[2], |
| 851 | $image_html |
| 852 | ) |
| 853 | ); |
| 854 | |
| 855 | /** |
| 856 | * The same image tag may be used more than once but with different attribs, |
| 857 | * so save each of them against the attachment id. |
| 858 | */ |
| 859 | if ( ! isset( $selected_images[ $attachment_id ] ) || ! in_array( $image_html, $selected_images[ $attachment_id ], true ) ) { |
| 860 | $selected_images[ $attachment_id ][] = $image_html; |
| 861 | } |
| 862 | } |
| 863 | } |
| 864 | |
| 865 | $find = array(); |
| 866 | $replace = array(); |
| 867 | if ( empty( $selected_images ) ) { |
| 868 | return $content; |
| 869 | } |
| 870 | |
| 871 | $attachments = get_posts( |
| 872 | array( |
| 873 | 'include' => array_keys( $selected_images ), |
| 874 | 'post_type' => 'any', |
| 875 | 'post_status' => 'any', |
| 876 | 'suppress_filters' => false, |
| 877 | ) |
| 878 | ); |
| 879 | |
| 880 | foreach ( $attachments as $attachment ) { |
| 881 | /* |
| 882 | * If the item from get_posts isn't an attachment, skip. This can occur when copy-pasta from another WP site. |
| 883 | * For example, if one copies "<img class="wp-image-7 size-full" src="https://twentysixteendemo.files.wordpress.com/2015/11/post.png" alt="post" width="1000" height="563" />" |
| 884 | * then, we're going to look up post 7 below, which making sure it is an attachment. |
| 885 | * |
| 886 | * This is meant as a relatively quick fix, as a better fix is likely to update the get_posts call above to only |
| 887 | * include attachments. |
| 888 | */ |
| 889 | if ( |
| 890 | ! isset( $attachment->ID ) |
| 891 | || ! wp_attachment_is_image( $attachment->ID ) |
| 892 | || ! isset( $selected_images[ $attachment->ID ] ) |
| 893 | ) { |
| 894 | continue; |
| 895 | } |
| 896 | $image_elements = $selected_images[ $attachment->ID ]; |
| 897 | |
| 898 | if ( ! is_array( $image_elements ) ) { |
| 899 | continue; |
| 900 | } |
| 901 | |
| 902 | $attributes = $this->add_data_to_images( array(), $attachment ); |
| 903 | $attributes_html = ''; |
| 904 | foreach ( $attributes as $k => $v ) { |
| 905 | $attributes_html .= esc_attr( $k ) . '="' . esc_attr( $v ) . '" '; |
| 906 | } |
| 907 | foreach ( $image_elements as $image_html ) { |
| 908 | $find[] = $image_html; |
| 909 | $replace[] = str_replace( '<img ', "<img $attributes_html", $image_html ); |
| 910 | } |
| 911 | } |
| 912 | |
| 913 | $content = str_replace( $find, $replace, $content ); |
| 914 | $this->enqueue_assets(); |
| 915 | return $content; |
| 916 | } |
| 917 | |
| 918 | /** |
| 919 | * Adds the data attributes themselves to img tags. |
| 920 | * |
| 921 | * @see add_data_img_tags_and_enqueue_assets() |
| 922 | * @see https://developer.wordpress.org/reference/functions/wp_get_attachment_image/ Documentation about wp_get_attachment_image |
| 923 | * |
| 924 | * @param string[] $attr Array of attribute values for the image markup, keyed by attribute name. |
| 925 | * @param null|WP_Post $attachment Image attachment post. |
| 926 | * |
| 927 | * @return string[] Modified image attributes. |
| 928 | */ |
| 929 | public function add_data_to_images( $attr, $attachment = null ) { |
| 930 | if ( |
| 931 | class_exists( 'Jetpack_AMP_Support' ) |
| 932 | && Jetpack_AMP_Support::is_amp_request() |
| 933 | ) { |
| 934 | return $attr; |
| 935 | } |
| 936 | |
| 937 | if ( |
| 938 | ! $attachment instanceof WP_Post |
| 939 | || ! isset( $attachment->ID ) |
| 940 | || ! wp_attachment_is_image( $attachment ) |
| 941 | ) { |
| 942 | return $attr; |
| 943 | } |
| 944 | |
| 945 | $attachment_id = (int) $attachment->ID; |
| 946 | $orig_file = wp_get_attachment_image_src( $attachment_id, 'full' ); |
| 947 | $orig_file = isset( $orig_file[0] ) ? $orig_file[0] : wp_get_attachment_url( $attachment_id ); |
| 948 | $meta = wp_get_attachment_metadata( $attachment_id ); |
| 949 | $size = isset( $meta['width'] ) ? (int) $meta['width'] . ',' . (int) $meta['height'] : ''; |
| 950 | $img_meta = ( ! empty( $meta['image_meta'] ) ) ? (array) $meta['image_meta'] : array(); |
| 951 | $comments_opened = (int) comments_open( $attachment_id ); |
| 952 | |
| 953 | /** |
| 954 | * Note: Cannot generate a filename from the width and height wp_get_attachment_image_src() returns because |
| 955 | * it takes the $content_width global variable themes can set in consideration, therefore returning sizes |
| 956 | * which when used to generate a filename will likely result in a 404 on the image. |
| 957 | * $content_width has no filter we could temporarily de-register, run wp_get_attachment_image_src(), then |
| 958 | * re-register. So using returned file URL instead, which we can define the sizes from through filename |
| 959 | * parsing in the JS, as this is a failsafe file reference. |
| 960 | * |
| 961 | * EG with Twenty Eleven activated: |
| 962 | * array(4) { [0]=> string(82) "http://vanillawpinstall.blah/wp-content/uploads/2012/06/IMG_3534-1024x764.jpg" [1]=> int(584) [2]=> int(435) [3]=> bool(true) } |
| 963 | * |
| 964 | * EG with Twenty Ten activated: |
| 965 | * array(4) { [0]=> string(82) "http://vanillawpinstall.blah/wp-content/uploads/2012/06/IMG_3534-1024x764.jpg" [1]=> int(640) [2]=> int(477) [3]=> bool(true) } |
| 966 | */ |
| 967 | |
| 968 | $medium_file_info = wp_get_attachment_image_src( $attachment_id, 'medium' ); |
| 969 | $medium_file = isset( $medium_file_info[0] ) ? $medium_file_info[0] : ''; |
| 970 | |
| 971 | $large_file_info = wp_get_attachment_image_src( $attachment_id, 'large' ); |
| 972 | $large_file = isset( $large_file_info[0] ) ? $large_file_info[0] : ''; |
| 973 | |
| 974 | $attachment_title = wptexturize( $attachment->post_title ); |
| 975 | $attachment_desc = wpautop( wptexturize( $attachment->post_content ) ); |
| 976 | $attachment_caption = wpautop( wptexturize( $attachment->post_excerpt ) ); |
| 977 | |
| 978 | // See https://github.com/Automattic/jetpack/issues/2765. |
| 979 | if ( isset( $img_meta['keywords'] ) ) { |
| 980 | unset( $img_meta['keywords'] ); |
| 981 | } |
| 982 | |
| 983 | $img_meta = wp_json_encode( array_map( 'strval', array_filter( $img_meta, 'is_scalar' ) ) ); |
| 984 | |
| 985 | $attr['data-attachment-id'] = $attachment_id; |
| 986 | $attr['data-permalink'] = esc_attr( get_permalink( $attachment_id ) ); |
| 987 | $attr['data-orig-file'] = esc_attr( $orig_file ); |
| 988 | $attr['data-orig-size'] = $size; |
| 989 | $attr['data-comments-opened'] = $comments_opened; |
| 990 | $attr['data-image-meta'] = esc_attr( $img_meta ); |
| 991 | // The lines below use `esc_attr( htmlspecialchars( ) )` because esc_attr tries to be too smart and won't double-encode, and we need that here. |
| 992 | $attr['data-image-title'] = esc_attr( htmlspecialchars( $attachment_title, ENT_COMPAT ) ); |
| 993 | $attr['data-image-description'] = esc_attr( htmlspecialchars( $attachment_desc, ENT_COMPAT ) ); |
| 994 | $attr['data-image-caption'] = esc_attr( htmlspecialchars( $attachment_caption, ENT_COMPAT ) ); |
| 995 | $attr['data-medium-file'] = esc_attr( $medium_file ); |
| 996 | $attr['data-large-file'] = esc_attr( $large_file ); |
| 997 | return $attr; |
| 998 | } |
| 999 | |
| 1000 | /** |
| 1001 | * Add additional attributes to the Gallery container HTML. |
| 1002 | * |
| 1003 | * @param string $html The HTML to which the additional attributes are added. |
| 1004 | * |
| 1005 | * @return string |
| 1006 | */ |
| 1007 | public function add_data_to_container( $html ) { |
| 1008 | global $post; |
| 1009 | if ( |
| 1010 | class_exists( 'Jetpack_AMP_Support' ) |
| 1011 | && Jetpack_AMP_Support::is_amp_request() |
| 1012 | ) { |
| 1013 | return $html; |
| 1014 | } |
| 1015 | |
| 1016 | if ( isset( $post ) ) { |
| 1017 | $blog_id = (int) get_current_blog_id(); |
| 1018 | |
| 1019 | $extra_data = array( |
| 1020 | 'data-carousel-extra' => array( |
| 1021 | 'blog_id' => $blog_id, |
| 1022 | 'permalink' => get_permalink( $post->ID ), |
| 1023 | ), |
| 1024 | ); |
| 1025 | |
| 1026 | /** |
| 1027 | * Filter the data added to the Gallery container. |
| 1028 | * |
| 1029 | * @module carousel |
| 1030 | * |
| 1031 | * @since 1.6.0 |
| 1032 | * |
| 1033 | * @param array $extra_data Array of data about the site and the post. |
| 1034 | */ |
| 1035 | $extra_data = apply_filters( 'jp_carousel_add_data_to_container', $extra_data ); |
| 1036 | foreach ( (array) $extra_data as $data_key => $data_values ) { |
| 1037 | $html = str_replace( '<div ', '<div ' . esc_attr( $data_key ) . "='" . wp_json_encode( $data_values ) . "' ", $html ); |
| 1038 | $html = str_replace( '<ul class="wp-block-gallery', '<ul ' . esc_attr( $data_key ) . "='" . wp_json_encode( $data_values ) . "' class=\"wp-block-gallery", $html ); |
| 1039 | $html = str_replace( '<ul class="blocks-gallery-grid', '<ul ' . esc_attr( $data_key ) . "='" . wp_json_encode( $data_values ) . "' class=\"blocks-gallery-grid", $html ); |
| 1040 | $html = preg_replace( '/\<figure([^>]*)class="(wp-block-gallery[^"]*?has-nested-images.*?)"/', '<figure ' . esc_attr( $data_key ) . "='" . wp_json_encode( $data_values ) . "' $1 class=\"$2\"", $html ); |
| 1041 | } |
| 1042 | } |
| 1043 | |
| 1044 | return $html; |
| 1045 | } |
| 1046 | |
| 1047 | /** |
| 1048 | * Conditionally adds amp-lightbox to galleries and images. |
| 1049 | * |
| 1050 | * This applies to gallery blocks and shortcodes, |
| 1051 | * in addition to images that are wrapped in a link to the page. |
| 1052 | * Images wrapped in a link to the media file shouldn't get an amp-lightbox. |
| 1053 | * |
| 1054 | * @param string $content The content to possibly add amp-lightbox to. |
| 1055 | * @return string The content, with amp-lightbox possibly added. |
| 1056 | */ |
| 1057 | public function maybe_add_amp_lightbox( $content ) { |
| 1058 | $content = preg_replace( |
| 1059 | array( |
| 1060 | '#(<figure)[^>]*(?=class=(["\']?)[^>]*wp-block-gallery[^>]*\2)#is', // Gallery block. |
| 1061 | '#(\[gallery)(?=\s+)#', // Gallery shortcode. |
| 1062 | ), |
| 1063 | array( |
| 1064 | '\1 data-amp-lightbox="true" ', // https://github.com/ampproject/amp-wp/blob/1094ea03bd5dc92889405a47a8c41de1a88908de/includes/sanitizers/class-amp-gallery-block-sanitizer.php#L84. |
| 1065 | '\1 amp-lightbox="true"', // https://github.com/ampproject/amp-wp/blob/1094ea03bd5dc92889405a47a8c41de1a88908de/includes/embeds/class-amp-gallery-embed.php#L64. |
| 1066 | ), |
| 1067 | $content |
| 1068 | ); |
| 1069 | |
| 1070 | return preg_replace_callback( |
| 1071 | '#(<a[^>]* href=(["\']?)(\S+)\2>)\s*(<img[^>]*)(class=(["\']?)[^>]*wp-image-[0-9]+[^>]*\6.*>)\s*</a>#is', |
| 1072 | static function ( $matches ) { |
| 1073 | if ( ! preg_match( '#\.\w+$#', $matches[3] ) ) { |
| 1074 | // The a[href] doesn't end in a file extension like .jpeg, so this is not a link to the media file, and should get a lightbox. |
| 1075 | return $matches[4] . ' data-amp-lightbox="true" lightbox="true" ' . $matches[5]; // https://github.com/ampproject/amp-wp/blob/1094ea03bd5dc92889405a47a8c41de1a88908de/includes/sanitizers/class-amp-img-sanitizer.php#L419. |
| 1076 | } |
| 1077 | |
| 1078 | return $matches[0]; |
| 1079 | }, |
| 1080 | $content |
| 1081 | ); |
| 1082 | } |
| 1083 | |
| 1084 | /** |
| 1085 | * Retrieves comment information |
| 1086 | * |
| 1087 | * @return string |
| 1088 | */ |
| 1089 | public function get_attachment_comments() { |
| 1090 | if ( ! headers_sent() ) { |
| 1091 | header( 'Content-type: text/javascript' ); |
| 1092 | } |
| 1093 | |
| 1094 | /** |
| 1095 | * Allows for the checking of privileges of the blog user before comments |
| 1096 | * are packaged as JSON and sent back from the get_attachment_comments |
| 1097 | * AJAX endpoint |
| 1098 | * |
| 1099 | * @module carousel |
| 1100 | * |
| 1101 | * @since 1.6.0 |
| 1102 | */ |
| 1103 | do_action( 'jp_carousel_check_blog_user_privileges' ); |
| 1104 | |
| 1105 | // phpcs:disable WordPress.Security.NonceVerification.Recommended -- we do not need to verify the nonce for this public request for publicly accessible data (as checked below). |
| 1106 | $attachment_id = ( isset( $_REQUEST['id'] ) ) ? (int) $_REQUEST['id'] : 0; |
| 1107 | $offset = ( isset( $_REQUEST['offset'] ) ) ? (int) $_REQUEST['offset'] : 0; |
| 1108 | // phpcs:enable |
| 1109 | |
| 1110 | if ( ! $attachment_id ) { |
| 1111 | wp_send_json_error( |
| 1112 | __( 'Missing attachment ID.', 'jetpack' ), |
| 1113 | 403 |
| 1114 | ); |
| 1115 | return; |
| 1116 | } |
| 1117 | |
| 1118 | $attachment_post = get_post( $attachment_id ); |
| 1119 | // If we have no info about that attachment, bail. |
| 1120 | if ( ! ( $attachment_post instanceof WP_Post ) ) { |
| 1121 | wp_send_json_error( |
| 1122 | __( 'Missing attachment info.', 'jetpack' ), |
| 1123 | 403 |
| 1124 | ); |
| 1125 | return; |
| 1126 | } |
| 1127 | |
| 1128 | // This AJAX call should only be used to fetch comments of attachments. |
| 1129 | if ( 'attachment' !== $attachment_post->post_type ) { |
| 1130 | wp_send_json_error( |
| 1131 | __( 'You aren’t authorized to do that.', 'jetpack' ), |
| 1132 | 403 |
| 1133 | ); |
| 1134 | return; |
| 1135 | } |
| 1136 | |
| 1137 | $parent_post = get_post_parent( $attachment_id ); |
| 1138 | |
| 1139 | /* |
| 1140 | * If we have no info about that parent post, no extra checks. |
| 1141 | * The attachment doesn't have a parent post, so is public. |
| 1142 | * If we have a parent post, let's ensure the user has access to it. |
| 1143 | */ |
| 1144 | if ( $parent_post instanceof WP_Post ) { |
| 1145 | /* |
| 1146 | * Fetch info about user making the request. |
| 1147 | * If we have no info, bail. |
| 1148 | * Even logged out users should get a WP_User user with id 0. |
| 1149 | */ |
| 1150 | $current_user = wp_get_current_user(); |
| 1151 | if ( ! ( $current_user instanceof WP_User ) ) { |
| 1152 | wp_send_json_error( |
| 1153 | __( 'Missing user info.', 'jetpack' ), |
| 1154 | 403 |
| 1155 | ); |
| 1156 | return; |
| 1157 | } |
| 1158 | |
| 1159 | /* |
| 1160 | * If a post is private / draft |
| 1161 | * and the current user doesn't have access to it, |
| 1162 | * bail. |
| 1163 | */ |
| 1164 | if ( |
| 1165 | 'publish' !== $parent_post->post_status |
| 1166 | && ! current_user_can( 'read_post', $parent_post->ID ) |
| 1167 | ) { |
| 1168 | wp_send_json_error( |
| 1169 | __( 'You aren’t authorized to do that.', 'jetpack' ), |
| 1170 | 403 |
| 1171 | ); |
| 1172 | return; |
| 1173 | } |
| 1174 | } |
| 1175 | |
| 1176 | if ( $offset < 1 ) { |
| 1177 | $offset = 0; |
| 1178 | } |
| 1179 | |
| 1180 | $comments = get_comments( |
| 1181 | array( |
| 1182 | 'status' => 'approve', |
| 1183 | 'order' => ( 'asc' === get_option( 'comment_order' ) ) ? 'ASC' : 'DESC', |
| 1184 | 'number' => 10, |
| 1185 | 'offset' => $offset, |
| 1186 | 'post_id' => $attachment_id, |
| 1187 | ) |
| 1188 | ); |
| 1189 | |
| 1190 | $out = array(); |
| 1191 | |
| 1192 | // Can't just send the results, they contain the commenter's email address. |
| 1193 | foreach ( $comments as $comment ) { |
| 1194 | $avatar = get_avatar( $comment->comment_author_email, 64 ); |
| 1195 | if ( ! $avatar ) { |
| 1196 | $avatar = ''; |
| 1197 | } |
| 1198 | $out[] = array( |
| 1199 | 'id' => $comment->comment_ID, |
| 1200 | 'parent_id' => $comment->comment_parent, |
| 1201 | 'author_markup' => get_comment_author_link( $comment->comment_ID ), |
| 1202 | 'gravatar_markup' => $avatar, |
| 1203 | 'date_gmt' => $comment->comment_date_gmt, |
| 1204 | 'content' => wpautop( $comment->comment_content ), |
| 1205 | ); |
| 1206 | } |
| 1207 | |
| 1208 | die( wp_json_encode( $out ) ); |
| 1209 | } |
| 1210 | |
| 1211 | /** |
| 1212 | * Adds a new comment to the database |
| 1213 | * |
| 1214 | * @return never |
| 1215 | */ |
| 1216 | public function post_attachment_comment() { |
| 1217 | if ( ! headers_sent() ) { |
| 1218 | header( 'Content-type: text/javascript' ); |
| 1219 | } |
| 1220 | |
| 1221 | if ( empty( $_POST['nonce'] ) || ! wp_verify_nonce( $_POST['nonce'], 'carousel_nonce' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput -- WP Core doesn't unslash or sanitize nonces either |
| 1222 | die( wp_json_encode( array( 'error' => __( 'Nonce verification failed.', 'jetpack' ) ) ) ); |
| 1223 | } |
| 1224 | |
| 1225 | $_blog_id = isset( $_POST['blog_id'] ) ? (int) $_POST['blog_id'] : 0; |
| 1226 | $_post_id = isset( $_POST['id'] ) ? (int) $_POST['id'] : 0; |
| 1227 | $comment = isset( $_POST['comment'] ) ? filter_var( wp_unslash( $_POST['comment'] ) ) : null; |
| 1228 | |
| 1229 | if ( empty( $_blog_id ) ) { |
| 1230 | die( wp_json_encode( array( 'error' => __( 'Missing target blog ID.', 'jetpack' ) ) ) ); |
| 1231 | } |
| 1232 | |
| 1233 | if ( empty( $_post_id ) ) { |
| 1234 | die( wp_json_encode( array( 'error' => __( 'Missing target post ID.', 'jetpack' ) ) ) ); |
| 1235 | } |
| 1236 | |
| 1237 | if ( empty( $comment ) ) { |
| 1238 | die( wp_json_encode( array( 'error' => __( 'No comment text was submitted.', 'jetpack' ) ) ) ); |
| 1239 | } |
| 1240 | |
| 1241 | // Used in context like NewDash. |
| 1242 | $switched = false; |
| 1243 | if ( is_multisite() && get_current_blog_id() !== $_blog_id ) { |
| 1244 | switch_to_blog( $_blog_id ); |
| 1245 | $switched = true; |
| 1246 | } |
| 1247 | |
| 1248 | /** This action is documented in modules/carousel/jetpack-carousel.php */ |
| 1249 | do_action( 'jp_carousel_check_blog_user_privileges' ); |
| 1250 | |
| 1251 | if ( ! comments_open( $_post_id ) ) { |
| 1252 | if ( $switched ) { |
| 1253 | restore_current_blog(); |
| 1254 | } |
| 1255 | die( wp_json_encode( array( 'error' => __( 'Comments on this post are closed.', 'jetpack' ) ) ) ); |
| 1256 | } |
| 1257 | |
| 1258 | if ( is_user_logged_in() ) { |
| 1259 | $user = wp_get_current_user(); |
| 1260 | $user_id = $user->ID; |
| 1261 | $display_name = $user->display_name; |
| 1262 | $email = $user->user_email; |
| 1263 | $url = $user->user_url; |
| 1264 | |
| 1265 | if ( empty( $user_id ) ) { |
| 1266 | if ( $switched ) { |
| 1267 | restore_current_blog(); |
| 1268 | } |
| 1269 | die( wp_json_encode( array( 'error' => __( 'Sorry, but we could not authenticate your request.', 'jetpack' ) ) ) ); |
| 1270 | } |
| 1271 | } else { |
| 1272 | $user_id = 0; |
| 1273 | $display_name = isset( $_POST['author'] ) ? sanitize_text_field( wp_unslash( $_POST['author'] ) ) : null; |
| 1274 | $email = isset( $_POST['email'] ) ? wp_unslash( $_POST['email'] ) : null; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Checked or sanitized below. |
| 1275 | $url = isset( $_POST['url'] ) ? esc_url_raw( wp_unslash( $_POST['url'] ) ) : null; |
| 1276 | |
| 1277 | if ( get_option( 'require_name_email' ) ) { |
| 1278 | if ( empty( $display_name ) ) { |
| 1279 | if ( $switched ) { |
| 1280 | restore_current_blog(); |
| 1281 | } |
| 1282 | die( wp_json_encode( array( 'error' => __( 'Please provide your name.', 'jetpack' ) ) ) ); |
| 1283 | } |
| 1284 | |
| 1285 | if ( empty( $email ) ) { |
| 1286 | if ( $switched ) { |
| 1287 | restore_current_blog(); |
| 1288 | } |
| 1289 | die( wp_json_encode( array( 'error' => __( 'Please provide an email address.', 'jetpack' ) ) ) ); |
| 1290 | } |
| 1291 | |
| 1292 | if ( ! is_email( $email ) ) { |
| 1293 | if ( $switched ) { |
| 1294 | restore_current_blog(); |
| 1295 | } |
| 1296 | die( wp_json_encode( array( 'error' => __( 'Please provide a valid email address.', 'jetpack' ) ) ) ); |
| 1297 | } |
| 1298 | } else { |
| 1299 | $email = $email !== null ? sanitize_email( $email ) : null; |
| 1300 | } |
| 1301 | } |
| 1302 | |
| 1303 | $comment_data = array( |
| 1304 | 'comment_content' => $comment, |
| 1305 | 'comment_post_ID' => $_post_id, |
| 1306 | 'comment_author' => $display_name, |
| 1307 | 'comment_author_email' => $email, |
| 1308 | 'comment_author_url' => $url, |
| 1309 | 'comment_approved' => 0, |
| 1310 | 'comment_type' => 'comment', |
| 1311 | ); |
| 1312 | |
| 1313 | if ( ! empty( $user_id ) ) { |
| 1314 | $comment_data['user_id'] = $user_id; |
| 1315 | } |
| 1316 | |
| 1317 | // Note: wp_new_comment() sanitizes and validates the values (too). |
| 1318 | $comment_id = wp_new_comment( $comment_data ); |
| 1319 | |
| 1320 | /** |
| 1321 | * Fires before adding a new comment to the database via the get_attachment_comments ajax endpoint. |
| 1322 | * |
| 1323 | * @module carousel |
| 1324 | * |
| 1325 | * @since 1.6.0 |
| 1326 | */ |
| 1327 | do_action( 'jp_carousel_post_attachment_comment' ); |
| 1328 | $comment_status = wp_get_comment_status( $comment_id ); |
| 1329 | |
| 1330 | if ( $switched ) { |
| 1331 | restore_current_blog(); |
| 1332 | } |
| 1333 | |
| 1334 | die( |
| 1335 | wp_json_encode( |
| 1336 | array( |
| 1337 | 'comment_id' => $comment_id, |
| 1338 | 'comment_status' => $comment_status, |
| 1339 | ) |
| 1340 | ) |
| 1341 | ); |
| 1342 | } |
| 1343 | |
| 1344 | /** |
| 1345 | * Register Carousel settings |
| 1346 | */ |
| 1347 | public function register_settings() { |
| 1348 | add_settings_section( 'carousel_section', __( 'Image Gallery Carousel', 'jetpack' ), array( $this, 'carousel_section_callback' ), 'media' ); |
| 1349 | |
| 1350 | if ( ! $this->in_jetpack ) { |
| 1351 | add_settings_field( 'carousel_enable_it', __( 'Enable carousel', 'jetpack' ), array( $this, 'carousel_enable_it_callback' ), 'media', 'carousel_section' ); |
| 1352 | register_setting( 'media', 'carousel_enable_it', array( $this, 'carousel_enable_it_sanitize' ) ); |
| 1353 | } |
| 1354 | |
| 1355 | add_settings_field( 'carousel_background_color', __( 'Background color', 'jetpack' ), array( $this, 'carousel_background_color_callback' ), 'media', 'carousel_section' ); |
| 1356 | register_setting( 'media', 'carousel_background_color', array( $this, 'carousel_background_color_sanitize' ) ); |
| 1357 | |
| 1358 | add_settings_field( 'carousel_display_exif', __( 'Metadata', 'jetpack' ), array( $this, 'carousel_display_exif_callback' ), 'media', 'carousel_section' ); |
| 1359 | register_setting( 'media', 'carousel_display_exif', array( $this, 'carousel_display_exif_sanitize' ) ); |
| 1360 | |
| 1361 | add_settings_field( 'carousel_display_comments', __( 'Comments', 'jetpack' ), array( $this, 'carousel_display_comments_callback' ), 'media', 'carousel_section' ); |
| 1362 | register_setting( 'media', 'carousel_display_comments', array( $this, 'carousel_display_comments_sanitize' ) ); |
| 1363 | } |
| 1364 | |
| 1365 | /** |
| 1366 | * Fulfill the settings section callback requirement by returning nothing. |
| 1367 | */ |
| 1368 | public function carousel_section_callback() { |
| 1369 | } |
| 1370 | |
| 1371 | /** |
| 1372 | * Tests if a value is set |
| 1373 | * |
| 1374 | * @param mixed $value The value passed into this function with which to test. |
| 1375 | * @param bool $default_to_1 Default is true. |
| 1376 | * |
| 1377 | * @return bool |
| 1378 | */ |
| 1379 | public function test_1or0_option( $value, $default_to_1 = true ) { |
| 1380 | if ( $default_to_1 ) { |
| 1381 | // Boolean false (===) of $value means it has not yet been set, in which case we do want to default to 1. |
| 1382 | if ( false === $value ) { |
| 1383 | $value = 1; |
| 1384 | } |
| 1385 | } |
| 1386 | return ( 1 == $value ) ? 1 : 0; // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual |
| 1387 | } |
| 1388 | |
| 1389 | /** |
| 1390 | * Ensures the value returned is in the correct format. |
| 1391 | * |
| 1392 | * @see test_1or0_option() |
| 1393 | * @param mixed $value The value returned from the test_1or0_option function. |
| 1394 | * |
| 1395 | * @return int |
| 1396 | */ |
| 1397 | public function sanitize_1or0_option( $value ) { |
| 1398 | return ( 1 == $value ) ? 1 : 0; // phpcs:ignore Universal.Operators.StrictComparisons.LooseEqual |
| 1399 | } |
| 1400 | |
| 1401 | /** |
| 1402 | * Outputs a settings checkbox. |
| 1403 | * |
| 1404 | * @param string $name - For name attribute. |
| 1405 | * @param string $label_text - For label attribute. |
| 1406 | * @param string $extra_text - Additional checkbox description text. Defaults to empty. |
| 1407 | * @param bool $default_to_checked - If the checkbox is checked. Default is true. |
| 1408 | */ |
| 1409 | public function settings_checkbox( $name, $label_text, $extra_text = '', $default_to_checked = true ) { |
| 1410 | if ( empty( $name ) ) { |
| 1411 | return; |
| 1412 | } |
| 1413 | $option = $this->test_1or0_option( get_option( $name ), $default_to_checked ); |
| 1414 | echo '<fieldset>'; |
| 1415 | echo '<input type="checkbox" name="' . esc_attr( $name ) . '" id="' . esc_attr( $name ) . '" value="1" '; |
| 1416 | checked( '1', $option ); |
| 1417 | echo '/> <label for="' . esc_attr( $name ) . '">' . wp_kses_post( $label_text ) . '</label>'; |
| 1418 | if ( ! empty( $extra_text ) ) { |
| 1419 | echo '<p class="description">' . wp_kses_post( $extra_text ) . '</p>'; |
| 1420 | } |
| 1421 | echo '</fieldset>'; |
| 1422 | } |
| 1423 | |
| 1424 | /** |
| 1425 | * Output a selection list options |
| 1426 | * |
| 1427 | * @param string $name - For name attribute. |
| 1428 | * @param string $values - For the different option values. |
| 1429 | * @param string $extra_text - Additional option section description text. Defaults to empty. |
| 1430 | */ |
| 1431 | public function settings_select( $name, $values, $extra_text = '' ) { |
| 1432 | if ( empty( $name ) || ! is_array( $values ) || empty( $values ) ) { |
| 1433 | return; |
| 1434 | } |
| 1435 | $option = get_option( $name ); |
| 1436 | echo '<fieldset>'; |
| 1437 | echo '<select name="' . esc_attr( $name ) . '" id="' . esc_attr( $name ) . '">'; |
| 1438 | foreach ( $values as $key => $value ) { |
| 1439 | echo '<option value="' . esc_attr( $key ) . '" '; |
| 1440 | selected( $key, $option ); |
| 1441 | echo '>' . esc_html( $value ) . '</option>'; |
| 1442 | } |
| 1443 | echo '</select>'; |
| 1444 | if ( ! empty( $extra_text ) ) { |
| 1445 | echo '<p class="description">' . wp_kses_post( $extra_text ) . '</p>'; |
| 1446 | } |
| 1447 | echo '</fieldset>'; |
| 1448 | } |
| 1449 | |
| 1450 | /** |
| 1451 | * Callback for checkbox and label of field that allows to toggle exif display. |
| 1452 | */ |
| 1453 | public function carousel_display_exif_callback() { |
| 1454 | $this->settings_checkbox( 'carousel_display_exif', __( 'Show photo metadata (<a href="https://en.wikipedia.org/wiki/Exchangeable_image_file_format" rel="noopener noreferrer" target="_blank">Exif</a>) in carousel, when available.', 'jetpack' ) ); |
| 1455 | } |
| 1456 | |
| 1457 | /** |
| 1458 | * Callback for checkbox and label of field that allows to toggle comments. |
| 1459 | */ |
| 1460 | public function carousel_display_comments_callback() { |
| 1461 | $this->settings_checkbox( 'carousel_display_comments', esc_html__( 'Show comments area in carousel', 'jetpack' ) ); |
| 1462 | } |
| 1463 | |
| 1464 | /** |
| 1465 | * Sanitize input for the `carousel_display_exif` setting. |
| 1466 | * |
| 1467 | * @param mixed $value User input setting value. |
| 1468 | * |
| 1469 | * @return int Sanitized value, only 1 or 0. |
| 1470 | */ |
| 1471 | public function carousel_display_exif_sanitize( $value ) { |
| 1472 | return $this->sanitize_1or0_option( $value ); |
| 1473 | } |
| 1474 | |
| 1475 | /** |
| 1476 | * Return sanitized option for value that controls whether comments will be hidden or not. |
| 1477 | * |
| 1478 | * @param mixed $value Value to sanitize. |
| 1479 | * |
| 1480 | * @return int Sanitized value, only 1 or 0. |
| 1481 | */ |
| 1482 | public function carousel_display_comments_sanitize( $value ) { |
| 1483 | return $this->sanitize_1or0_option( $value ); |
| 1484 | } |
| 1485 | |
| 1486 | /** |
| 1487 | * Callback for the Carousel background color. |
| 1488 | */ |
| 1489 | public function carousel_background_color_callback() { |
| 1490 | $this->settings_select( |
| 1491 | 'carousel_background_color', |
| 1492 | array( |
| 1493 | 'black' => __( 'Black', 'jetpack' ), |
| 1494 | 'white' => __( 'White', 'jetpack' ), |
| 1495 | ) |
| 1496 | ); |
| 1497 | } |
| 1498 | |
| 1499 | /** |
| 1500 | * Sanitizing the Carousel backgound color selection. |
| 1501 | * |
| 1502 | * @param string $value The color string to sanitize. |
| 1503 | * |
| 1504 | * @return string Sanitized value, 'white' or 'black'. |
| 1505 | */ |
| 1506 | public function carousel_background_color_sanitize( $value ) { |
| 1507 | return ( 'white' === $value ) ? 'white' : 'black'; |
| 1508 | } |
| 1509 | |
| 1510 | /** |
| 1511 | * Callback to display text for the carousel_enable_it settings field. |
| 1512 | */ |
| 1513 | public function carousel_enable_it_callback() { |
| 1514 | $this->settings_checkbox( 'carousel_enable_it', __( 'Display images in full-size carousel slideshow.', 'jetpack' ) ); |
| 1515 | } |
| 1516 | |
| 1517 | /** |
| 1518 | * Sanitize input for the `carousel_enable_it` setting. |
| 1519 | * |
| 1520 | * @param mixed $value User input. |
| 1521 | * |
| 1522 | * @return int Sanitized value, only 1 or 0. |
| 1523 | */ |
| 1524 | public function carousel_enable_it_sanitize( $value ) { |
| 1525 | return $this->sanitize_1or0_option( $value ); |
| 1526 | } |
| 1527 | } |
| 1528 | |
| 1529 | new Jetpack_Carousel(); |
| 1530 |