How to use get_attached_media_args filter in WordPress

get_attached_media_args filter

Filters arguments used to retrieve media attached to the given post.

To use `get_attached_media_args` 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_get_attached_media_args_defaults` which takes 3 parameters and we registered using `add_filter`. The first parameter `get_attached_media_args` is the name of the hook, the second parameter `weplugins_modify_get_attached_media_args_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 the `get_attached_media_args` filter.

Parameters

Below are the 3 parameters required to use this hook.

• $args : (array) Post query arguments.
• $type : (string) Mime type of the desired media.
• $post : (WP_Post) Post object.

Live Example

apply_filters( 'get_attached_media_args', array $args, string $type, WP_Post $post )

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

  function weplugins_modify_get_attached_media_args_defaults($args, $type, $post) { 
      // Update the $args variable according to your website requirements and return this variable. You can modify the $args variable conditionally too if you want.
      return $args; 
  }
  // add the filter
  add_filter( "get_attached_media_args", "weplugins_modify_get_attached_media_args_defaults", 10, 3 );
  

To remove a hook callback, use the example below.

  remove_filter( "get_attached_media_args", "weplugins_modify_get_attached_media_args_defaults", 10, 3 );
  

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

Example 1: Customizing Media Query Arguments

This example demonstrates how to modify the default media query arguments to include attachments of a specific type.

  function weplugins_modify_get_attached_media_args_1($args, $type, $post) {
      if ($type == 'image') {
          $args['post_mime_type'] = 'image/jpeg';
      }
      return $args;
  }
  add_filter('get_attached_media_args', 'weplugins_modify_get_attached_media_args_1', 10, 3);
  

Example 2: Filtering Media Based on Post Type

Here, we modify the media query arguments to fetch media attached to posts of a specific type.

  function weplugins_modify_get_attached_media_args_2($args, $type, $post) {
      if ($post->post_type == 'custom_post_type') {
          $args['post_status'] = 'publish';
      }
      return $args;
  }
  add_filter('get_attached_media_args', 'weplugins_modify_get_attached_media_args_2', 10, 3);
  

Example 3: Adding a Custom Argument

In this example, we add a custom argument to the media query arguments.

  function weplugins_modify_get_attached_media_args_3($args, $type, $post) {
      $args['meta_query'] = array(
          array(
              'key' => '_custom_meta_key',
              'value' => 'custom_value',
              'compare' => '='
          )
      );
      return $args;
  }
  add_filter('get_attached_media_args', 'weplugins_modify_get_attached_media_args_3', 10, 3);
  

Contact Us

If you need any customization or assistance, feel free to Contact Us.