Opened 2 years ago
Closed 2 years ago
#56625 closed defect (bug) (fixed)
Bad link in doc caused by docblock typo
Reported by: | Camwynsp | Owned by: | davidbaumwald |
---|---|---|---|
Milestone: | 6.1 | Priority: | normal |
Severity: | normal | Version: | 4.6 |
Component: | General | Keywords: | needs-patch good-first-bug commit |
Focuses: | docs | Cc: |
Description
In https://developer.wordpress.org/reference/functions/_deprecated_function/#description
The link to https://developer.wordpress.org/reference/hooks/deprecated_function_run/ is malformed, instead sending you to https://developer.wordpress.org/reference/functions/%e2%80%98hook-deprecated_function_run%e2%80%99 (bad link)
It looks like the docblock text formatting caused it to do so.
See: https://github.com/WordPress/wordpress-develop/blob/6.0.2/src/wp-includes/functions.php#L5332 (hook is inside the quotes)
Attachments (1)
Change History (8)
#3
@
2 years ago
- Focuses docs added
- Keywords needs-patch good-first-bug added
- Milestone changed from Awaiting Review to 6.1
- Version set to 4.6
@Camwynsp Thanks for the ticket and welcome to WordPress core Trac!!
This indeed does need to be fixed. This seems to trace back to r37543. Let's resolve this in 6.1.
#4
@
2 years ago
Hi there, thanks for the ticket!
Just to clarify a bit for others looking at the ticket (I misread it initially), the {@see 'hook_name'}
format itself is fine and is used in many other places in core.
There appear to be two disctinct issues here:
- The hook in question has a
hook
word inside the quotes:There is a {@see 'hook deprecated_function_run'}
That should be fixed, as noted in comment:3:There is a hook {@see 'deprecated_function_run'}
- Something weird is going on with hook links in general on the developer.wordpress.org side too, as noted in comment:1. That is unrelated to this particular hook and needs more investigation.
#5
@
2 years ago
Hi @Camwynsp, Thanks for the ticket. @SergeyBiryukov I added the patch for the 1st issue.
This seems to be an issue on the developer.wordpress.org side of things, since all links for deprecated functions no longer links correct pages. The ´ characters are used to format the links on developer.wordpress.org.
See e.g. https://developer.wordpress.org/reference/hooks/edit_category_form_pre/