WordPress.org
Get WordPress

Make WordPress Core

Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#58229 closed defect (bug) (fixed)

Documentation corrections for `WP_Filesystem_Base` and extending classes

Reported by: johnbillion Owned by: johnbillion
Priority: normal Milestone: 6.3
Component: Filesystem API Version: 3.7
Severity: normal Keywords: has-patch
Cc: Focuses: docs

Description

As identified by @mat-lipe, the documented return type for the dirlist() method of the WP_Filesystem_Base class and its extending classes is incorrect. This method returns an array of arrays but is documented as a one-dimensional array.

In addition there are several corrections and improvements to be made to the documented array elements.

Change History (4)

This ticket was mentioned in ​PR #4407 on ​WordPress/wordpress-develop by ​@johnbillion.
3 years ago #1

  • Keywords has-patch added

Trac ticket: https://core.trac.wordpress.org/ticket/58229

#3 @johnbillion
3 years ago

  • Owner set to johnbillion
  • Resolution → fixed
  • Status new → closed

In 55714:

Filesystem API: Correct and improve the return type documentation for the dirlist() method in WP_Filesystem_Base and its extending classes.

Props mat-lipe, szepeviktor, costdev, audrasjb, johnbillion

Fixes #58229
See #57840

Note: See TracTickets for help on using tickets.