Changeset 13757

Timestamp:

03/09/2024 04:40:09 AM (3 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

Location:

trunk/src

Files:

• bp-activity/bp-activity-template.php (modified) (1 diff)
• bp-activity/classes/class-bp-activity-activity.php (modified) (12 diffs)
• bp-activity/classes/class-bp-activity-feed.php (modified) (2 diffs)
• bp-activity/classes/class-bp-activity-query.php (modified) (1 diff)
• bp-blogs/bp-blogs-activity.php (modified) (4 diffs)
• bp-blogs/bp-blogs-functions.php (modified) (3 diffs)

trunk/src/bp-activity/bp-activity-template.php

@@ -3771 +3771 @@
  * @since 1.7.0
  *
+ * @global BP_Activity_Template $activities_template The Activity template object.
+ *
  * @return bool|array An array of IDs, or false if none are found.
  */

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

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

@@ -91 +91 @@
          * @since 1.8.0
          *
+         * @global WP_Query $wp_query WordPress query object.
+         *
          * @param array $args Optional.
          */
@@ -331 +333 @@
          *
          * @since 1.9.0
+         *
+         * @global WP_Query $wp_query WordPress query object.
          */
         protected function http_headers() {

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

@@ -109 +109 @@
          * @since 2.2.0
          *
+         * @global wpdb $wpdb WordPress database object.
+         *
          * @param  array $clause       Array of arguments belonging to the clause.
          * @param  array $parent_query Parent query to which the clause belongs.

trunk/src/bp-blogs/bp-blogs-activity.php

@@ -672 +672 @@
  * @since 1.0.0
  *
+ * @global wpdb $wpdb WordPress database object.
+ *
  * @param int $post_id ID of the post to be removed.
  * @param int $blog_id Optional. Defaults to current blog ID.
@@ -1023 +1025 @@
  * @since 2.5.0 Used for any synced Post type comments, in wp-admin or front-end contexts.
  *
+ * @global wpdb $wpdb WordPress database object.
+ *
  * @param array $args Arguments passed from bp_parse_args() in bp_has_activities().
  * @return array $args
@@ -1201 +1205 @@
  * @since 2.0.0
  *
+ * @global BP_Activity_Template $activities_template The Activity template object.
+ *
  * @param bool $retval Is activity commenting enabled for this activity entry.
  * @return bool
@@ -1332 +1338 @@
  * @since 2.0.0
  *
+ * @global BP_Activity_Template $activities_template The Activity template object.
+ *
  * @param string $retval The activity comment permalink.
  * @return string

trunk/src/bp-blogs/bp-blogs-functions.php

@@ -88 +88 @@
  * @since 2.6.0 Accepts $args as a parameter.
  *
+ * @global wpdb $wpdb WordPress database object.
+ *
  * @param array $args {
  *     Array of arguments.
@@ -861 +863 @@
  * modify this behavior.
  *
+ * @global wpdb $wpdb WordPress database object.
+ *
  * @param int         $user_id The ID of the user.
  * @param string|bool $role    User's WordPress role for this blog ID.
@@ -936 +940 @@
 /**
  * Remove a blog-user pair from BP's blog tracker.
+ *
+ * @global wpdb $wpdb WordPress database object.
  *
  * @param int $user_id ID of the user whose blog is being removed.