apply_filters( ‘wp_get_attachment_image_attributes’, string[] $attr, WP_Post $attachment, string|int[] $size )

User Contributed Notes

1. Skip to note 5 content

   Ian McDonald 7 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 5You must log in to vote on the helpfulness of this note

   This only seems to fire for featured images. At least, it’s the experience of this person on Stack Exchange, and of myself.
   https://wordpress.stackexchange.com/questions/266702/wp-get-attachment-image-attributes-not-working-for-me
2. Skip to note 6 content

   Drew Jaynes 10 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   Add a data attribute to each <img> tag in a gallery
   Note: this filter runs inside wp_get_attachment_image(), which means your attribute will be added for all uses of the function.

   /**
    * Filter attributes for the current gallery image tag to add a 'data-full'
    * data attribute.
    *
    * @param array   $atts       Gallery image tag attributes.
    * @param WP_Post $attachment WP_Post object for the attachment.
    * @return array (maybe) filtered gallery image tag attributes.
    */
   function wpdocs_filter_gallery_img_atts( $atts, $attachment ) {
   	if ( $full_size = wp_get_attachment_image_src( $attachment->ID, 'full' ) ) {
   		if ( ! empty( $full_size[0] ) ) {
   			$atts['data-full'] = $full_size[0];
   		}
   	}
   	return $atts;
   }
   add_filter( 'wp_get_attachment_image_attributes', 'wpdocs_filter_gallery_img_atts', 10, 2 );
3. Skip to note 7 content

   leymannx 8 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   /**
    * Add classes to the cutom logo.
    */
   add_filter( 'wp_get_attachment_image_attributes', function ( $attr ) {
   
   	if ( isset( $attr['class'] ) && 'custom-logo' === $attr['class'] ) {
   		$attr['class'] = 'custom-logo foo-bar NEW CLASSES HERE';
   	}
   
   	return $attr;
   } );
4. Skip to note 8 content

   akkis 7 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

   You can add custom data attributes to image elements by adding this snippet on theme’s function.php:

       /**
        * Add custom data attribute to every image element
        */
       add_filter( 'wp_get_attachment_image_attributes', 'add_custom_image_data_attributes', 10, 3 );
       function add_custom_image_data_attributes( $attr, $attachment, $size ) {
           
           // Ensure that the <img> doesn't have the data attribute already
           if ( ! array_key_exists( 'data-custom', $attr ) ) {
               $attr['data-custom'] = 'dummy text';
           }
   
           return $attr;
       }

   Also, note that I use array_key_exists() PHP function instead of isset() because isset() does not return TRUE for array keys that correspond to a NULL value, while array_key_exists() does as of PHP Manual (http://php.net/manual/en/function.array-key-exists.php).