← All changes
|
modules/theme-tools/content-options/blog-display.php
+322
-0
16.2-beta
→
16.3
View file →
| @@ -1,0 +1,322 @@ | ||
| 1 | +<?php | |
| 2 | +/** | |
| 3 | + * Theme Tools: the functions to display Content or Excerpt in a theme. | |
| 4 | + * | |
| 5 | + * @package automattic/jetpack | |
| 6 | + */ | |
| 7 | + | |
| 8 | +if ( ! defined( 'ABSPATH' ) ) { | |
| 9 | + exit( 0 ); | |
| 10 | +} | |
| 11 | + | |
| 12 | +/** | |
| 13 | + * If the theme doesn't support 'jetpack-content-options', don't continue. | |
| 14 | + */ | |
| 15 | +if ( ! current_theme_supports( 'jetpack-content-options' ) ) { | |
| 16 | + return; | |
| 17 | +} | |
| 18 | + | |
| 19 | +/** | |
| 20 | + * Get the Blog Display setting. | |
| 21 | + * If theme is using both 'Content' and 'Excerpt' then this setting will be called 'Mixed'. | |
| 22 | + */ | |
| 23 | +$options = get_theme_support( 'jetpack-content-options' ); | |
| 24 | +$blog_display = ( ! empty( $options[0]['blog-display'] ) ) ? $options[0]['blog-display'] : null; | |
| 25 | +$blog_display = preg_grep( '/^(content|excerpt)$/', (array) $blog_display ); | |
| 26 | +sort( $blog_display ); | |
| 27 | +$blog_display = implode( ', ', $blog_display ); | |
| 28 | +$blog_display = ( 'content, excerpt' === $blog_display ) ? 'mixed' : $blog_display; | |
| 29 | + | |
| 30 | +/** | |
| 31 | + * If the theme doesn't support 'jetpack-content-options[ 'blog-display' ]', don't continue. | |
| 32 | + */ | |
| 33 | +if ( ! in_array( $blog_display, array( 'content', 'excerpt', 'mixed' ), true ) ) { | |
| 34 | + return; | |
| 35 | +} | |
| 36 | + | |
| 37 | +if ( ! function_exists( 'jetpack_blog_display_custom_excerpt' ) ) { | |
| 38 | + | |
| 39 | + /** | |
| 40 | + * Apply Content filters. | |
| 41 | + * | |
| 42 | + * @deprecated 13.9 Moved to Classic Theme Helper package. | |
| 43 | + * @since 9.7.0 Deprecated $content parameter. | |
| 44 | + * | |
| 45 | + * @param string $content Post content. Deprecated. | |
| 46 | + */ | |
| 47 | + function jetpack_blog_display_custom_excerpt( $content = '' ) { | |
| 48 | + _deprecated_function( __FUNCTION__, 'jetpack-13.9' ); | |
| 49 | + if ( ! empty( $content ) ) { | |
| 50 | + _doing_it_wrong( | |
| 51 | + 'jetpack_blog_display_custom_excerpt', | |
| 52 | + esc_html__( 'You do not need to pass a $content parameter anymore.', 'jetpack' ), | |
| 53 | + 'jetpack-9.7.0' | |
| 54 | + ); | |
| 55 | + } | |
| 56 | + | |
| 57 | + $post = get_post(); | |
| 58 | + if ( empty( $post ) ) { | |
| 59 | + return ''; | |
| 60 | + } | |
| 61 | + | |
| 62 | + if ( empty( $post->post_excerpt ) ) { | |
| 63 | + $text = strip_shortcodes( $post->post_content ); | |
| 64 | + $text = str_replace( ']]>', ']]>', $text ); | |
| 65 | + $text = wp_strip_all_tags( $text ); | |
| 66 | + /** This filter is documented in wp-includes/formatting.php */ | |
| 67 | + $excerpt_length = apply_filters( 'excerpt_length', 55 ); | |
| 68 | + /** This filter is documented in wp-includes/formatting.php */ | |
| 69 | + $excerpt_more = apply_filters( 'excerpt_more', ' [...]' ); | |
| 70 | + | |
| 71 | + /* | |
| 72 | + * translators: If your word count is based on single characters (e.g. East Asian characters), | |
| 73 | + * enter 'characters_excluding_spaces' or 'characters_including_spaces'. Otherwise, enter 'words'. | |
| 74 | + * Do not translate into your own language. | |
| 75 | + */ | |
| 76 | + if ( strpos( _x( 'words', 'Word count type. Do not translate!', 'jetpack' ), 'characters' ) === 0 && preg_match( '/^utf\-?8$/i', get_option( 'blog_charset' ) ) ) { | |
| 77 | + $text = trim( preg_replace( "/[\n\r\t ]+/", ' ', $text ), ' ' ); | |
| 78 | + preg_match_all( '/./u', $text, $words ); | |
| 79 | + $words = array_slice( $words[0], 0, $excerpt_length + 1 ); | |
| 80 | + $sep = ''; | |
| 81 | + } else { | |
| 82 | + $words = preg_split( "/[\n\r\t ]+/", $text, $excerpt_length + 1, PREG_SPLIT_NO_EMPTY ); | |
| 83 | + $sep = ' '; | |
| 84 | + } | |
| 85 | + | |
| 86 | + if ( count( $words ) > $excerpt_length ) { | |
| 87 | + array_pop( $words ); | |
| 88 | + $text = implode( $sep, $words ); | |
| 89 | + $text .= $excerpt_more; | |
| 90 | + } else { | |
| 91 | + $text = implode( $sep, $words ); | |
| 92 | + } | |
| 93 | + } else { | |
| 94 | + $text = wp_kses_post( $post->post_excerpt ); | |
| 95 | + } | |
| 96 | + return sprintf( '<p>%s</p>', $text ); | |
| 97 | + } | |
| 98 | + | |
| 99 | +} | |
| 100 | + | |
| 101 | +if ( ! function_exists( 'jetpack_the_content_to_the_excerptt' ) ) { | |
| 102 | + | |
| 103 | + /** | |
| 104 | + * Display Excerpt instead of Content. | |
| 105 | + * | |
| 106 | + * @deprecated 13.9 Moved to Classic Theme Helper package. | |
| 107 | + * | |
| 108 | + * @param string $content Post content. | |
| 109 | + */ | |
| 110 | + function jetpack_the_content_to_the_excerpt( $content ) { | |
| 111 | + _deprecated_function( __FUNCTION__, 'jetpack-13.9' ); | |
| 112 | + if ( ( is_home() || is_archive() ) && ! is_post_type_archive( array( 'jetpack-testimonial', 'jetpack-portfolio', 'product' ) ) ) { | |
| 113 | + if ( post_password_required() ) { | |
| 114 | + $excerpt = sprintf( '<p>%s</p>', esc_html__( 'There is no excerpt because this is a protected post.', 'jetpack' ) ); | |
| 115 | + } else { | |
| 116 | + $excerpt = jetpack_blog_display_custom_excerpt(); | |
| 117 | + } | |
| 118 | + } | |
| 119 | + if ( empty( $excerpt ) ) { | |
| 120 | + return $content; | |
| 121 | + } else { | |
| 122 | + return $excerpt; | |
| 123 | + } | |
| 124 | + } | |
| 125 | + | |
| 126 | +} | |
| 127 | + | |
| 128 | +if ( ! function_exists( 'jetpack_the_excerpt_to_the_content' ) ) { | |
| 129 | + | |
| 130 | + /** | |
| 131 | + * Display Content instead of Excerpt. | |
| 132 | + * | |
| 133 | + * @deprecated 13.9 Moved to Classic Theme Helper package. | |
| 134 | + * | |
| 135 | + * @param string $content The post excerpt. | |
| 136 | + */ | |
| 137 | + function jetpack_the_excerpt_to_the_content( $content ) { | |
| 138 | + _deprecated_function( __FUNCTION__, 'jetpack-13.9' ); | |
| 139 | + if ( ( is_home() || is_archive() ) && ! is_post_type_archive( array( 'jetpack-testimonial', 'jetpack-portfolio', 'product' ) ) ) { | |
| 140 | + ob_start(); | |
| 141 | + the_content( | |
| 142 | + sprintf( | |
| 143 | + wp_kses( | |
| 144 | + /* translators: %s: Name of current post. Only visible to screen readers */ | |
| 145 | + __( 'Continue reading<span class="screen-reader-text"> "%s"</span>', 'jetpack' ), | |
| 146 | + array( | |
| 147 | + 'span' => array( | |
| 148 | + 'class' => array(), | |
| 149 | + ), | |
| 150 | + ) | |
| 151 | + ), | |
| 152 | + get_the_title() | |
| 153 | + ) | |
| 154 | + ); | |
| 155 | + $content = ob_get_clean(); | |
| 156 | + } | |
| 157 | + return $content; | |
| 158 | + } | |
| 159 | + | |
| 160 | +} | |
| 161 | + | |
| 162 | +if ( ! function_exists( 'jetpack_the_content_customizer' ) ) { | |
| 163 | + | |
| 164 | + /** | |
| 165 | + * Display both Content and Excerpt instead of Content in the Customizer so live preview can switch between them. | |
| 166 | + * | |
| 167 | + * @deprecated 13.9 Moved to Classic Theme Helper package. | |
| 168 | + * @param string $content The post content. | |
| 169 | + */ | |
| 170 | + function jetpack_the_content_customizer( $content ) { | |
| 171 | + _deprecated_function( __FUNCTION__, 'jetpack-13.9' ); | |
| 172 | + $class = jetpack_the_content_customizer_class(); | |
| 173 | + if ( ( is_home() || is_archive() ) && ! is_post_type_archive( array( 'jetpack-testimonial', 'jetpack-portfolio', 'product' ) ) ) { | |
| 174 | + if ( post_password_required() ) { | |
| 175 | + $excerpt = sprintf( '<p>%s</p>', esc_html__( 'There is no excerpt because this is a protected post.', 'jetpack' ) ); | |
| 176 | + } else { | |
| 177 | + $excerpt = jetpack_blog_display_custom_excerpt(); | |
| 178 | + } | |
| 179 | + } | |
| 180 | + if ( empty( $excerpt ) ) { | |
| 181 | + return $content; | |
| 182 | + } else { | |
| 183 | + return sprintf( '<div class="jetpack-blog-display %s jetpack-the-content">%s</div><div class="jetpack-blog-display %s jetpack-the-excerpt">%s</div>', $class, $content, $class, $excerpt ); | |
| 184 | + } | |
| 185 | + } | |
| 186 | + | |
| 187 | +} | |
| 188 | + | |
| 189 | +if ( ! function_exists( 'jetpack_the_excerpt_customizer' ) ) { | |
| 190 | + | |
| 191 | + /** | |
| 192 | + * Display both Content and Excerpt instead of Excerpt in the Customizer so live preview can switch between them. | |
| 193 | + * | |
| 194 | + * @deprecated 13.9 Moved to Classic Theme Helper package. | |
| 195 | + * @param string $excerpt The post excerpt. | |
| 196 | + */ | |
| 197 | + function jetpack_the_excerpt_customizer( $excerpt ) { | |
| 198 | + _deprecated_function( __FUNCTION__, 'jetpack-13.9' ); | |
| 199 | + if ( ( is_home() || is_archive() ) && ! is_post_type_archive( array( 'jetpack-testimonial', 'jetpack-portfolio', 'product' ) ) ) { | |
| 200 | + ob_start(); | |
| 201 | + the_content( | |
| 202 | + sprintf( | |
| 203 | + wp_kses( | |
| 204 | + /* translators: %s: Name of current post. Only visible to screen readers */ | |
| 205 | + __( 'Continue reading<span class="screen-reader-text"> "%s"</span>', 'jetpack' ), | |
| 206 | + array( | |
| 207 | + 'span' => array( | |
| 208 | + 'class' => array(), | |
| 209 | + ), | |
| 210 | + ) | |
| 211 | + ), | |
| 212 | + get_the_title() | |
| 213 | + ) | |
| 214 | + ); | |
| 215 | + $content = ob_get_clean(); | |
| 216 | + } | |
| 217 | + if ( empty( $content ) ) { | |
| 218 | + return $excerpt; | |
| 219 | + } else { | |
| 220 | + return sprintf( '<div class="jetpack-blog-display jetpack-the-content">%s</div><div class="jetpack-blog-display jetpack-the-excerpt">%s</div>', $content, $excerpt ); | |
| 221 | + } | |
| 222 | + } | |
| 223 | + | |
| 224 | +} | |
| 225 | + | |
| 226 | +if ( ! function_exists( 'jetpack_the_excerpt_mixed_customizer' ) ) { | |
| 227 | + | |
| 228 | + /** | |
| 229 | + * Display Content instead of Excerpt in the Customizer when theme uses a 'Mixed' display. | |
| 230 | + * | |
| 231 | + * @deprecated 13.9 Moved to Classic Theme Helper package. | |
| 232 | + * @param string $content The post excerpt. | |
| 233 | + */ | |
| 234 | + function jetpack_the_excerpt_mixed_customizer( $content ) { | |
| 235 | + _deprecated_function( __FUNCTION__, 'jetpack-13.9' ); | |
| 236 | + if ( ( is_home() || is_archive() ) && ! is_post_type_archive( array( 'jetpack-testimonial', 'jetpack-portfolio', 'product' ) ) ) { | |
| 237 | + jetpack_the_content_customizer_class( 'output-the-excerpt' ); | |
| 238 | + ob_start(); | |
| 239 | + the_content(); | |
| 240 | + $content = ob_get_clean(); | |
| 241 | + } | |
| 242 | + return $content; | |
| 243 | + } | |
| 244 | + | |
| 245 | +} | |
| 246 | + | |
| 247 | +if ( ! function_exists( 'jetpack_the_content_customizer_class' ) ) { | |
| 248 | + | |
| 249 | + /** | |
| 250 | + * Returns a class value, `output-the-content` by default. | |
| 251 | + * Used for themes with a 'Mixed' Blog Display so we can tell which output is by default. | |
| 252 | + * | |
| 253 | + * @deprecated 13.9 Moved to Classic Theme Helper package. | |
| 254 | + * @param string|null $new_class CSS class added to content container. | |
| 255 | + */ | |
| 256 | + function jetpack_the_content_customizer_class( $new_class = null ) { | |
| 257 | + _deprecated_function( __FUNCTION__, 'jetpack-13.9' ); | |
| 258 | + static $class; | |
| 259 | + if ( isset( $new_class ) ) { | |
| 260 | + // Assign a new class and return. | |
| 261 | + $class = $new_class; | |
| 262 | + } elseif ( isset( $class ) ) { | |
| 263 | + // Reset the class after getting value. | |
| 264 | + $prev_class = $class; | |
| 265 | + $class = null; | |
| 266 | + return $prev_class; | |
| 267 | + } else { | |
| 268 | + // Return default class value. | |
| 269 | + return 'output-the-content'; | |
| 270 | + } | |
| 271 | + } | |
| 272 | + | |
| 273 | +} | |
| 274 | + | |
| 275 | +if ( is_customize_preview() ) { | |
| 276 | + /* | |
| 277 | + * Display Content and Excerpt if the default Blog Display is 'Content' | |
| 278 | + * and we are in the Customizer. | |
| 279 | + */ | |
| 280 | + if ( 'content' === $blog_display ) { | |
| 281 | + add_filter( 'the_content', 'jetpack_the_content_customizer' ); | |
| 282 | + } | |
| 283 | + | |
| 284 | + /* | |
| 285 | + * Display Content and Excerpt if the default Blog Display is 'Excerpt' | |
| 286 | + * and we are in the Customizer. | |
| 287 | + */ | |
| 288 | + if ( 'excerpt' === $blog_display ) { | |
| 289 | + add_filter( 'the_excerpt', 'jetpack_the_excerpt_customizer' ); | |
| 290 | + } | |
| 291 | + | |
| 292 | + /* | |
| 293 | + * Display Content and Excerpt if the default Blog Display is 'Mixed' | |
| 294 | + * and we are in the Customizer. | |
| 295 | + */ | |
| 296 | + if ( 'mixed' === $blog_display ) { | |
| 297 | + add_filter( 'the_content', 'jetpack_the_content_customizer' ); | |
| 298 | + add_filter( 'the_excerpt', 'jetpack_the_excerpt_mixed_customizer' ); | |
| 299 | + } | |
| 300 | +} else { | |
| 301 | + $display_option = get_option( 'jetpack_content_blog_display', $blog_display ); | |
| 302 | + | |
| 303 | + /* | |
| 304 | + * Display Excerpt if the default Blog Display is 'Content' | |
| 305 | + * or default Blog Display is 'Mixed' | |
| 306 | + * and the Option picked is 'Post Excerpt' | |
| 307 | + * and we aren't in the Customizer. | |
| 308 | + */ | |
| 309 | + if ( ( 'content' === $blog_display || 'mixed' === $blog_display ) && 'excerpt' === $display_option ) { | |
| 310 | + add_filter( 'the_content', 'jetpack_the_content_to_the_excerpt' ); | |
| 311 | + } | |
| 312 | + | |
| 313 | + /* | |
| 314 | + * Display Content if the default Blog Display is 'Excerpt' | |
| 315 | + * or default Blog Display is 'Mixed' | |
| 316 | + * and the Option picked is 'Full Post' | |
| 317 | + * and we aren't in the Customizer. | |
| 318 | + */ | |
| 319 | + if ( ( 'excerpt' === $blog_display || 'mixed' === $blog_display ) && 'content' === $display_option ) { | |
| 320 | + add_filter( 'the_excerpt', 'jetpack_the_excerpt_to_the_content' ); | |
| 321 | + } | |
| 322 | +} | |