#56206 closed enhancement (fixed)
Add missing `@since` notes to `gallery_shortcode` documentation`
Reported by: | desrosj | Owned by: | audrasjb |
---|---|---|---|
Milestone: | 6.1 | Priority: | normal |
Severity: | normal | Version: | |
Component: | Gallery | Keywords: | good-first-bug has-patch |
Focuses: | docs | Cc: |
Description
The gallery_shortcode()
function was introduced in version 2.5. It looks like there are some @since
tags that could be added for the gallery_shortcode()
function to improve the historical documentation.
A few I identified looking through the version control blame trying to track something else down:
- In [27302] the HTML elements used for the
itemtag
,icontag
andcaptiontag
attributes were changed when HTML5 support was added throughadd_theme_support()
. - #24979/[25665] introduced a
link
attribute in 3.7. - #6368/[7496] switched to actually using the
$attr
parameter to shape the output of the shortcode, introduced several new attributes in includingsize
,itemtag
,icontag
,captiontag
, andcolumns
, and also changed the markup from<div>
tags to<dl>
,<dt>
and<dd>
tags, etc. for 2.8.
Attachments (2)
Change History (9)
This ticket was mentioned in PR #3076 on WordPress/wordpress-develop by bengreeley.
2 years ago
#2
- Keywords has-patch added; needs-patch removed
Adds @since
for all major functionality and versions for the gallery_shortcode()
functionality.
Trac ticket: https://core.trac.wordpress.org/ticket/56206
#3
@
2 years ago
- Milestone changed from Future Release to 6.1
PR look good to me.
Set 6.1
milestone for visibility
#4
follow-up:
↓ 5
@
2 years ago
- Owner set to audrasjb
- Status changed from new to reviewing
I spotted a few small issues in the proposed PR. Adding another commit to fix them.
#5
in reply to:
↑ 4
@
2 years ago
@audrasjb Thank you for making those edits. I've uploaded a patch with the changes included.
2 years ago
#7
Committed in https://core.trac.wordpress.org/changeset/54172
A good function to use as an example is add_theme_support() (source), which has over a dozen
@since
tags for historical context.