get_uploaded_header_images(); should provide alternate text of that image

[francoeurdavid]

That method should provide the Alternate Text of each images along with all the stuff that is already provided.

Same code is up from 3.2.0.

The method is located in wp-includes/themes.php
2 lines of code are to be added.

[francoeurdavid]

patch

[francoeurdavid]

I uploaded a patch.

[helen]

Seems reasonable.

[voldemortensen]

Updated patch to current trunk.

[celloexpressions]

Related/possible duplicate: #15926.

[valendesigns]

I've refreshed the patch and fixed a typo, plus tested that it works as expected. Looks good and moving for commit.

[obenland]

What are we going to do with the additional information?

[valendesigns]

@obenland I think the argument here is that the data should be provided regardless of if Core uses it or not. Someone could directly use the get_uploaded_header_images function and there is no alternative text attached to the return array. It should be and it doesn't hurt to add it. As well, Core is doing it wrong when it comes to adding alt text to the header images as it's using the description field, which is very confusing. This patch would allow us to fix that in a future ticket.

[obenland]

Replying to valendesigns:

@obenland I think the argument here is that the data should be provided regardless of if Core uses it or not.

Playing devil's advocate: Why?

Can we find a sane use case for it in core?

[valendesigns]

In Core we currently use the description field to set the alternate text for the header images even though there is a field that is specific for this very purpose in the media uploaded that is not being used. Do you want line numbers of where we could make these changes or does that make enough sense to move this forward?

[obenland]

Replying to valendesigns:

Do you want line numbers of where we could make these changes or does that make enough sense to move this forward?

Sounds good, do you want to create a patch for it?

[obenland]

@valendesigns, any movement on this?

[valendesigns]

My bad! I'll get it sorted this weekend.

[valendesigns]

@obenland I think that this patch should remain as is and not change other parts of Core. This is more for convenience and would give theme authors access to the alt text by default.

Though I think after looking at other parts of Core the array key should be set to alt_text instead of alt, which is what the get_uploaded_header_images() method in the Custom_Image_Header class uses. I can upload another patch but wanted to get your opinion first.

[obenland]

Replying to valendesigns:

@obenland I think that this patch should remain as is and not change other parts of Core. This is more for convenience and would give theme authors access to the alt text by default.

I think we should check for the alt text here and make description the fallback, like it's done in the customizer.

Though I think after looking at other parts of Core the array key should be set to alt_text instead of alt, which is what the get_uploaded_header_images() method in the Custom_Image_Header class uses. I can upload another patch but wanted to get your opinion first.

No objections to alt_text.

[valendesigns]

I've updated custom-header.php so it uses the alt text with a description fallback. Though if I navigate to custom-header.php in the admin I get a black screen, so I'm not sure how I should be testing that it works correctly.

[obenland]

Replying to valendesigns:

I've updated custom-header.php so it uses the alt text with a description fallback. Though if I navigate to custom-header.php in the admin I get a black screen, so I'm not sure how I should be testing that it works correctly.

It's testable at /wp-admin/themes.php?page=custom-header.

[obenland]

In 32998:

Provide alt text for uploaded header images.

The custom header screen will use it rather then the description,
if an alt text is set.

Props francoeurdavid, voldemortensen, valendesigns.
Fixes #27959.

[francoeurdavid]

Thanks to you guys, I barely did anything. I'm impressed by all the work you've done for such a small fixes. I realize there are a lot of things I didn't think about.

Thanks again for the good job, and even if I didn't say anything, I was following up closely :)