Merge pull request #528 from 10up/feature/526-overrride-audio-player

#526 - Provide ability to override Audio Player Controls via filter.
10up · Jul 12, 2023 · e2ee0c3 · e2ee0c3
2 parents 3d7cd23 + a4eede4
commit e2ee0c3
Showing 1 changed file with 48 additions and 19 deletions.
diff --git a/includes/Classifai/Providers/Azure/TextToSpeech.php b/includes/Classifai/Providers/Azure/TextToSpeech.php
@@ -604,18 +604,14 @@ public function save_post_metadata( $post_id ) {
 	 * @return string
 	 */
 	public function render_post_audio_controls( $content ) {
-		global $post;
 
-		if ( ! $post ) {
-			return $content;
-		}
+		$_post = get_post();
 
-		if ( ! in_array( $post->post_type, self::get_supported_post_types(), true ) ) {
+		if ( ! $_post instanceof \WP_Post ) {
 			return $content;
 		}
 
-		$is_audio_enabled = get_post_meta( $post->ID, self::SYNTHESIZE_SPEECH_KEY, true );
-		if ( 'no' === $is_audio_enabled ) {
+		if ( ! in_array( $_post->post_type, self::get_supported_post_types(), true ) ) {
 			return $content;
 		}
 
@@ -625,16 +621,21 @@ public function render_post_audio_controls( $content ) {
 		 * @since 2.2.0
 		 * @hook classifai_disable_post_to_audio_block
 		 *
-		 * @param {bool} $is_disabled Whether to disable the display or not. By default - false.
-		 * @param {bool} $post_id     Post ID.
+		 * @param  {bool}    $is_disabled Whether to disable the display or not. By default - false.
+		 * @param  {WP_Post} $_post       The Post object.
 		 *
 		 * @return {bool} Whether the audio block should be shown.
 		 */
-		if ( apply_filters( 'classifai_disable_post_to_audio_block', false, $post->ID ) ) {
+		if ( apply_filters( 'classifai_disable_post_to_audio_block', false, $_post ) ) {
+			return $content;
+		}
+
+		$is_audio_enabled = get_post_meta( $_post->ID, self::SYNTHESIZE_SPEECH_KEY, true );
+		if ( 'no' === $is_audio_enabled ) {
 			return $content;
 		}
 
-		$audio_attachment_id = (int) get_post_meta( $post->ID, self::AUDIO_ID_KEY, true );
+		$audio_attachment_id = (int) get_post_meta( $_post->ID, self::AUDIO_ID_KEY, true );
 
 		if ( ! $audio_attachment_id ) {
 			return $content;
@@ -646,6 +647,40 @@ public function render_post_audio_controls( $content ) {
 			return $content;
 		}
 
+		$audio_timestamp = (int) get_post_meta( $_post->ID, self::AUDIO_TIMESTAMP_KEY, true );
+
+		if ( $audio_timestamp ) {
+			$audio_attachment_url = add_query_arg( 'ver', filter_var( $audio_timestamp, FILTER_SANITIZE_NUMBER_INT ), $audio_attachment_url );
+		}
+
+		/**
+		 * Filters the audio player markup before display.
+		 *
+		 * Returning a non-false value from this filter will short-circuit building
+		 * the block markup and instead will return your custom markup prepended to
+		 * the post_content.
+		 *
+		 * Note that by using this filter, the custom CSS and JS files will no longer
+		 * be enqueued, so you'll be responsible for either loading them yourself or
+		 * loading custom ones.
+		 *
+		 * @hook classifai_pre_render_post_audio_controls
+		 * @since 2.2.3
+		 *
+		 * @param {bool|string} $markup               Audio markup to use. Defaults to false.
+		 * @param {string}      $content              Content of the current post.
+		 * @param {WP_Post}     $_post                The Post object.
+		 * @param {int}         $audio_attachment_id  The audio attachment ID.
+		 * @param {string}      $audio_attachment_url The URL to the audio attachment file.
+		 *
+		 * @return {bool|string} Custom audio block markup. Will be prepended to the post content.
+		 */
+		$markup = apply_filters( 'classifai_pre_render_post_audio_controls', false, $content, $_post, $audio_attachment_id, $audio_attachment_url );
+
+		if ( false !== $markup ) {
+			return (string) $markup . $content;
+		}
+
 		wp_enqueue_script(
 			'classifai-post-audio-player-js',
 			CLASSIFAI_PLUGIN_URL . 'dist/post-audio-controls.js',
@@ -662,12 +697,6 @@ public function render_post_audio_controls( $content ) {
 			'all'
 		);
 
-		$audio_timestamp = (int) get_post_meta( $post->ID, self::AUDIO_TIMESTAMP_KEY, true );
-
-		if ( $audio_timestamp ) {
-			$audio_attachment_url = add_query_arg( 'ver', filter_var( $audio_timestamp, FILTER_SANITIZE_NUMBER_INT ), $audio_attachment_url );
-		}
-
 		ob_start();
 
 		?>
@@ -691,9 +720,9 @@ public function render_post_audio_controls( $content ) {
 								 *
 								 * @return {string} Filtered text.
 								 */
-								apply_filters( 'classifai_listen_to_this_post_text', '%s %s', $post->ID ),
+								apply_filters( 'classifai_listen_to_this_post_text', '%s %s', $_post->ID ),
 								esc_html__( 'Listen to this', 'classifai' ),
-								esc_html( $post->post_type )
+								esc_html( $_post->post_type )
 							);
 
 							echo wp_kses_post( $listen_to_post_text );