Skip to:
Content

BuddyPress.org

Changeset 13757


Ignore:
Timestamp:
03/09/2024 04:40:09 AM (3 months 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:
6 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-activity/bp-activity-template.php

    r13724 r13757  
    37713771 * @since 1.7.0
    37723772 *
     3773 * @global BP_Activity_Template $activities_template The Activity template object.
     3774 *
    37733775 * @return bool|array An array of IDs, or false if none are found.
    37743776 */
  • trunk/src/bp-activity/classes/class-bp-activity-activity.php

    r13724 r13757  
    174174     *
    175175     * @since 1.0.0
     176     *
     177     * @global wpdb $wpdb WordPress database object.
    176178     */
    177179    public function populate() {
     
    227229     *
    228230     * @since 1.0.0
     231     *
     232     * @global wpdb $wpdb WordPress database object.
    229233     *
    230234     * @return WP_Error|bool True on success.
     
    350354     * @see WP_Meta_Query::queries for a description of the 'meta_query'
    351355     *      parameter format.
     356     *
     357     * @global wpdb $wpdb WordPress database object.
    352358     *
    353359     * @param array $args {
     
    882888     * @since 2.0.0
    883889     *
     890     * @global wpdb $wpdb WordPress database object.
     891     *
    884892     * @param array $activity_ids Array of activity IDs.
    885893     * @return array
     
    12401248     * @since 10.0.0 Parameters were made optional.
    12411249     *
     1250     * @global wpdb $wpdb WordPress database object.
     1251     *
    12421252     * @param array $args {
    12431253     *     An array of arguments. All items are optional.
     
    13511361     *
    13521362     * @since 1.2.0
     1363     *
     1364     * @global wpdb $wpdb WordPress database object.
    13531365     *
    13541366     * @param array $args {
     
    15291541     * @since 1.2.0
    15301542     *
     1543     * @global wpdb $wpdb WordPress database object.
     1544     *
    15311545     * @deprecated 2.3.0
    15321546     *
     
    18301844     * @since 1.2.0
    18311845     *
     1846     * @global wpdb $wpdb WordPress database object.
     1847     *
    18321848     * @param bool $skip_last_activity If true, components will not be
    18331849     *                                 included if the only activity type associated with them is
     
    18801896     *
    18811897     * @see BP_Activity_Activity::get_filter_sql()
     1898     *
     1899     * @global wpdb $wpdb WordPress database object.
    18821900     *
    18831901     * @param string     $field The database field.
     
    20022020     * @since 1.2.0
    20032021     *
     2022     * @global wpdb $wpdb WordPress database object.
     2023     *
    20042024     * @return string ISO timestamp.
    20052025     */
     
    20372057     * @since 1.1.0
    20382058     *
     2059     * @global wpdb $wpdb WordPress database object.
     2060     *
    20392061     * @param string $content The content to filter by.
    20402062     * @return int|false The ID of the first matching item if found, otherwise false.
     
    20552077     * @since 1.2.0
    20562078     *
     2079     * @global wpdb $wpdb WordPress database object.
     2080     *
    20572081     * @param int $user_id The ID of the user whose activity you want to mark hidden.
    20582082     * @return mixed
  • trunk/src/bp-activity/classes/class-bp-activity-feed.php

    r13582 r13757  
    9191     * @since 1.8.0
    9292     *
     93     * @global WP_Query $wp_query WordPress query object.
     94     *
    9395     * @param array $args Optional.
    9496     */
     
    331333     *
    332334     * @since 1.9.0
     335     *
     336     * @global WP_Query $wp_query WordPress query object.
    333337     */
    334338    protected function http_headers() {
  • trunk/src/bp-activity/classes/class-bp-activity-query.php

    r13634 r13757  
    109109     * @since 2.2.0
    110110     *
     111     * @global wpdb $wpdb WordPress database object.
     112     *
    111113     * @param  array $clause       Array of arguments belonging to the clause.
    112114     * @param  array $parent_query Parent query to which the clause belongs.
  • trunk/src/bp-blogs/bp-blogs-activity.php

    r13642 r13757  
    672672 * @since 1.0.0
    673673 *
     674 * @global wpdb $wpdb WordPress database object.
     675 *
    674676 * @param int $post_id ID of the post to be removed.
    675677 * @param int $blog_id Optional. Defaults to current blog ID.
     
    10231025 * @since 2.5.0 Used for any synced Post type comments, in wp-admin or front-end contexts.
    10241026 *
     1027 * @global wpdb $wpdb WordPress database object.
     1028 *
    10251029 * @param array $args Arguments passed from bp_parse_args() in bp_has_activities().
    10261030 * @return array $args
     
    12011205 * @since 2.0.0
    12021206 *
     1207 * @global BP_Activity_Template $activities_template The Activity template object.
     1208 *
    12031209 * @param bool $retval Is activity commenting enabled for this activity entry.
    12041210 * @return bool
     
    13321338 * @since 2.0.0
    13331339 *
     1340 * @global BP_Activity_Template $activities_template The Activity template object.
     1341 *
    13341342 * @param string $retval The activity comment permalink.
    13351343 * @return string
  • trunk/src/bp-blogs/bp-blogs-functions.php

    r13431 r13757  
    8888 * @since 2.6.0 Accepts $args as a parameter.
    8989 *
     90 * @global wpdb $wpdb WordPress database object.
     91 *
    9092 * @param array $args {
    9193 *     Array of arguments.
     
    861863 * modify this behavior.
    862864 *
     865 * @global wpdb $wpdb WordPress database object.
     866 *
    863867 * @param int         $user_id The ID of the user.
    864868 * @param string|bool $role    User's WordPress role for this blog ID.
     
    936940/**
    937941 * Remove a blog-user pair from BP's blog tracker.
     942 *
     943 * @global wpdb $wpdb WordPress database object.
    938944 *
    939945 * @param int $user_id ID of the user whose blog is being removed.
Note: See TracChangeset for help on using the changeset viewer.