BP_Activity_oEmbed_Extension::use_custom_iframe_sandbox_attribute( string $result, object $data, string $url )

Use our custom <iframe> sandbox attribute in our oEmbed response.

Description

WordPress sets the sandbox attribute to ‘allow-scripts’ regardless of whatever the oEmbed response is in <a href="https://www.buddyboss.com/resources/reference/functions/wp_filter_oembed_result">wp_filter_oembed_result()</a>. We need to add back our custom sandbox value so links will work.</p> <h3>See also</h3> <ul> <li><a href="https://www.buddyboss.com/resources/reference/classes/BP_Activity_Component/modify_iframe">BP_Activity_Component::modify_iframe()</a>: where our custom sandbox value is set.</li> </ul> </section> <section class="parameters"> <h3 id="ref-params" class="ref-context">Parameters<span id="ref-params-link" class="ref-context-link"></span></h3> <dl> <dt>$result</dt> <dd> <p class="desc"> <span class="type">(<span class="string">string</span>)</span> <span class="required">(Required)</span> <span class="description">The oEmbed HTML result.</span> </p> </dd> <dt>$data</dt> <dd> <p class="desc"> <span class="type">(<span class="object">object</span>)</span> <span class="required">(Required)</span> <span class="description">A data object result from an oEmbed provider.</span> </p> </dd> <dt>$url</dt> <dd> <p class="desc"> <span class="type">(<span class="string">string</span>)</span> <span class="required">(Required)</span> <span class="description">The URL of the content to be embedded.</span> </p> </dd> </dl> </section> <section class="return"> <h3 id="ref-return" class="ref-context">Return<span id="ref-return-link" class="ref-context-link"></span></h3> <p><span class='return-type'>(string)</span> </p> </section> <section class="source-content"> <h3 id="ref-source" class="ref-context">Source<span id="ref-source-link" class="ref-context-link"></span></h3> <p> File: <a href="https://www.buddyboss.com/resources/reference/files/bp-activity/classes/class-bp-activity-oembed-extension.php/">bp-activity/classes/class-bp-activity-oembed-extension.php</a> </p> <div class="source-code-container"> <pre class="brush: php; toolbar: false; first-line: 213"> public function use_custom_iframe_sandbox_attribute( $result, $data, $url ) { // Make sure we are on a BuddyBoss activity oEmbed request. if ( false === isset( $data->x_buddypress ) || 'activity' !== $data->x_buddypress ) { return $result; } // Get unfiltered sandbox attribute from our own oEmbed response. $sandbox_pos = strpos( $data->html, 'sandbox=' ) + 9; $sandbox = substr( $data->html, $sandbox_pos, strpos( $data->html, '"', $sandbox_pos ) - $sandbox_pos ); // Replace only if our sandbox attribute contains 'allow-top-navigation'. if ( false !== strpos( $sandbox, 'allow-top-navigation' ) ) { $result = str_replace( ' sandbox="allow-scripts"', " sandbox=\"{$sandbox}\"", $result ); // Also remove 'security' attribute; this is only used for IE < 10. $result = str_replace( 'security="restricted"', "", $result ); } return $result; } </pre> </div> <p class="source-code-links"> <span> <a href="#" class="show-complete-source">Expand full source code</a> <a href="#" class="less-complete-source">Collapse full source code</a> </span> </p> </section> <section class="changelog"> <h3 id="ref-changelog" class="ref-context">Changelog<span id="ref-changelog-link" class="ref-context-link"></span></h3> <table> <caption class="screen-reader-text">Changelog</caption> <thead> <tr> <th class="changelog-version">Version</th> <th class="changelog-desc">Description</th> </tr> </thead> <tbody> <tr> <td><a href="https://www.buddyboss.com/resources/reference/since/buddypress.2.6.0/" alt="WordPress BuddyPress 2.6.0">BuddyPress 2.6.0</a></td> <td>Introduced.</td> </tr> </tbody> </table> </section> <section class="ref-feedback-wrap"> <h3>Questions?</h3> <p>We're always happy to help with code or other questions you might have! Search our <a href="https://www.buddyboss.com/resources/reference/">developer docs</a>, <a href="https://www.buddyboss.com/my-account/?tab=helpscouttickets">contact support</a>, or connect with our <a href="https://www.buddyboss.com/buddypress-developers/">sales team</a>. </p> </section> </div> </div> </div> </div> </article> </main> </div> </div> </div> </div> </div> <footer class="footer-bottom bb-footer style-1"> <div class="container flex"> <div class="footer-bottom-left"> <div class="copyright">© 2024 • BuddyBoss</div> </div><div class="footer-bottom-right push-right"></div> </div> </footer> </div>   <script> !function(f,b,e,v,n,t,s) {if(f.fbq)return;n=f.fbq=function(){n.callMethod? n.callMethod.apply(n,arguments):n.queue.push(arguments)}; if(!f._fbq)f._fbq=n;n.push=n;n.loaded=!0;n.version='2.0'; n.queue=[];t=b.createElement(e);t.async=!0; t.src=v;s=b.getElementsByTagName(e)[0]; s.parentNode.insertBefore(t,s)}(window, document,'script', 'https://connect.facebook.net/en_US/fbevents.js'); fbq('init', '617688858328656'); fbq('track', 'PageView'); </script> <noscript><img height="1" width="1" style="display:none"src="https://www.facebook.com/tr?id=617688858328656&ev=PageView&noscript=1"/></noscript>     <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-NB2BV5J" height="0" width="0" style="display:none;visibility:hidden">

Contents

Description