playerHtml() . $content;
}
/**
* Player HTML.
*
* Displays JS SDK variant of the BeyondWords audio player, for both
* AMP and non-AMP content.
*
* @SuppressWarnings(PHPMD.NPathComplexity)
*
* @param WP_Post $post WordPress Post.
*
* @since 3.0.0
* @since 3.1.0 Added _doing_it_wrong deprecation warnings
*
* @return string
*/
public function playerHtml($post = false)
{
if (! ($post instanceof \WP_Post)) {
$post = get_post($post);
}
if (! $post) {
return '';
}
if (! $this->isPlayerEnabled($post)) {
return '';
}
$projectId = PostMetaUtils::getProjectId($post->ID);
if (! $projectId) {
return '';
}
$podcastId = PostMetaUtils::getContentId($post->ID);
if (! $podcastId) {
return '';
}
// AMP or JS Player?
if ($this->useAmpPlayer()) {
$html = $this->ampPlayerHtml($post->ID, $projectId, $podcastId);
} else {
$html = $this->jsPlayerHtml($post->ID, $projectId, $podcastId);
}
return $html;
}
/**
* Has custom player?
*
* Checks the post content to see whether a custom player has been added.
*
* @param int $postId WordPress Post ID.
*
* @since 3.2.0
*
* @return boolean
*/
public function hasCustomPlayer($postId)
{
$content = get_the_content(null, false, $postId);
$crawler = new Crawler($content);
return count($crawler->filterXPath('//div[@data-beyondwords-player="true"]')) > 0;
}
/**
* JS Player HTML.
*
* Displays the HTML required for the JS player.
*
* @param int $postId WordPress Post ID.
* @param int $projectId BeyondWords Project ID.
* @param int $podcastId BeyondWords Podcast ID.
*
* @since 3.0.0
* @since 3.1.0 Added speechkit_js_player_html filter
*
* @return string
*/
public function jsPlayerHtml($postId, $projectId, $podcastId)
{
$html = '';
if (! $this->hasCustomPlayer($postId)) {
$html .= '';
}
/**
* Filters the HTML of the BeyondWords Player.
*
* @since 4.0.0
*
* @param string $html The HTML for the JS audio player. The audio player JavaScript may
* fail to locate the target element if you remove or replace the
* default contents of this parameter.
* @param int $post_id WordPress post ID.
* @param int $project_id BeyondWords project ID.
* @param int $podcast_id BeyondWords podcast ID.
*/
$html = apply_filters('beyondwords_player_html', $html, $postId, $projectId, $podcastId);
/**
* Filters the HTML of the BeyondWords JS audio player.
*
* @since 3.3.3
* @deprecated Scheduled for removal in v5.0
*
* @param string $html The HTML for the JS audio player. The audio player JavaScript may
* fail to locate the target element if you remove or replace the
* default contents of this parameter.
* @param int $post_id WordPress post ID.
* @param int $project_id BeyondWords project ID.
* @param int $podcast_id BeyondWords podcast ID.
*/
$html = apply_filters('beyondwords_js_player_html', $html, $postId, $projectId, $podcastId);
return $html;
}
/**
* AMP Player HTML.
*
* Displays the HTML required for the AMP player.
*
* @param int $postId WordPress Post ID.
* @param int $projectId BeyondWords Project ID.
* @param int $podcastId BeyondWords Podcast ID.
*
* @since 3.0.0
* @since 3.1.0 Added speechkit_amp_player_html filter
*
* @return string
*/
public function ampPlayerHtml($postId, $projectId, $podcastId)
{
$src = sprintf(Environment::getAmpPlayerUrl(), $projectId, $podcastId);
// Turn on output buffering
ob_start();
?>
ID)) {
$enabled = false;
}
/**
* Filters the enabled/disabled (shown/hidden) status of the player for each post.
*
* @since 3.3.3
*
* @param boolean $enabled Is the player enabled (shown) for this post?
* @param int $post_id WordPress post ID.
*/
$enabled = apply_filters('beyondwords_post_player_enabled', $enabled, $post->ID);
return $enabled;
}
/**
* Register the JavaScript for the public-facing side of the site.
*
* @since 3.0.0
*
* @return void
*/
public function enqueueScripts()
{
if (! is_singular() && ! is_admin()) {
return;
}
// JS SDK Player script, filtered by $this->scriptLoaderTag()
add_filter('script_loader_tag', array($this, 'scriptLoaderTag'), 10, 3);
wp_enqueue_script(
'beyondwords-sdk',
Environment::getJsSdkUrlLegacy(),
array(),
null,
true
);
}
/**
* Use the AMP player?
*
* There are multiple AMP plugins for WordPress, so multiple checks are performed.
*
* @since 3.0.7
*
* @return bool
*/
public function useAmpPlayer()
{
// https://amp-wp.org/reference/function/amp_is_request/
if (function_exists('amp_is_request')) {
return \amp_is_request();
}
// https://ampforwp.com/tutorials/article/detect-amp-page-function/
if (function_exists('ampforwp_is_amp_endpoint')) {
return \ampforwp_is_amp_endpoint();
}
// https://amp-wp.org/reference/function/is_amp_endpoint/
if (function_exists('is_amp_endpoint')) {
return \is_amp_endpoint();
}
return false;
}
/**
* Filters the HTML script tag of an enqueued script.
*
* @param string $tag The
ID);
$podcastId = PostMetaUtils::getContentId($post->ID);
$skBackend = Environment::getBackendUrl();
$skBackendApi = Environment::getApiUrl();
$params = [
'projectId' => (int)$projectId,
'podcastId' => $podcastId,
];
if (get_option('beyondwords_player_size') === 'medium') {
$params['playerType'] = 'manual';
}
if (strlen($skBackend)) {
$params['skBackend'] = esc_url($skBackend);
}
if (is_admin()) {
$params['processingStatus'] = true;
$params['apiWriteKey'] = get_option('beyondwords_api_key', '');
if (strlen($skBackendApi)) {
$params['skBackendApi'] = esc_url($skBackendApi);
}
}
if (defined('BEYONDWORDS_DEBUG') && BEYONDWORDS_DEBUG) {
$params['debug'] = true;
}
/**
* Filters the BeyondWords JavaScript SDK parameters.
*
* @since 3.3.3
*
* @param array The default JS SDK params.
*/
$params = apply_filters('beyondwords_js_player_params', $params);
return $params;
}
/**
* Use Player JS SDK?
*
* @since 3.0.7
*
* @return string
*/
public function usePlayerJsSdk()
{
// AMP requests don't use the Player JS SDK
if ($this->useAmpPlayer()) {
return false;
}
// Gutenberg has a dedicated React component for the player
if (CoreUtils::isGutenbergPage()) {
return false;
}
// Disable audio player in Preview, because we have not sent updates to BeyondWords API yet
if (function_exists('is_preview') && is_preview()) {
return false;
}
$post = get_post();
if (! $post) {
return false;
}
$projectId = PostMetaUtils::getProjectId($post->ID);
if (! $projectId) {
return false;
}
$podcastId = PostMetaUtils::getContentId($post->ID);
if (! $podcastId) {
return false;
}
return true;
}
}