| 1 |
<?php |
| 2 |
/** |
| 3 |
* SoundCloud Shortcode |
| 4 |
* Based on this plugin: https://wordpress.org/plugins/soundcloud-shortcode/ |
| 5 |
* |
| 6 |
* Credits: |
| 7 |
* Original version: Johannes Wagener <johannes@soundcloud.com> |
| 8 |
* Options support: Tiffany Conroy <tiffany@soundcloud.com> |
| 9 |
* HTML5 & oEmbed support: Tim Bormans <tim@soundcloud.com> |
| 10 |
* |
| 11 |
* Examples: |
| 12 |
* [soundcloud]http://soundcloud.com/forss/flickermood[/soundcloud] |
| 13 |
* [soundcloud url="https://api.soundcloud.com/tracks/156661852" params="auto_play=false&hide_related=false&visual=false" width="100%" height="450" iframe="true" /] |
| 14 |
* [soundcloud url="https://api.soundcloud.com/tracks/156661852" params="auto_play=false&hide_related=false&visual=true" width="100%" height="450" iframe="true" /] |
| 15 |
* [soundcloud url="https://soundcloud.com/closetorgan/paul-is-dead" width=400 height=400] |
| 16 |
* [soundcloud url="https://soundcloud.com/closetorgan/sets/smells-like-lynx-africa-private"] |
| 17 |
* [soundcloud url="https://soundcloud.com/closetorgan/sets/smells-like-lynx-africa-private" color="00cc11"] |
| 18 |
* <iframe width="100%" height="450" scrolling="no" frameborder="no" src="https://w.soundcloud.com/player/?url=https%3A//api.soundcloud.com/tracks/150745932&auto_play=false&hide_related=false&show_comments=true&show_user=true&show_reposts=false&visual=true"></iframe> |
| 19 |
* |
| 20 |
* @package automattic/jetpack |
| 21 |
*/ |
| 22 |
|
| 23 |
/** |
| 24 |
* SoundCloud shortcode handler |
| 25 |
* |
| 26 |
* @param string|array $atts The attributes passed to the shortcode like [soundcloud attr1="value" /]. |
| 27 |
* Is an empty string when no arguments are given. |
| 28 |
* @param string $content The content between non-self closing [soundcloud]...[/soundcloud] tags. |
| 29 |
* |
| 30 |
* @return string Widget embed code HTML |
| 31 |
*/ |
| 32 |
function soundcloud_shortcode( $atts, $content = null ) { |
| 33 |
global $wp_embed; |
| 34 |
|
| 35 |
// Custom shortcode options. |
| 36 |
$shortcode_options = array_merge( |
| 37 |
array( 'url' => trim( $content ) ), |
| 38 |
is_array( $atts ) ? $atts : array() |
| 39 |
); |
| 40 |
|
| 41 |
// The "url" option is required. |
| 42 |
if ( empty( $shortcode_options['url'] ) ) { |
| 43 |
if ( current_user_can( 'edit_posts' ) ) { |
| 44 |
return esc_html__( 'Please specify a Soundcloud URL.', 'jetpack' ); |
| 45 |
} else { |
| 46 |
return '<!-- Missing Soundcloud URL -->'; |
| 47 |
} |
| 48 |
} |
| 49 |
|
| 50 |
// If the shortcode is displayed in a WPCOM notification, display a simple link only. |
| 51 |
if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) { |
| 52 |
require_once WP_CONTENT_DIR . '/lib/display-context.php'; |
| 53 |
$context = A8C\Display_Context\get_current_context(); |
| 54 |
if ( A8C\Display_Context\NOTIFICATIONS === $context ) { |
| 55 |
return sprintf( |
| 56 |
'<a href="%1$s" target="_blank" rel="noopener noreferrer">%1$s</a>', |
| 57 |
esc_url( $shortcode_options['url'] ) |
| 58 |
); |
| 59 |
} |
| 60 |
} |
| 61 |
|
| 62 |
// Turn shortcode option "param" (param=value¶m2=value) into array of params. |
| 63 |
$shortcode_params = array(); |
| 64 |
if ( isset( $shortcode_options['params'] ) ) { |
| 65 |
parse_str( html_entity_decode( $shortcode_options['params'], ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401 ), $shortcode_params ); |
| 66 |
$shortcode_options = array_merge( |
| 67 |
$shortcode_options, |
| 68 |
$shortcode_params |
| 69 |
); |
| 70 |
unset( $shortcode_options['params'] ); |
| 71 |
} |
| 72 |
|
| 73 |
$options = shortcode_atts( |
| 74 |
// This list used to include an 'iframe' option. We don't include it anymore as we don't support the Flash player anymore. |
| 75 |
array( |
| 76 |
'url' => '', |
| 77 |
'width' => soundcloud_get_option( 'player_width' ), |
| 78 |
'height' => soundcloud_url_has_tracklist( $shortcode_options['url'] ) ? soundcloud_get_option( 'player_height_multi' ) : soundcloud_get_option( 'player_height' ), |
| 79 |
'auto_play' => soundcloud_get_option( 'auto_play' ), |
| 80 |
'hide_related' => false, |
| 81 |
'visual' => false, |
| 82 |
'show_comments' => soundcloud_get_option( 'show_comments' ), |
| 83 |
'color' => soundcloud_get_option( 'color' ), |
| 84 |
'show_user' => false, |
| 85 |
'show_reposts' => false, |
| 86 |
), |
| 87 |
$shortcode_options, |
| 88 |
'soundcloud' |
| 89 |
); |
| 90 |
|
| 91 |
// "width" needs to be an integer. |
| 92 |
if ( ! empty( $options['width'] ) && ! preg_match( '/^\d+$/', $options['width'] ) ) { |
| 93 |
// set to 0 so oEmbed will use the default 100% and WordPress themes will leave it alone. |
| 94 |
$options['width'] = 0; |
| 95 |
} |
| 96 |
// Set default width if not defined. |
| 97 |
$width = ! empty( $options['width'] ) ? absint( $options['width'] ) : '100%'; |
| 98 |
|
| 99 |
// Set default height if not defined. |
| 100 |
if ( |
| 101 |
empty( $options['height'] ) |
| 102 |
|| ( |
| 103 |
// "height" needs to be an integer. |
| 104 |
! empty( $options['height'] ) |
| 105 |
&& ! preg_match( '/^\d+$/', $options['height'] ) |
| 106 |
) |
| 107 |
) { |
| 108 |
if ( |
| 109 |
soundcloud_url_has_tracklist( $options['url'] ) |
| 110 |
|| 'true' === $options['visual'] |
| 111 |
) { |
| 112 |
$height = 450; |
| 113 |
} else { |
| 114 |
$height = 166; |
| 115 |
} |
| 116 |
} else { |
| 117 |
$height = absint( $options['height'] ); |
| 118 |
} |
| 119 |
|
| 120 |
// Set visual to false when displaying the smallest player. |
| 121 |
if ( '20' === $options['height'] ) { |
| 122 |
$options['visual'] = false; |
| 123 |
} |
| 124 |
|
| 125 |
if ( |
| 126 |
class_exists( 'Jetpack_AMP_Support' ) |
| 127 |
&& Jetpack_AMP_Support::is_amp_request() |
| 128 |
&& ! empty( $options['url'] ) |
| 129 |
&& 'api.soundcloud.com' !== wp_parse_url( $options['url'], PHP_URL_HOST ) |
| 130 |
) { |
| 131 |
// Defer to oEmbed if an oEmbeddable URL is provided. |
| 132 |
return $wp_embed->shortcode( $options, $options['url'] ); |
| 133 |
} |
| 134 |
|
| 135 |
// Build our list of Soundcloud parameters. |
| 136 |
$query_args = array( |
| 137 |
'url' => rawurlencode( $options['url'] ), |
| 138 |
); |
| 139 |
|
| 140 |
// Add our options, if they are set to true or false. |
| 141 |
foreach ( $options as $name => $value ) { |
| 142 |
if ( 'true' === $value ) { |
| 143 |
$query_args[ $name ] = 'true'; |
| 144 |
} |
| 145 |
|
| 146 |
if ( 'false' === $value || false === $value ) { |
| 147 |
$query_args[ $name ] = 'false'; |
| 148 |
} |
| 149 |
} |
| 150 |
|
| 151 |
// Add the color parameter if it was specified and is a valid color. |
| 152 |
if ( ! empty( $options['color'] ) ) { |
| 153 |
$color = sanitize_hex_color_no_hash( $options['color'] ); |
| 154 |
if ( ! empty( $color ) ) { |
| 155 |
$query_args['color'] = $color; |
| 156 |
} |
| 157 |
} |
| 158 |
|
| 159 |
// Build final embed URL. |
| 160 |
$url = add_query_arg( |
| 161 |
$query_args, |
| 162 |
'https://w.soundcloud.com/player/' |
| 163 |
); |
| 164 |
|
| 165 |
return sprintf( |
| 166 |
'<iframe width="%1$s" height="%2$d" scrolling="no" frameborder="no" src="%3$s"></iframe>', |
| 167 |
esc_attr( $width ), |
| 168 |
esc_attr( $height ), |
| 169 |
$url |
| 170 |
); |
| 171 |
} |
| 172 |
add_shortcode( 'soundcloud', 'soundcloud_shortcode' ); |
| 173 |
|
| 174 |
/** |
| 175 |
* Plugin options getter |
| 176 |
* |
| 177 |
* @param string|array $option Option name. |
| 178 |
* @param mixed $default Default value. |
| 179 |
* |
| 180 |
* @return mixed Option value |
| 181 |
*/ |
| 182 |
function soundcloud_get_option( $option, $default = false ) { |
| 183 |
$value = get_option( 'soundcloud_' . $option ); |
| 184 |
|
| 185 |
return '' === $value ? $default : $value; |
| 186 |
} |
| 187 |
|
| 188 |
/** |
| 189 |
* Decide if a url has a tracklist |
| 190 |
* |
| 191 |
* @param string $url Soundcloud URL. |
| 192 |
* |
| 193 |
* @return boolean |
| 194 |
*/ |
| 195 |
function soundcloud_url_has_tracklist( $url ) { |
| 196 |
return preg_match( '/^(.+?)\/(sets|groups|playlists)\/(.+?)$/', $url ); |
| 197 |
} |
| 198 |
|
| 199 |
/** |
| 200 |
* SoundCloud Embed Reversal |
| 201 |
* |
| 202 |
* Converts a generic HTML embed code from SoundClound into a |
| 203 |
* WordPress.com-compatibly shortcode. |
| 204 |
* |
| 205 |
* @param string $content HTML content. |
| 206 |
* |
| 207 |
* @return string Parsed content. |
| 208 |
*/ |
| 209 |
function jetpack_soundcloud_embed_reversal( $content ) { |
| 210 |
if ( ! is_string( $content ) || false === stripos( $content, 'w.soundcloud.com/player' ) ) { |
| 211 |
return $content; |
| 212 |
} |
| 213 |
|
| 214 |
$regexes = array(); |
| 215 |
|
| 216 |
$regexes[] = '#<iframe[^>]+?src="((?:https?:)?//w\.soundcloud\.com/player/[^"\']++)"[^>]*+>\s*?</iframe>#i'; |
| 217 |
$regexes[] = '#<iframe(?:[^&]|&(?!gt;))+?src="((?:https?:)?//w\.soundcloud\.com/player/[^"\']++)"(?:[^&]|&(?!gt;))*+>\s*?</iframe>#i'; |
| 218 |
|
| 219 |
foreach ( $regexes as $regex ) { |
| 220 |
if ( ! preg_match_all( $regex, $content, $matches, PREG_SET_ORDER ) ) { |
| 221 |
continue; |
| 222 |
} |
| 223 |
|
| 224 |
foreach ( $matches as $match ) { |
| 225 |
|
| 226 |
// if pasted from the visual editor - prevent double encoding. |
| 227 |
$match[1] = str_replace( '&amp;', '&', $match[1] ); |
| 228 |
|
| 229 |
$args = wp_parse_url( html_entity_decode( $match[1], ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401 ), PHP_URL_QUERY ); |
| 230 |
$args = wp_parse_args( $args ); |
| 231 |
|
| 232 |
if ( ! preg_match( '#^(?:https?:)?//api\.soundcloud\.com/.+$#i', $args['url'], $url_matches ) ) { |
| 233 |
continue; |
| 234 |
} |
| 235 |
|
| 236 |
if ( ! preg_match( '#height="(\d+)"#i', $match[0], $hmatch ) ) { |
| 237 |
$height = ''; |
| 238 |
} else { |
| 239 |
$height = ' height="' . (int) $hmatch[1] . '"'; |
| 240 |
} |
| 241 |
|
| 242 |
unset( $args['url'] ); |
| 243 |
$params = 'params="'; |
| 244 |
if ( is_countable( $args ) && count( $args ) > 0 ) { |
| 245 |
foreach ( $args as $key => $value ) { |
| 246 |
$params .= esc_html( $key ) . '=' . esc_html( $value ) . '&'; |
| 247 |
} |
| 248 |
$params = substr( $params, 0, -5 ); |
| 249 |
} |
| 250 |
$params .= '"'; |
| 251 |
|
| 252 |
$shortcode = '[soundcloud url="' . esc_url( $url_matches[0] ) . '" ' . $params . ' width="100%"' . $height . ' iframe="true" /]'; |
| 253 |
|
| 254 |
$replace_regex = sprintf( '#\s*%s\s*#', preg_quote( $match[0], '#' ) ); |
| 255 |
$content = preg_replace( $replace_regex, sprintf( "\n\n%s\n\n", $shortcode ), $content ); |
| 256 |
|
| 257 |
/** This action is documented in modules/shortcodes/youtube.php */ |
| 258 |
do_action( 'jetpack_embed_to_shortcode', 'soundcloud', $url_matches[0] ); |
| 259 |
} |
| 260 |
} |
| 261 |
|
| 262 |
return $content; |
| 263 |
} |
| 264 |
add_filter( 'pre_kses', 'jetpack_soundcloud_embed_reversal' ); |
| 265 |
|
