How to use display_media_states filter in WordPress

display_media_states filter

Filters the default media display states for items in the Media list table.

To use `display_media_states` 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_display_media_states_defaults` which takes 2 parameters and we registered it using `add_filter`. The first parameter `display_media_states` is the name of the hook, the second parameter `weplugins_modify_display_media_states_defaults` is the name of the function which needs to be called, the 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 `display_media_states` filter.

Parameters

Below are the 2 parameters required to use this hook.

• $media_states : (string[]) An array of media states. Default ‘Header Image’, ‘Background Image’, ‘Site Icon’, ‘Logo’.
• $post : (WP_Post) The current attachment object.

Live Examples

Example 1: Basic Usage

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

  function weplugins_modify_display_media_states_defaults($media_states, $post) { 
      // Update the $media_states variable according to your website requirements and return this variable. You can modify the $media_states variable conditionally too if you want.
      return $media_states; 
  }
  // Add the filter
  add_filter("display_media_states", "weplugins_modify_display_media_states_defaults", 10, 2);
  

Example 2: Conditional Modification

This example shows how to conditionally modify the media states based on the post type.

  function weplugins_modify_display_media_states_conditional($media_states, $post) {
      if ($post->post_type == 'attachment') {
          $media_states[] = 'Custom State';
      }
      return $media_states;
  }
  // Add the filter
  add_filter("display_media_states", "weplugins_modify_display_media_states_conditional", 10, 2);
  

Example 3: Removing the Hook

To remove a hook callback, use the example below.

  // Remove the filter
  remove_filter("display_media_states", "weplugins_modify_display_media_states_defaults", 10, 2);
  

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 Us and we’d be happy to assist you.