Changeset 40817

Timestamp:

05/22/2017 08:28:43 PM (7 years ago)

Author:

afercia

Message:

Themes: Improve the theme Custom Logo accessibility.

Uses the Site title as fallback value for the Custom Logo alt attribute when the original alt attribute is empty.

Props sami.keijonen, joedolson, sstoqnov, nobremarcos, gma992, LiamMcArthur, jjcomack.
Fixes #38768.

Location:

trunk

Files:

• src/wp-includes/general-template.php (modified) (1 diff)
• tests/phpunit/tests/general/template.php (modified) (2 diffs)

trunk/src/wp-includes/general-template.php

@@ -889 +889 @@
     // We have a logo. Logo is go.
     if ( $custom_logo_id ) {
+        $custom_logo_attr = array(
+            'class'    => 'custom-logo',
+            'itemprop' => 'logo',
+        );
+
+        /*
+         * If the logo alt attribute is empty, get the site title and explicitly
+         * pass it to the attributes used by wp_get_attachment_image().
+         */
+        $image_alt = get_post_meta( $custom_logo_id, '_wp_attachment_image_alt', true );
+        if ( empty( $image_alt ) ) {
+            $custom_logo_attr['alt'] = get_bloginfo( 'name', 'display' );
+        }
+
+        /*
+         * If the alt attribute is not empty, there's no need to explicitly pass
+         * it because wp_get_attachment_image() already adds the alt attribute.
+         */
         $html = sprintf( '<a href="%1$s" class="custom-logo-link" rel="home" itemprop="url">%2$s</a>',
             esc_url( home_url( '/' ) ),
-            wp_get_attachment_image( $custom_logo_id, 'full', false, array(
-                'class'    => 'custom-logo',
-                'itemprop' => 'logo',
-            ) )
+            wp_get_attachment_image( $custom_logo_id, 'full', false, $custom_logo_attr )
         );
     }

trunk/tests/phpunit/tests/general/template.php

@@ -308 +308 @@
 
         $this->_set_custom_logo();
+
+        $custom_logo_attr = array(
+            'class'    => 'custom-logo',
+            'itemprop' => 'logo',
+        );
+
+        // If the logo alt attribute is empty, use the site title.
+        $image_alt = get_post_meta( $this->custom_logo_id, '_wp_attachment_image_alt', true );
+        if ( empty( $image_alt ) ) {
+            $custom_logo_attr['alt'] = get_bloginfo( 'name', 'display' );
+        }
+
         $home_url = get_home_url( $blog_id, '/' );
-        $image    = wp_get_attachment_image( $this->custom_logo_id, 'full', false, array(
-            'class'     => 'custom-logo',
-            'itemprop'  => 'logo',
-        ) );
+        $image    = wp_get_attachment_image( $this->custom_logo_id, 'full', false, $custom_logo_attr );
         restore_current_blog();
 
@@ -329 +338 @@
 
         $this->_set_custom_logo();
+
+        $custom_logo_attr = array(
+            'class'    => 'custom-logo',
+            'itemprop' => 'logo',
+        );
+
+        // If the logo alt attribute is empty, use the site title.
+        $image_alt = get_post_meta( $this->custom_logo_id, '_wp_attachment_image_alt', true );
+        if ( empty( $image_alt ) ) {
+            $custom_logo_attr['alt'] = get_bloginfo( 'name', 'display' );
+        }
+
+        $image = wp_get_attachment_image( $this->custom_logo_id, 'full', false, $custom_logo_attr );
+
+        $this->expectOutputString( '<a href="http://' . WP_TESTS_DOMAIN . '/" class="custom-logo-link" rel="home" itemprop="url">' . $image . '</a>' );
+        the_custom_logo();
+    }
+
+    /**
+     * @group custom_logo
+     * @ticket 38768
+     */
+    function test_the_custom_logo_with_alt() {
+        $this->_set_custom_logo();
+
+        $image_alt = 'My alt attribute';
+
+        update_post_meta( $this->custom_logo_id, '_wp_attachment_image_alt', $image_alt );
+
         $image = wp_get_attachment_image( $this->custom_logo_id, 'full', false, array(
-            'class'     => 'custom-logo',
-            'itemprop'  => 'logo',
+            'class'    => 'custom-logo',
+            'itemprop' => 'logo',
         ) );