Changeset 13757 for trunk/src/bp-activity/classes/class-bp-activity-activity.php

Timestamp:

03/09/2024 04:40:09 AM (2 years ago)

Author:

imath

Message:

Improve some method/function inline docs adding @global docblocks

Props shailu25

Fixes #9116
Closes ​https://github.com/buddypress/buddypress/pull/252

File:

• trunk/src/bp-activity/classes/class-bp-activity-activity.php (modified) (12 diffs)

trunk/src/bp-activity/classes/class-bp-activity-activity.php

@@ -174 +174 @@
      *
      * @since 1.0.0
+     *
+     * @global wpdb $wpdb WordPress database object.
      */
     public function populate() {
@@ -227 +229 @@
      *
      * @since 1.0.0
+     *
+     * @global wpdb $wpdb WordPress database object.
      *
      * @return WP_Error|bool True on success.
@@ -350 +354 @@
      * @see WP_Meta_Query::queries for a description of the 'meta_query'
      *      parameter format.
+     *
+     * @global wpdb $wpdb WordPress database object.
      *
      * @param array $args {
@@ -882 +888 @@
      * @since 2.0.0
      *
+     * @global wpdb $wpdb WordPress database object.
+     *
      * @param array $activity_ids Array of activity IDs.
      * @return array
@@ -1240 +1248 @@
      * @since 10.0.0 Parameters were made optional.
      *
+     * @global wpdb $wpdb WordPress database object.
+     *
      * @param array $args {
      *     An array of arguments. All items are optional.
@@ -1351 +1361 @@
      *
      * @since 1.2.0
+     *
+     * @global wpdb $wpdb WordPress database object.
      *
      * @param array $args {
@@ -1529 +1541 @@
      * @since 1.2.0
      *
+     * @global wpdb $wpdb WordPress database object.
+     *
      * @deprecated 2.3.0
      *
@@ -1830 +1844 @@
      * @since 1.2.0
      *
+     * @global wpdb $wpdb WordPress database object.
+     *
      * @param bool $skip_last_activity If true, components will not be
      *                                 included if the only activity type associated with them is
@@ -1880 +1896 @@
      *
      * @see BP_Activity_Activity::get_filter_sql()
+     *
+     * @global wpdb $wpdb WordPress database object. 
      *
      * @param string     $field The database field.
@@ -2002 +2020 @@
      * @since 1.2.0
      *
+     * @global wpdb $wpdb WordPress database object. 
+     *
      * @return string ISO timestamp.
      */
@@ -2037 +2057 @@
      * @since 1.1.0
      *
+     * @global wpdb $wpdb WordPress database object.
+     *
      * @param string $content The content to filter by.
      * @return int|false The ID of the first matching item if found, otherwise false.
@@ -2055 +2077 @@
      * @since 1.2.0
      *
+     * @global wpdb $wpdb WordPress database object.
+     *
      * @param int $user_id The ID of the user whose activity you want to mark hidden.
      * @return mixed