How to use media_library_show_audio_playlist filter in WordPress

media_library_show_audio_playlist filter

By default, the “Create Audio Playlist” button will always be shown in the media library. If this filter returns null, a query will be run to determine whether the media library contains any audio items. This was the default behavior prior to version 4.8.0, but this query is expensive for large media libraries.

To use media_library_show_audio_playlist filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins, always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function weplugins_modify_media_library_show_audio_playlist_defaults which takes 1 parameter and we registered using add_filter. The first parameter media_library_show_audio_playlist is the name of the hook, the second parameter weplugins_modify_media_library_show_audio_playlist_defaults is the name of the function which needs to be called, third parameter is the priority of calling the hook if the same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_filter to remove media_library_show_audio_playlist filter.

Parameters

Below the 1 parameter is required to use this hook.

• $show : (bool|null) Whether to show the button, or null to decide based on whether any audio files exist in the media library.

Live Example

apply_filters( 'media_library_show_audio_playlist', bool|null $show )

Below is an example of how you can use this hook.

Example 1: Modify the Show Audio Playlist Button

This example demonstrates how to modify the visibility of the “Create Audio Playlist” button based on custom logic.

    function weplugins_modify_media_library_show_audio_playlist_defaults($show) { 
        // Update the $show variable according to your website requirements and return this variable. You can modify the $show variable conditionally too if you want.
        return $show; 
    }
    // add the filter
    add_filter( "media_library_show_audio_playlist", "weplugins_modify_media_library_show_audio_playlist_defaults", 10, 1 );
    

Example 2: Conditional Logic for Audio Files

In this example, we show the button only if there are more than 5 audio files in the media library.

    function weplugins_modify_media_library_show_audio_playlist_defaults($show) {
        $audio_count = count(get_audio_files()); // Assume get_audio_files() returns an array of audio files
        if ($audio_count > 5) {
            $show = true;
        } else {
            $show = false;
        }
        return $show;
    }
    add_filter( "media_library_show_audio_playlist", "weplugins_modify_media_library_show_audio_playlist_defaults", 10, 1 );
    

Example 3: Completely Hide the Button

This example hides the “Create Audio Playlist” button altogether.

    function weplugins_modify_media_library_show_audio_playlist_defaults($show) {
        return false;
    }
    add_filter( "media_library_show_audio_playlist", "weplugins_modify_media_library_show_audio_playlist_defaults", 10, 1 );
    

To remove a hook callback, use the example below.

remove_filter( "media_library_show_audio_playlist", "weplugins_modify_media_library_show_audio_playlist_defaults", 10, 1 );

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Contact Us

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.