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

WordPress Trac noreply at wordpress.org
Sat Mar 2 10:57:55 UTC 2024


#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):

 I also checked history for `xmlrpc.php` and `setup-config.php`.

 `xmlrpc.php`

 - When [19935] deprecated both the `logIO()` function and
 `$xmlrpc_logging` 12 years ago, it specifically **removed documentation**
 for the global.
 - **If** it is still worth adding a `@global` tag within the `logIO()`
 docblock, the variable accepted multiple types: `int|bool` (either `0`,
 `1` or their boolean equivalents).
 - For a possible `@since` tag, [1348] had added the variable (and the rest
 of the file) the day after a version bump in [1344]. This suggests the
 next version was 1.5.0, but I found it in the
 [https://wordpress.org/download/releases/#branch-10 zipped packages] for
 both 1.0-platinum and 1.2-mingus.

 `setup-config.php`

 - [51477] removed `@global` tags from the `setup_config_display_header()`
 docblock, where they did not belong. However, it did not put a docblock
 closer to the globals, as it is in `install.php` (and in the `setup-
 config.php` part of 60021.15.patch).
 - [32642] added the documentation for `$wp_local_package` and `$wp_locale`
 in [https://core.trac.wordpress.org/changeset/32642/trunk/src/wp-
 admin/install.php install.php], and then [45737] and [47230] included the
 descriptions.

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


More information about the wp-trac mailing list