Changeset 51978

Timestamp:

11/02/2021 05:20:35 PM (3 years ago)

Author:

johnjamesjacoby

Message:

Themes: Introduce get_header_image_tag_attributes hook.

This change adds a filter inside of the get_header_image_tag() function allowing developers to filter the attributes of the header image HTML tag before they are escaped, concatenated, and returned.

Before this change, it was not possible to externally and preemptively intercept this array of attributes. After this change, these attributes can now be easily filtered, matching it nicely to the wp_get_attachment_image_attributes hook.

Props audrasjb, chaion07, junaidbhura, sabernhardt.

Fixes #38942.

File:

• trunk/src/wp-includes/theme.php (modified) (1 diff)

trunk/src/wp-includes/theme.php

@@ -1234 +1234 @@
         }
     }
+
+    /*
+     * Filters the list of header image attributes.
+     *
+     * @since 5.9.0
+     *
+     * @param array  $attr   Array of the attributes for the image tag.
+     * @param object $header The custom header object returned by 'get_custom_header()'.
+     */
+    $attr = apply_filters( 'get_header_image_tag_attributes', $attr, $header );
 
     $attr = array_map( 'esc_attr', $attr );