WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 2 years ago

#45403 closed enhancement (fixed)

Docs: Description is wrong in the return of network_domain_check()

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

Description

Description is wrong in the return of network_domain_check()

current description is:

 * @return Whether a network exists.

must be:

 * @return string|false Base domain, or false if network does not exist.

Attachments (2)

45403.patch (483 bytes) - added by ishitaka 3 years ago.
45403.2.patch (482 bytes) - added by ishitaka 3 years ago.

Download all attachments as: .zip

Change History (6)

@ishitaka
3 years ago

#1 @vaishalipanchal
3 years ago

  • Focuses docs added

It looks like a good improvement, as suggested by @ishitaka, to explain the possible return values, that are currently either Base domain or false.

Here's are suggested adjustments for 45403.patch​:

* @return string|false Base domain if network exists, false otherwise.

#2 @ishitaka
3 years ago

@vaishalipanchal thanks for your suggestion.

@ishitaka
3 years ago

#3 @SergeyBiryukov
3 years ago

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

#4 @pento
2 years ago

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

In 44460:

Docs: Improve the @return description of network_domain_check().

Props ishitaka, vaishalipanchal.
Fixes #45403.

Note: See TracTickets for help on using tickets.