Make WordPress Core

Opened 19 months ago

Closed 3 months ago

#59169 closed defect (bug) (worksforme)

Deprecated arguments description is a bit misleading.

Reported by: sulemanhelp's profile sulemanhelp Owned by:
Milestone: Priority: normal
Severity: trivial Version:
Component: General Keywords: has-patch close
Focuses: docs Cc:

Description

Here: https://developer.wordpress.org/reference/functions/get_bloginfo/

in the description of the function

“Deprecated arguments include:

‘siteurl’ – Use ‘url’ instead”

is a bit misleading. “‘siteurl’ – Use ‘wpurl’ instead” is correct.

Change History (4)

This ticket was mentioned in PR #5053 on WordPress/wordpress-develop by @sulemanhelp.


19 months ago
#1

  • Keywords has-patch added

Small fix for get_bloginfo() function doc. 'siteurl' - Use 'url' instead was a bit misleading.

#2 @mukesh27
19 months ago

  • Keywords close added

Thanks @sulemanhelp for the ticket and PR. home and siteurl both use url so we don't need to update it.

#3 @SergeyBiryukov
19 months ago

Hi there, welcome to WordPress Trac! Thanks for the PR.

This might be a bit confusing, but as noted above, both home and siteurl fall through to the url value for backward compatibility, so the current documentation is correct.

Some history here:

  • [1157] added the siteurl value.
  • [1731] added the home and wpurl values.
  • [4983] / #3623 deprecated the home and siteurl values.
  • [12587] / #11652 added the _deprecated_argument() call.
  • [36382] / #35581 added the documentation for deprecated values.
  • [44565] / #45934 documented the intentional fall-through to the url value.

#4 @karmatosed
3 months ago

  • Milestone Awaiting Review deleted
  • Resolution set to worksforme
  • Status changed from new to closed

Thanks for reporting this @sulemanhelp as information around the context of this has been provided, I am going to progress with the recommendation for closed. Thank you everyone and if further information does surface that this also was a bug beyond expected behaviour we can always reopen.

I am going to mark with the status 'works for me' as this is expected based on the current documentation.

Note: See TracTickets for help on using tickets.