BP_Embed
Enable oEmbeds in BuddyPress contexts.
Description Description
Extends WP_Embed class for use with BuddyPress.
See also See also
Source Source
File: bp-core/classes/class-bp-embed.php
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 | class BP_Embed extends WP_Embed { /** * Constructor * * @global WP_Embed $wp_embed */ public function __construct() { global $wp_embed; // Make sure we populate the WP_Embed handlers array. // These are providers that use a regex callback on the URL in question. // Do not confuse with oEmbed providers, which require an external ping. // Used in WP_Embed::shortcode(). $this->handlers = $wp_embed->handlers; if ( bp_use_embed_in_activity() ) { add_filter( 'bp_get_activity_content_body', array( &$this, 'autoembed' ), 8 ); add_filter( 'bp_get_activity_content_body', array( &$this, 'run_shortcode' ), 7 ); } if ( bp_use_embed_in_activity_replies() ) { add_filter( 'bp_get_activity_content', array( &$this, 'autoembed' ), 8 ); add_filter( 'bp_get_activity_content', array( &$this, 'run_shortcode' ), 7 ); } if ( bp_use_embed_in_private_messages() ) { add_filter( 'bp_get_the_thread_message_content', array( &$this, 'autoembed' ), 8 ); add_filter( 'bp_get_the_thread_message_content', array( &$this, 'run_shortcode' ), 7 ); } /** * Filters the BuddyPress Core oEmbed setup. * * @since 1.5.0 * * @param BP_Embed $this Current instance of the BP_Embed. Passed by reference. */ do_action_ref_array( 'bp_core_setup_oembed', array( &$this ) ); } /** * The {@link do_shortcode()} callback function. * * Attempts to convert a URL into embed HTML. Starts by checking the * URL against the regex of the registered embed handlers. Next, checks * the URL against the regex of registered {@link WP_oEmbed} providers * if oEmbed discovery is false. If none of the regex matches and it's * enabled, then the URL will be passed to {@link BP_Embed::parse_oembed()} * for oEmbed parsing. * * * @param array $attr Shortcode attributes. * @param string $url The URL attempting to be embeded. * @return string The embed HTML on success, otherwise the original URL. */ public function shortcode( $attr, $url = '' ) { if ( empty( $url ) ) return ''; $rawattr = $attr; $attr = wp_parse_args( $attr, wp_embed_defaults() ); // Use kses to convert & into & and we need to undo this $url = str_replace( '&', '&', $url ); // Look for known internal handlers. ksort( $this->handlers ); foreach ( $this->handlers as $priority => $handlers ) { foreach ( $handlers as $hid => $handler ) { if ( preg_match( $handler['regex'], $url, $matches ) && is_callable( $handler['callback'] ) ) { if ( false !== $return = call_user_func( $handler['callback'], $matches, $attr, $url, $rawattr ) ) { /** * Filters the oEmbed handler result for the provided URL. * * @since 1.5.0 * * @param string $return Handler callback for the oEmbed. * @param string $url URL attempting to be embedded. * @param array $attr Shortcode attributes. */ return apply_filters( 'embed_handler_html', $return, $url, $attr ); } } } } /** * Filters the embed object ID. * * @since 1.5.0 * * @param int $value Value of zero. */ $id = apply_filters( 'embed_post_id', 0 ); $unfiltered_html = current_user_can( 'unfiltered_html' ); $default_discovery = false; // Since 4.4, WordPress is now an oEmbed provider. if ( function_exists( 'wp_oembed_register_route' ) ) { $unfiltered_html = true; $default_discovery = true; } /** * Filters whether or not oEmbed discovery is on. * * @since 1.5.0 * @since 2.5.0 Default status of oEmbed discovery has been switched * to true to apply changes introduced in WordPress 4.4 * * @param bool $default_discovery Current status of oEmbed discovery. */ $attr['discover'] = ( apply_filters( 'bp_embed_oembed_discover', $default_discovery ) && $unfiltered_html ); // Set up a new WP oEmbed object to check URL with registered oEmbed providers. if ( file_exists( ABSPATH . WPINC . '/class-wp-oembed.php' ) ) { require_once( ABSPATH . WPINC . '/class-wp-oembed.php' ); } else { // class-oembed.php is deprecated in WordPress 5.3.0. require_once( ABSPATH . WPINC . '/class-oembed.php' ); } $oembed_obj = _wp_oembed_get_object(); // If oEmbed discovery is true, skip oEmbed provider check. $is_oembed_link = false; if ( !$attr['discover'] ) { foreach ( (array) $oembed_obj->providers as $provider_matchmask => $provider ) { $regex = ( $is_regex = $provider[1] ) ? $provider_matchmask : '#' . str_replace( '___wildcard___', '(.+)', preg_quote( str_replace( '*', '___wildcard___', $provider_matchmask ), '#' ) ) . '#i'; if ( preg_match( $regex, $url ) ) $is_oembed_link = true; } // If url doesn't match a WP oEmbed provider, stop parsing. if ( !$is_oembed_link ) return $this->maybe_make_link( $url ); } return $this->parse_oembed( $id, $url, $attr, $rawattr ); } /** * Base function so BP components/plugins can parse links to be embedded. * * View an example to add support in {@link bp_activity_embed()}. * * on success. * oEmbed failure. * * @param int $id ID to do the caching for. * @param string $url The URL attempting to be embedded. * @param array $attr Shortcode attributes from {@link WP_Embed::shortcode()}. * @param array $rawattr Untouched shortcode attributes from * {@link WP_Embed::shortcode()}. * @return string The embed HTML on success, otherwise the original URL. */ public function parse_oembed( $id, $url, $attr, $rawattr ) { $id = intval( $id ); if ( $id ) { // Setup the cachekey. $cachekey = '_oembed_' . md5( $url . serialize( $attr ) ); // Let components / plugins grab their cache. $cache = ''; /** * Filters the cache value to be used in the oEmbed, if exists. * * @since 1.5.0 * * @param string $cache Empty initial cache value. * @param int $id ID that the caching is for. * @param string $cachekey Key to use for the caching in the database. * @param string $url The URL attempting to be embedded. * @param array $attr Parsed shortcode attributes. * @param array $rawattr Unparsed shortcode attributes. */ $cache = apply_filters( 'bp_embed_get_cache', $cache, $id, $cachekey, $url, $attr, $rawattr ); // Grab cache and return it if available. if ( !empty( $cache ) ) { /** * Filters the found cache for the provided URL. * * @since 1.5.0 * * @param string $cache Cached HTML markup for embed. * @param string $url The URL being embedded. * @param array $attr Parsed shortcode attributes. * @param array $rawattr Unparased shortcode attributes. */ return apply_filters( 'bp_embed_oembed_html', $cache, $url, $attr, $rawattr ); // If no cache, ping the oEmbed provider and cache the result. } else { $html = wp_oembed_get( $url, $attr ); $cache = ( $html ) ? $html : $url; /** * Fires if there is no existing cache and triggers cache setting. * * Lets components / plugins save their cache. * * @since 1.5.0 * * @param string $cache Newly cached HTML markup for embed. * @param string $cachekey Key to use for the caching in the database. * @param int $id ID to do the caching for. */ do_action( 'bp_embed_update_cache', $cache, $cachekey, $id ); // If there was a result, return it. if ( $html ) { /** This filter is documented in bp-core/classes/class-bp-embed.php */ return apply_filters( 'bp_embed_oembed_html', $html, $url, $attr, $rawattr ); } } } // Still unknown. return $this->maybe_make_link( $url ); }} |
Changelog Changelog
| Version | Description |
|---|---|
| 1.5.0 | Introduced. |
Methods Methods
- __construct — Constructor
- parse_oembed — Base function so BP components/plugins can parse links to be embedded.
- shortcode — The {@link do_shortcode()} callback function.