jetpack / modules / shortcodes.php

shortcodes.php in Jetpack – WP Security, Backup, Speed, & Growth 16.2-beta, at modules/shortcodes.php

220 lines 6.5 KB

Raw Download Zip

1	<?php
2	/**
3	* Module Name: Shortcode Embeds
4	* Module Description: Easily embed rich media like YouTube videos and tweets using simple shortcodes.
5	* Sort Order: 3
6	* First Introduced: 1.1
7	* Major Changes In: 1.2
8	* Requires Connection: No
9	* Auto Activate: No
10	* Module Tags: Photos and Videos, Social, Writing, Appearance
11	* Feature: Writing
12	* Additional Search Queries: shortcodes, shortcode, embeds, media, bandcamp, dailymotion, facebook, flickr, google calendars, google maps, polldaddy, recipe, recipes, scribd, slideshare, slideshow, slideshows, soundcloud, ted, twitter, vimeo, vine, youtube
13	*
14	* @package automattic/jetpack
15	*/
16
17	if ( ! defined( 'ABSPATH' ) ) {
18	exit( 0 );
19	}
20
21	// Load shortcode utils.
22	require_once __DIR__ . '/shortcodes/shortcode-utils.php';
23
24	/**
25	* Transforms the $atts array into a string that the old functions expected
26	*
27	* The old way was:
28	* [shortcode a=1&b=2&c=3] or [shortcode=1]
29	* This is parsed as array( a => '1&b=2&c=3' ) and array( 0 => '=1' ), which is useless
30	*
31	* @param array $params Array of old shortcode parameters.
32	* @param bool $old_format_support true if [shortcode=foo] format is possible.
33	*
34	* @return string $params
35	*/
36	function shortcode_new_to_old_params( $params, $old_format_support = false ) {
37	$str = '';
38
39	if ( $old_format_support && isset( $params[0] ) ) {
40	$str = ltrim( $params[0], '=' );
41	} elseif ( is_array( $params ) ) {
42	foreach ( array_keys( $params ) as $key ) {
43	if ( ! is_numeric( $key ) ) {
44	$str = $key . '=' . $params[ $key ];
45	}
46	}
47	}
48
49	return str_replace( array( '&', '&' ), '&', $str );
50	}
51
52	/**
53	* Load all available Jetpack shortcode files.
54	*/
55	function jetpack_load_shortcodes() {
56	// Prevent third-party shortcode plugins when loading shortcode files.
57	// Format: shortcode => condition_when_to_skip
58	$shortcode_skips = array(
59	'shortcode-utils' => true, // Utils aren't shortcodes.
60	'soundcloud' => function_exists( 'soundcloud_shortcode' ), // SoundCloud Shortcodes plugin
61	);
62
63	$shortcode_includes = array();
64
65	foreach ( Jetpack::glob_php( __DIR__ . '/shortcodes' ) as $file ) {
66	$filename = substr( basename( $file ), 0, -4 );
67
68	if ( empty( $shortcode_skips[ $filename ] ) ) {
69	$shortcode_includes[ $filename ] = $file;
70	}
71	}
72
73	/**
74	* This filter allows other plugins to override which shortcodes Jetpack loads.
75	*
76	* Fires as part of the `after_setup_theme` WP hook, so modifying code needs to be in a plugin, not in a theme's functions.php.
77	*
78	* @module shortcodes
79	*
80	* @since 2.2.1
81	* @since 4.2.0 Added filename without extension as array key.
82	*
83	* @param array $shortcode_includes An array of which shortcodes to include.
84	*/
85	$shortcode_includes = apply_filters( 'jetpack_shortcodes_to_include', $shortcode_includes );
86
87	foreach ( $shortcode_includes as $include ) {
88	include_once $include;
89	}
90	}
91
92	/**
93	* Runs preg_replace so that replacements don't happen within open tags.
94	* Parameters are the same as preg_replace, with an added optional search param for improved performance
95	*
96	* @param string $pattern Pattern to search for.
97	* @param string $replacement String to replace.
98	* @param string $content Post content.
99	* @param string $search String to search for.
100	*
101	* @return string $content Replaced post content.
102	*/
103	function jetpack_preg_replace_outside_tags( $pattern, $replacement, $content, $search = null ) {
104	if ( $search && ! str_contains( $content, $search ) ) {
105	return $content;
106	}
107
108	$textarr = wp_html_split( $content );
109	unset( $content );
110	foreach ( $textarr as &$element ) {
111	if ( '' === $element \|\| '<' === $element[0] ) {
112	continue;
113	}
114	$element = preg_replace( $pattern, $replacement, $element );
115	}
116
117	return implode( $textarr );
118	}
119
120	/**
121	* Runs preg_replace_callback so that replacements don't happen within open tags.
122	* Parameters are the same as preg_replace, with an added optional search param for improved performance.
123	*
124	* @param string $pattern Pattern to search for.
125	* @param string $callback Callback returning the replacement string.
126	* @param string $content Post content.
127	* @param string $search String to search for.
128	*
129	* @return string $content Replaced post content.
130	*/
131	function jetpack_preg_replace_callback_outside_tags( $pattern, $callback, $content, $search = null ) {
132	if ( $search && ! str_contains( $content, $search ) ) {
133	return $content;
134	}
135
136	$textarr = wp_html_split( $content );
137	unset( $content );
138	foreach ( $textarr as &$element ) {
139	if ( '' === $element \|\| '<' === $element[0] ) {
140	continue;
141	}
142	$element = preg_replace_callback( $pattern, $callback, $element );
143	}
144
145	return implode( $textarr );
146	}
147
148	if ( ! function_exists( 'jetpack_shortcode_get_wpvideo_id' ) ) {
149	/**
150	* Get VideoPress ID from wpvideo shortcode attributes.
151	*
152	* @param array $atts Shortcode attributes.
153	*
154	* @return string\|int $id VideoPress ID.
155	*/
156	function jetpack_shortcode_get_wpvideo_id( $atts ) {
157	if ( isset( $atts[0] ) ) {
158	return $atts[0];
159	} else {
160	return 0;
161	}
162	}
163	}
164
165	if ( ! function_exists( 'jetpack_shortcode_get_videopress_id' ) ) {
166	/**
167	* Get VideoPress ID from videopress shortcode attributes.
168	*
169	* @param array $atts Shortcode attributes.
170	* @return int $id VideoPress ID.
171	*/
172	function jetpack_shortcode_get_videopress_id( $atts ) {
173	if ( isset( $atts[0] ) ) {
174	return $atts[0];
175	} else {
176	return 0;
177	}
178	}
179	}
180
181	/**
182	* Common element attributes parsing and sanitizing for src, width and height.
183	*
184	* @since 4.5.0
185	*
186	* @param array $attrs With original values.
187	*
188	* @return array $attrs With sanitized values.
189	*/
190	function wpcom_shortcodereverse_parseattr( $attrs ) {
191	$defaults = array(
192	'src' => false,
193	'width' => false,
194	'height' => false,
195	);
196
197	$attrs = shortcode_atts( $defaults, $attrs );
198
199	$attrs['src'] = wp_strip_all_tags( $attrs['src'] ); // For sanity.
200	$attrs['width'] = ( is_numeric( $attrs['width'] ) ) ? abs( (int) $attrs['width'] ) : $defaults['width'];
201	$attrs['height'] = ( is_numeric( $attrs['height'] ) ) ? abs( (int) $attrs['height'] ) : $defaults['height'];
202
203	return $attrs;
204	}
205
206	/**
207	* When an embed service goes away, we can use this handler
208	* to output a link for history's sake.
209	*
210	* @param array $matches Regex partial matches against the URL passed.
211	* @param array $attr Attributes received in embed response.
212	* @param string $url Requested URL to be embedded.
213	* @return string Link to output.
214	*/
215	function jetpack_deprecated_embed_handler( $matches, $attr, $url ) {
216	return sprintf( '<a href="%s">%s</a>', esc_url( $url ), esc_html( esc_url( $url ) ) );
217	}
218
219	jetpack_load_shortcodes();
220