Make WordPress Core

Opened 11 years ago

Closed 11 years ago

#25420 closed enhancement (fixed)

Document get_header_image() return value better

Reported by: rulatir's profile rulatir Owned by:
Milestone: WordPress.org Priority: normal
Severity: normal Version:
Component: WordPress.org Site Keywords:
Focuses: Cc:

Description

The documentation for get_header_image() here:

http://codex.wordpress.org/Function_Reference/get_header_image

says that the function returns "header image path". If the word path is to be understood as it is apparently understood throughout the Codex, then this documentation is incorrect, because the function actually returns a url, not a path.

I realized only now that I was getting a full HTTP URL with scheme, host and path from this function. I was happily passing it to getimagesize() and it just happened to work because allow_url_fopen was on. Then the customer moved the site to another hosting account (with the same provider but different setup) and it stopped working.

Change History (1)

#1 @SergeyBiryukov
11 years ago

  • Milestone changed from Awaiting Review to WordPress.org
  • Resolution set to fixed
  • Status changed from new to closed

I've corrected the inaccurate description. The Codex is a wiki, anyone with a WordPress.org account can make changes there.

Note: See TracTickets for help on using tickets.