Skip to content

Commit 0cb7c0b

Browse files
DrewAPictureDrewAPicture
committed
Docs: Add missing descriptions for the $wpdb global in DocBlocks all the places.
See #32246. git-svn-id: https://develop.svn.wordpress.org/trunk@35170 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 68a3c0c commit 0cb7c0b

40 files changed

Lines changed: 140 additions & 140 deletions

‎src/wp-admin/includes/class-wp-importer.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ public function __construct() {}
1212
/**
1313
* Returns array with imported permalinks from WordPress database
1414
*
15-
* @global wpdb $wpdb
15+
* @global wpdb $wpdb WordPress database abstraction object.
1616
*
1717
* @param string $importer_name
1818
* @param string $bid
@@ -52,7 +52,7 @@ public function get_imported_posts( $importer_name, $bid ) {
5252
/**
5353
* Return count of imported permalinks from WordPress database
5454
*
55-
* @global wpdb $wpdb
55+
* @global wpdb $wpdb WordPress database abstraction object.
5656
*
5757
* @param string $importer_name
5858
* @param string $bid
@@ -81,7 +81,7 @@ public function count_imported_posts( $importer_name, $bid ) {
8181
/**
8282
* Set array with imported comments from WordPress database
8383
*
84-
* @global wpdb $wpdb
84+
* @global wpdb $wpdb WordPress database abstraction object.
8585
*
8686
* @param string $bid
8787
* @return array

‎src/wp-admin/includes/class-wp-upgrader.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2693,7 +2693,7 @@ public function is_vcs_checkout( $context ) {
26932693
* @since 3.7.0
26942694
* @access public
26952695
*
2696-
* @global wpdb $wpdb
2696+
* @global wpdb $wpdb WordPress database abstraction object.
26972697
*
26982698
* @param string $type The type of update being checked: 'core', 'theme',
26992699
* 'plugin', 'translation'.

‎src/wp-admin/includes/export.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ function wxr_term_description( $term ) {
260260
*
261261
* @since 3.1.0
262262
*
263-
* @global wpdb $wpdb
263+
* @global wpdb $wpdb WordPress database abstraction object.
264264
*
265265
* @param array $post_ids Array of post IDs to filter the query by. Optional.
266266
*/

‎src/wp-admin/includes/media.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ function media_upload_tabs() {
3636
*
3737
* @since 2.5.0
3838
*
39-
* @global wpdb $wpdb
39+
* @global wpdb $wpdb WordPress database abstraction object.
4040
*
4141
* @param array $tabs
4242
* @return array $tabs with gallery if post has image attachment

‎src/wp-admin/includes/ms.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ function check_upload_size( $file ) {
4747
*
4848
* @since 3.0.0
4949
*
50-
* @global wpdb $wpdb
50+
* @global wpdb $wpdb WordPress database abstraction object.
5151
*
5252
* @param int $blog_id Blog ID.
5353
* @param bool $drop True if blog's table should be dropped. Default is false.
@@ -177,7 +177,7 @@ function wpmu_delete_blog( $blog_id, $drop = false ) {
177177
*
178178
* @todo Merge with wp_delete_user() ?
179179
*
180-
* @global wpdb $wpdb
180+
* @global wpdb $wpdb WordPress database abstraction object.
181181
*
182182
* @param int $id The user ID.
183183
* @return bool True if the user was deleted, otherwise false.
@@ -505,7 +505,7 @@ function upload_space_setting( $id ) {
505505
*
506506
* @since 3.0.0
507507
*
508-
* @global wpdb $wpdb
508+
* @global wpdb $wpdb WordPress database abstraction object.
509509
*
510510
* @param int $id The user ID.
511511
* @param string $pref The column in the wp_users table to update the user's status
@@ -936,7 +936,7 @@ function revoke_super_admin( $user_id ) {
936936
*
937937
* @since 3.1.0
938938
*
939-
* @global wpdb $wpdb
939+
* @global wpdb $wpdb WordPress database abstraction object.
940940
*
941941
* @param int $site_id The network/site ID to check.
942942
* @return bool True if network can be edited, otherwise false.

‎src/wp-admin/includes/nav-menu.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -936,7 +936,7 @@ function wp_nav_menu_manage_columns() {
936936
* @access private
937937
* @since 3.0.0
938938
*
939-
* @global wpdb $wpdb
939+
* @global wpdb $wpdb WordPress database abstraction object.
940940
*/
941941
function _wp_delete_orphaned_draft_menu_items() {
942942
global $wpdb;

‎src/wp-admin/includes/network.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
*
1313
* @since 3.0.0
1414
*
15-
* @global wpdb $wpdb
15+
* @global wpdb $wpdb WordPress database abstraction object.
1616
*
1717
* @return Whether a network exists.
1818
*/
@@ -45,7 +45,7 @@ function allow_subdomain_install() {
4545
*
4646
* @since 3.0.0
4747
*
48-
* @global wpdb $wpdb
48+
* @global wpdb $wpdb WordPress database abstraction object.
4949
*
5050
* @return bool Whether subdirectory install is allowed
5151
*/
@@ -293,7 +293,7 @@ function network_step1( $errors = false ) {
293293
*
294294
* @since 3.0.0
295295
*
296-
* @global wpdb $wpdb
296+
* @global wpdb $wpdb WordPress database abstraction object.
297297
*
298298
* @param WP_Error $errors
299299
*/

‎src/wp-admin/includes/post.php‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ function _wp_translate_postdata( $update = false, $post_data = null ) {
173173
*
174174
* @since 1.5.0
175175
*
176-
* @global wpdb $wpdb
176+
* @global wpdb $wpdb WordPress database abstraction object.
177177
*
178178
* @param array $post_data Optional.
179179
* @return int Post ID.
@@ -403,7 +403,7 @@ function edit_post( $post_data = null ) {
403403
*
404404
* @since 2.7.0
405405
*
406-
* @global wpdb $wpdb
406+
* @global wpdb $wpdb WordPress database abstraction object.
407407
*
408408
* @param array $post_data Optional, the array of post data to process if not provided will use $_POST superglobal.
409409
* @return array
@@ -659,7 +659,7 @@ function get_default_post_to_edit( $post_type = 'post', $create_in_db = false )
659659
*
660660
* @since 2.0.0
661661
*
662-
* @global wpdb $wpdb
662+
* @global wpdb $wpdb WordPress database abstraction object.
663663
*
664664
* @param string $title Post title
665665
* @param string $content Optional post content
@@ -843,7 +843,7 @@ function delete_meta( $mid ) {
843843
*
844844
* @since 1.2.0
845845
*
846-
* @global wpdb $wpdb
846+
* @global wpdb $wpdb WordPress database abstraction object.
847847
*
848848
* @return mixed
849849
*/
@@ -876,7 +876,7 @@ function get_post_meta_by_id( $mid ) {
876876
*
877877
* @since 1.2.0
878878
*
879-
* @global wpdb $wpdb
879+
* @global wpdb $wpdb WordPress database abstraction object.
880880
*
881881
* @param int $postid
882882
* @return mixed
@@ -1074,7 +1074,7 @@ function wp_edit_posts_query( $q = false ) {
10741074
*
10751075
* @since 2.5.0
10761076
*
1077-
* @global wpdb $wpdb
1077+
* @global wpdb $wpdb WordPress database abstraction object.
10781078
*
10791079
* @param string $type
10801080
* @return mixed

‎src/wp-admin/includes/schema.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
*
2828
* @since 3.3.0
2929
*
30-
* @global wpdb $wpdb
30+
* @global wpdb $wpdb WordPress database abstraction object.
3131
*
3232
* @param string $scope Optional. The tables for which to retrieve SQL. Can be all, global, ms_global, or blog tables. Defaults to all.
3333
* @param int $blog_id Optional. The blog ID for which to retrieve SQL. Default is the current blog ID.

‎src/wp-admin/includes/template-functions.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -568,7 +568,7 @@ function _list_meta_row( $entry, &$count ) {
568568
*
569569
* @since 1.2.0
570570
*
571-
* @global wpdb $wpdb
571+
* @global wpdb $wpdb WordPress database abstraction object.
572572
*
573573
* @param WP_Post $post Optional. The post being edited.
574574
*/
@@ -758,7 +758,7 @@ function page_template_dropdown( $default = '' ) {
758758
* @since 1.5.0
759759
* @since 4.4.0 `$post` argument was added.
760760
*
761-
* @global wpdb $wpdb
761+
* @global wpdb $wpdb WordPress database abstraction object.
762762
*
763763
* @param int $default Optional. The default page ID to be pre-selected. Default 0.
764764
* @param int $parent Optional. The parent page ID. Default 0.

0 commit comments

Comments
 (0)