Opened 4 years ago
Closed 4 years ago
#56625 closed defect (bug) (fixed)
Bad link in doc caused by docblock typo
| Reported by: | Camwynsp | Owned by: | davidbaumwald |
|---|---|---|---|
| Priority: | normal | Milestone: | 6.1 |
| Component: | General | Version: | 4.6 |
| Severity: | normal | Keywords: | needs-patch good-first-bug commit |
| Cc: | Focuses: | docs |
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
@
4 years ago
- Focuses docs added
- Keywords needs-patch good-first-bug added
- Milestone Awaiting Review → 6.1
- Version → 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
@
4 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
hookword 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.
![(please configure the [header_logo] section in trac.ini)](/chrome/site/your_project_logo.png)
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/