Code Reference: need More Information on WP_Filesystem #405
Labels
code reference
Issues for Code Reference portal of DevHub
developer documentation (DevHub)
Improvements or additions to developer documentation
Issue Description
There are a few confusing things regarding
WP_Filesystem
docs.WP_Filesystem
uses a variable to instantiate a class, so the docs parser doesn't link the pages.There is no link to the base class mentioned in the summary.
2. The return value is not really explained. Basically, the More Information section needs to say what happens using the defaults.
3. The More Information section needs to link to the API page so the full explanation can be found on how to use this function.
https://developer.wordpress.org/apis/handbook/filesystem/
4. The contributed code examples on this function and on WP_Filesystem_Base all call the function with defaults and no getting credentials, which is how it is explained on the API page.
5. The More Information section should mention the earliest available hook of
admin_init
like the API page does.URL of the Page with the Issue
https://developer.wordpress.org/reference/functions/wp_filesystem/
and feedback on https://developer.wordpress.org/reference/classes/wp_filesystem_base/
Section of Page with the issue
missing More Information section
Why is this a problem?
A developer can't find the information needed to use the function.
Suggested Fix
Add a More Information section with links to the classes and the API page, with the details needed to use the function.
The text was updated successfully, but these errors were encountered: