author-bio.php
2 years ago
blog-display.php
4 years ago
customizer.js
6 years ago
customizer.php
3 years ago
featured-images-fallback.php
2 years ago
featured-images.php
2 years ago
post-details.php
4 years ago
featured-images-fallback.php
227 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Theme Tools: functions for Featured Images fallback. |
| 4 | * |
| 5 | * @package automattic/jetpack |
| 6 | */ |
| 7 | |
| 8 | /** |
| 9 | * Get one image from a specified post in the following order: |
| 10 | * Featured Image then first image from the_content HTML |
| 11 | * and filter the post_thumbnail_html |
| 12 | * |
| 13 | * @param string $html The HTML for the image markup. |
| 14 | * @param int $post_id The post ID to check. |
| 15 | * @param int $post_thumbnail_id The ID of the featured image. |
| 16 | * @param string $size The image size to return, defaults to 'post-thumbnail'. |
| 17 | * @param string|array $attr Optional. Query string or array of attributes. |
| 18 | * |
| 19 | * @return string $html Thumbnail image with markup. |
| 20 | */ |
| 21 | function jetpack_featured_images_fallback_get_image( $html, $post_id, $post_thumbnail_id, $size, $attr ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable |
| 22 | $opts = jetpack_featured_images_get_settings(); |
| 23 | |
| 24 | if ( ! empty( $html ) || (bool) 1 !== (bool) $opts['fallback-option'] ) { |
| 25 | return trim( $html ); |
| 26 | } |
| 27 | |
| 28 | if ( jetpack_featured_images_should_load() ) { |
| 29 | if ( |
| 30 | ( true === $opts['archive'] && ( is_home() || is_archive() || is_search() ) && ! $opts['archive-option'] ) |
| 31 | || ( true === $opts['post'] && is_single() && ! $opts['post-option'] ) |
| 32 | || ! $opts['fallback-option'] |
| 33 | ) { |
| 34 | return trim( $html ); |
| 35 | } |
| 36 | } |
| 37 | |
| 38 | if ( class_exists( 'Jetpack_PostImages' ) ) { |
| 39 | global $_wp_additional_image_sizes; |
| 40 | |
| 41 | $args = array( |
| 42 | 'from_thumbnail' => false, |
| 43 | 'from_slideshow' => true, |
| 44 | 'from_gallery' => true, |
| 45 | 'from_attachment' => false, |
| 46 | ); |
| 47 | |
| 48 | $image = Jetpack_PostImages::get_image( $post_id, $args ); |
| 49 | |
| 50 | if ( ! empty( $image ) ) { |
| 51 | $image['width'] = ''; |
| 52 | $image['height'] = ''; |
| 53 | $image['crop'] = ''; |
| 54 | |
| 55 | if ( array_key_exists( $size, $_wp_additional_image_sizes ) ) { |
| 56 | $image['width'] = $_wp_additional_image_sizes[ $size ]['width']; |
| 57 | $image['height'] = $_wp_additional_image_sizes[ $size ]['height']; |
| 58 | $image['crop'] = $_wp_additional_image_sizes[ $size ]['crop']; |
| 59 | } |
| 60 | |
| 61 | // Force `crop` to be a simple boolean, to avoid dealing with WP crop positions. |
| 62 | $image['crop'] = boolval( $image['crop'] ); |
| 63 | |
| 64 | $image_sizes = ''; |
| 65 | |
| 66 | $width = isset( $image['width'] ) ? intval( $image['width'] ) : null; |
| 67 | $height = isset( $image['height'] ) ? intval( $image['height'] ) : null; |
| 68 | |
| 69 | if ( ! empty( $image['src_width'] ) && ! empty( $image['src_height'] ) && ! empty( $image['width'] ) && ! empty( $image['height'] ) ) { |
| 70 | $src_width = intval( $image['src_width'] ); |
| 71 | $src_height = intval( $image['src_height'] ); |
| 72 | |
| 73 | // If we're aware of the source dimensions, calculate the final image height and width. |
| 74 | // This allows us to provide them as attributes in the `<img>` tag, to avoid layout shifts. |
| 75 | // It also allows us to calculate a `srcset`. |
| 76 | if ( $image['crop'] ) { |
| 77 | // If we're cropping, the final dimensions are calculated independently of each other. |
| 78 | $width = min( $width, $src_width ); |
| 79 | $height = min( $height, $src_height ); |
| 80 | } else { |
| 81 | // If we're not cropping, we need to preserve aspect ratio. |
| 82 | $dims = wp_constrain_dimensions( $src_width, $src_height, $width, $height ); |
| 83 | $width = $dims[0]; |
| 84 | $height = $dims[1]; |
| 85 | } |
| 86 | |
| 87 | $image_src = Jetpack_PostImages::fit_image_url( $image['src'], $width, $height ); |
| 88 | $image_srcset = Jetpack_PostImages::generate_cropped_srcset( $image, $width, $height, true ); |
| 89 | $image_sizes = 'min(' . $width . 'px, 100vw)'; |
| 90 | } else { |
| 91 | // If we're not aware of the source dimensions, leave the size calculations to the CDN, and |
| 92 | // fall back to a simpler `<img>` tag without `width`/`height` or `srcset`. |
| 93 | $image_src = Jetpack_PostImages::fit_image_url( $image['src'], $image['width'], $image['height'] ); |
| 94 | |
| 95 | // Use the theme's crop setting rather than forcing to true. |
| 96 | $image_src = add_query_arg( 'crop', $image['crop'], $image_src ); |
| 97 | |
| 98 | $image_srcset = null; |
| 99 | $image_sizes = null; |
| 100 | } |
| 101 | |
| 102 | $default_attr = array( |
| 103 | 'srcset' => $image_srcset, |
| 104 | 'sizes' => $image_sizes, |
| 105 | 'loading' => is_singular() ? 'eager' : 'lazy', |
| 106 | 'decoding' => 'async', |
| 107 | 'title' => wp_strip_all_tags( get_the_title() ), |
| 108 | 'alt' => '', |
| 109 | 'class' => "attachment-$size wp-post-image", |
| 110 | ); |
| 111 | |
| 112 | $image_attr = wp_parse_args( $attr, $default_attr ); |
| 113 | $hwstring = image_hwstring( $width, $height ); |
| 114 | |
| 115 | $html = rtrim( "<img $hwstring" ); |
| 116 | $html .= ' src="' . esc_url( $image_src ) . '"'; |
| 117 | |
| 118 | foreach ( $image_attr as $name => $value ) { |
| 119 | if ( $value ) { |
| 120 | $html .= " $name=" . '"' . esc_attr( $value ) . '"'; |
| 121 | } |
| 122 | } |
| 123 | |
| 124 | $html .= ' />'; |
| 125 | |
| 126 | return trim( $html ); |
| 127 | } |
| 128 | } |
| 129 | |
| 130 | return trim( $html ); |
| 131 | } |
| 132 | add_filter( 'post_thumbnail_html', 'jetpack_featured_images_fallback_get_image', 10, 5 ); |
| 133 | |
| 134 | /** |
| 135 | * Get URL of one image from a specified post in the following order: |
| 136 | * Featured Image then first image from the_content HTML |
| 137 | * |
| 138 | * @param int $post_id The post ID to check. |
| 139 | * @param int $post_thumbnail_id The ID of the featured image. |
| 140 | * @param string $size The image size to return, defaults to 'post-thumbnail'. |
| 141 | * |
| 142 | * @return string|null $image_src The URL of the thumbnail image. |
| 143 | */ |
| 144 | function jetpack_featured_images_fallback_get_image_src( $post_id, $post_thumbnail_id, $size ) { |
| 145 | $image_src = wp_get_attachment_image_src( $post_thumbnail_id, $size ); |
| 146 | $image_src = ( ! empty( $image_src[0] ) ) ? $image_src[0] : null; |
| 147 | $opts = jetpack_featured_images_get_settings(); |
| 148 | |
| 149 | if ( ! empty( $image_src ) || (bool) 1 !== (bool) $opts['fallback-option'] ) { |
| 150 | return esc_url( $image_src ); |
| 151 | } |
| 152 | |
| 153 | if ( jetpack_featured_images_should_load() ) { |
| 154 | if ( ( true === $opts['archive'] && ( is_home() || is_archive() || is_search() ) && ! $opts['archive-option'] ) |
| 155 | || ( true === $opts['post'] && is_single() && ! $opts['post-option'] ) ) { |
| 156 | return esc_url( $image_src ); |
| 157 | } |
| 158 | } |
| 159 | |
| 160 | if ( class_exists( 'Jetpack_PostImages' ) ) { |
| 161 | global $_wp_additional_image_sizes; |
| 162 | |
| 163 | $args = array( |
| 164 | 'from_thumbnail' => false, |
| 165 | 'from_slideshow' => true, |
| 166 | 'from_gallery' => true, |
| 167 | 'from_attachment' => false, |
| 168 | ); |
| 169 | |
| 170 | $image = Jetpack_PostImages::get_image( $post_id, $args ); |
| 171 | |
| 172 | if ( ! empty( $image ) ) { |
| 173 | $image['width'] = ''; |
| 174 | $image['height'] = ''; |
| 175 | $image['crop'] = ''; |
| 176 | |
| 177 | if ( array_key_exists( $size, $_wp_additional_image_sizes ) ) { |
| 178 | $image['width'] = $_wp_additional_image_sizes[ $size ]['width']; |
| 179 | $image['height'] = $_wp_additional_image_sizes[ $size ]['height']; |
| 180 | $image['crop'] = $_wp_additional_image_sizes[ $size ]['crop']; |
| 181 | } |
| 182 | |
| 183 | $image_src = Jetpack_PostImages::fit_image_url( $image['src'], $image['width'], $image['height'] ); |
| 184 | |
| 185 | // Use the theme's crop setting rather than forcing to true. |
| 186 | $image_src = add_query_arg( 'crop', $image['crop'], $image_src ); |
| 187 | |
| 188 | return esc_url( $image_src ); |
| 189 | } |
| 190 | } |
| 191 | |
| 192 | return esc_url( $image_src ); |
| 193 | } |
| 194 | |
| 195 | /** |
| 196 | * Check if post has an image attached, including a fallback. |
| 197 | * |
| 198 | * @param int $post The post ID to check. |
| 199 | * |
| 200 | * @return bool |
| 201 | */ |
| 202 | function jetpack_has_featured_image( $post = null ) { |
| 203 | return (bool) get_the_post_thumbnail( $post ); |
| 204 | } |
| 205 | |
| 206 | /** |
| 207 | * Adds custom class to the array of post classes. |
| 208 | * |
| 209 | * @param array $classes Classes for the post element. |
| 210 | * @param array $class Optional. Comma separated list of additional classes. |
| 211 | * @param array $post_id Unique The post ID to check. |
| 212 | * |
| 213 | * @return array $classes |
| 214 | */ |
| 215 | function jetpack_featured_images_post_class( $classes, $class, $post_id ) { |
| 216 | $post_password_required = post_password_required( $post_id ); |
| 217 | $opts = jetpack_featured_images_get_settings(); |
| 218 | |
| 219 | if ( jetpack_has_featured_image( $post_id ) && (bool) 1 === (bool) $opts['fallback-option'] && ! is_attachment() && ! $post_password_required && 'post' === get_post_type() ) { |
| 220 | $classes[] = 'has-post-thumbnail'; |
| 221 | $classes[] = 'fallback-thumbnail'; |
| 222 | } |
| 223 | |
| 224 | return $classes; |
| 225 | } |
| 226 | add_filter( 'post_class', 'jetpack_featured_images_post_class', 10, 3 ); |
| 227 |