WordPress.org

Make WordPress Core

Opened 2 years ago

Closed 2 years ago

#48109 closed defect (bug) (fixed)

PHPDoc correction for edit_bookmark_link in wp-includes/link-template.php

Reported by: atachibana Owned by: SergeyBiryukov
Milestone: 5.3 Priority: normal
Severity: minor Version:
Component: General Keywords: has-patch
Focuses: docs Cc:

Description (last modified by SergeyBiryukov)

Enhanced missing information of Codex for edit_bookmark_link() in wp-includes/link-template.php.
When $link is '', default value 'Edit This' is set in the function body.

- * @param string $link     Optional. Anchor text. Default empty.
+ * @param string $link     Optional. Anchor text. If empty, default is 'Edit This'. Default empty.

Codex: ​https://codex.wordpress.org/Function_Reference/edit_bookmark_link
Code Reference: ​https://developer.wordpress.org/reference/functions/edit_bookmark_link/

Above description was taken from edit_comment_link() in the same function.

This is the action of inline docs and Codex migration initiatives.

Attachments (1)

48109.diff​ (623 bytes) - added by atachibana 2 years ago.

Download all attachments as: .zip

Change History (5)

@atachibana
2 years ago

#1 @atachibana
2 years ago

  • Keywords has-patch added

#2 @SergeyBiryukov
2 years ago

  • Milestone changed from Awaiting Review to 5.3
  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing

#3 @SergeyBiryukov
2 years ago

  • Description modified (diff)

#4 @SergeyBiryukov
2 years ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 46383:

Docs: Clarify default value for the $link parameter in edit_tag_link(), edit_term_link(), and edit_bookmark_link().

Props atachibana.
Fixes #48109.

Note: See TracTickets for help on using tickets.