<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][9550] trunk/src/bp-core/classes/class-bp-embed.php: Adds hooks documentation for class-bp-embed.php.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/9550">9550</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/9550","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>tw2113</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-02-24 03:32:34 +0000 (Tue, 24 Feb 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Adds hooks documentation for class-bp-embed.php.
See <a href="http://buddypress.trac.wordpress.org/ticket/5940">#5940</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcoreclassesclassbpembedphp">trunk/src/bp-core/classes/class-bp-embed.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcoreclassesclassbpembedphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/classes/class-bp-embed.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/classes/class-bp-embed.php 2015-02-24 03:26:17 UTC (rev 9549)
+++ trunk/src/bp-core/classes/class-bp-embed.php 2015-02-24 03:32:34 UTC (rev 9550)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -54,6 +54,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_get_the_thread_message_content', array( &$this, 'run_shortcode' ), 7 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the BuddyPress Core oEmbed setup.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param BP_Embed $this Current instance of the BP_Embed. Passed by reference.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'bp_core_setup_oembed', array( &$this ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -94,16 +101,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $handlers as $hid => $handler ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( preg_match( $handler['regex'], $url, $matches ) && is_callable( $handler['callback'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false !== $return = call_user_func( $handler['callback'], $matches, $attr, $url, $rawattr ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the oEmbed handler result for the provided URL.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param string $return Handler callback for the oEmbed.
+ * @param string $url URL attempting to be embedded.
+ * @param array $attr Shortcode attributes.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'embed_handler_html', $return, $url, $attr );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Get object ID
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the embed object ID.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param int $value Value of zero.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $id = apply_filters( 'embed_post_id', 0 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Is oEmbed discovery on?
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters whether or not oEmbed discovery is on.
+ *
+ * @since BuddyPress (1.5.0)
+ *
+ * @param bool $value Current status of oEmbed discovery.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $attr['discover'] = ( apply_filters( 'bp_embed_oembed_discover', false ) && current_user_can( 'unfiltered_html' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Set up a new WP oEmbed object to check URL with registered oEmbed providers
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -156,10 +185,34 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Let components / plugins grab their cache
</span><span class="cx" style="display: block; padding: 0 10px"> $cache = '';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the cache value to be used in the oEmbed, if exists.
+ *
+ * @since BuddyPress (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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $cache = apply_filters( 'bp_embed_get_cache', $cache, $id, $cachekey, $url, $attr, $rawattr );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Grab cache and return it if available
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !empty( $cache ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the found cache for the provided URL.
+ *
+ * @since BuddyPress (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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_embed_oembed_html', $cache, $url, $attr, $rawattr );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If no cache, ping the oEmbed provider and cache the result
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -167,12 +220,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $html = wp_oembed_get( $url, $attr );
</span><span class="cx" style="display: block; padding: 0 10px"> $cache = ( $html ) ? $html : $url;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Let components / plugins save their cache
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Fires if there is no existing cache and triggers cache setting.
+ *
+ * Lets components / plugins save their cache.
+ *
+ * @since BuddyPress (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.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> do_action( 'bp_embed_update_cache', $cache, $cachekey, $id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If there was a result, return it
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $html )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $html ) {
+
+ /** This filter is documented in bp-core/classes/class-bp-embed.php */
</ins><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'bp_embed_oembed_html', $html, $url, $attr, $rawattr );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>