WordPress.org

Make WordPress Core

Opened 6 years ago

Closed 6 years ago

#35589 closed defect (bug) (fixed)

Change "blog" references to "site" in inline docs for wp-includes/link-template.php

Reported by: ericlewis Owned by: ericlewis
Milestone: 4.5 Priority: normal
Severity: normal Version:
Component: Networks and Sites Keywords: has-patch
Focuses: docs, multisite Cc:

Description

This is a breakout ticket from #35417.

The term "site" is preferred to the term "blog" at this point, so we can update the docs accordingly.

Attachments (4)

35589.diff (5.7 KB) - added by mrahmadawais 6 years ago.
Converts "blog" instances to "site" inside the inline docs.
35589.2.diff (5.2 KB) - added by mrahmadawais 6 years ago.
Ignored Grunt File. Converts "blog" instances to "site" inside the inline docs.
35589.3.diff (6.3 KB) - added by mrahmadawais 6 years ago.
Updates "Blog ID" to "Site ID"
35589.4.diff (6.3 KB) - added by ericlewis 6 years ago.

Download all attachments as: .zip

Change History (9)

#1 @ericlewis
6 years ago

Some starter thoughts in this file:

We can remove the content in the parenthesis in the inline docs for get_edit_bookmark_link() and edit_bookmark_link(). I don't think we need to explain what a bookmark is further than just calling it a bookmark.

Here we could change the parameter description to Site ID. Optional, defaults to the current site.

This could change to use site.

@mrahmadawais
6 years ago

Converts "blog" instances to "site" inside the inline docs.

@mrahmadawais
6 years ago

Ignored Grunt File. Converts "blog" instances to "site" inside the inline docs.

#2 @mrahmadawais
6 years ago

@ericlewis Have a look at the second patch file.

#3 @mrahmadawais
6 years ago

  • Keywords has-patch added; needs-patch removed

@mrahmadawais
6 years ago

Updates "Blog ID" to "Site ID"

@ericlewis
6 years ago

#4 @ericlewis
6 years ago

  • Milestone changed from Awaiting Review to 4.5

Great work here @mrahmadawais! I removed the parenthesis for the edit_bookmark_link() docs as well.

#5 @ericlewis
6 years ago

  • Owner set to ericlewis
  • Resolution set to fixed
  • Status changed from new to closed

In 36386:

Networks and sites: Replace "blog" usage with "site" in docs.

This effort focuses on src/wp-includes/link-template.php.

Multisite functions use the term "blog" to refer to what we now call a "site," e.g. get_current_blog_id(). These functions are here to stay because of our commitment to backwards compatibility. What we can do is set the documentation straight.

Props mrahmadawais.
Fixes #35589.

Note: See TracTickets for help on using tickets.