[wp-trac] [WordPress Trac] #60021: Document global $link & $wpdb in wp-includes/bookmark.php & wp-includes/class-wp-user.php files.

[WordPress Trac]

#60021: Document global $link & $wpdb in wp-includes/bookmark.php & wp-includes
/class-wp-user.php files.
--------------------------+-------------------------------------
 Reporter:  upadalavipul  |       Owner:  SergeyBiryukov
     Type:  defect (bug)  |      Status:  reviewing
 Priority:  normal        |   Milestone:  6.5
Component:  General       |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |     Focuses:  docs, coding-standards
--------------------------+-------------------------------------

Comment (by sabernhardt):

 Some of the changes in these patches were probably skipped intentionally,
 but below is the status of each patch. It could help determine what still
 should be done toward 6.5 and what might belong on a separate
 ticket/issue.

 60021.patch:
 **Completed** in r57190 and r57191 (some changes from r57191 reverted in
 r57192).

 60021.2.patch:
 //Mostly// added in r57193, r57194, and r57196, but the `$post` global is
 not documented in `wp-includes/feed-atom-comments.php` or `wp-includes
 /feed-rss2-comments.php`.

 60021.3.patch:
 Proposes documenting `$table_prefix` global in `wp-settings.php`, in the
 same docblock as `$wpdb`.

 60021.4.patch:
 **Completed** in r57204 and r57216.

 60021.5.patch:
 **Completed** in r57223, r57225, and r57226.

 60021.6.patch:
 Proposes documenting `$GLOBALS['_paused_plugins']` for three functions in
 `wp-admin/includes/plugin.php`:
 - `is_plugin_paused()`
 - `wp_get_plugin_error()`
 - `paused_plugins_notice()`

 60021.diff:
 Proposes reordering existing documentation in `wp-includes/admin-bar.php`.
 Grouping the two `since` lines //together// before `global` in
 `wp_admin_bar_edit_site_menu()` would follow up on r56209; moving
 `$wp_customize` global before the `param` in
 `wp_admin_bar_customize_menu()` would follow up on r38810.

 60021.7.patch:
 **If** the adopted version of the getID3 external library should get
 documentation updates, `getid3_lib::IncludeDependency()` could document
 the `$GETID3_ERRORARRAY` global (before the first `param`). The two REST
 API files received `$post` documentation in r57230.

 60021.8.patch:
 Proposes documenting `$GLOBALS['_paused_themes']` for three functions in
 `wp-admin/includes/theme.php` plus one in `wp-includes/load.php`:
 - `is_theme_paused()`
 - `wp_get_theme_error()`
 - `paused_themes_notice()`
 - `wp_skip_paused_themes()`

 60021.9.patch:
 Proposes documenting `$wp_embed` and `$wp_plugin_paths` in `wp-
 settings.php` as well as `$GLOBALS['xmlrpc_logging']` in the deprecated
 function `logIO()` (`xmlrpc.php`).

 60021.10.patch:
 Proposes documenting `$GLOBALS['_paused_plugins']` in
 `wp_skip_paused_plugins()` (in `wp-includes/load.php`).

 60021.11.patch:
 **Completed** in r57234 and r57370.

 60021.12.patch:
 **Completed** in r57193.

 60021.13.patch:
 Proposes documenting two variables in `wp-settings.php` that are in other
 patches (`$GLOBALS['table_prefix']` in 60021.3.patch and
 `$GLOBALS['wp_plugin_paths']` in 60021.9.patch).

 60021.14.patch:
 The `$link` global in `bookmark.php` is already documented in r57191 (as
 an object, not a string). The `$xmlrpc_logging` global documentation is
 also proposed in 60021.9.patch.

 60021.15.patch:
 Proposes documenting `$wp_local_package` and `$wp_locale` globals in `wp-
 admin/setup-config.php` the way they are in `wp-admin/install.php`. It
 also adds `$table_prefix` in `wp-settings.php` (compare with 60021.3.patch
 and 60021.13.patch).

 60021.16.patch:
 Proposes documenting the `$_wp_tests_development_mode` global within the
 `wp_get_development_mode()` docblock, though the variable has a comment
 about its use "exclusively for core tests."

 60021.17.patch:
 Bundled themes are on a separate ticket, #58715, and the pull request
 includes these items.

 60021.18.patch and 60021.19.patch:
 Changes need to be made upstream in the Gutenberg repository and then
 synced to files in the `wp-includes/blocks` directory.

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/60021#comment:17>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform