Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
08/31/2015 06:51:35 AM (11 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Activity component.

See #6576.

File:
1 edited

Legend:

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

    r9961 r10077  
    1616 * static methods for querying activities.
    1717 *
    18  * @since BuddyPress (1.0.0)
     18 * @since 1.0.0
    1919 */
    2020class BP_Activity_Activity {
    … …  
    210210                 * Please use this hook to filter the properties above. Each part will be passed in.
    211211                 *
    212                  * @since BuddyPress (1.0.0)
     212                 * @since 1.0.0
    213213                 *
    214214                 * @param BP_Activity_Activity $this Current instance of the activity item being saved. Passed by reference.
    … …  
    247247                 * Fires after an activity item has been saved to the database.
    248248                 *
    249                  * @since BuddyPress (1.0.0)
     249                 * @since 1.0.0
    250250                 *
    251251                 * @param BP_Activity_Activity $this Current instance of activity item being saved. Passed by reference.
    … …  
    457457                 * Filters the MySQL WHERE conditions for the Activity items get method.
    458458                 *
    459                  * @since BuddyPress (1.9.0)
     459                 * @since 1.9.0
    460460                 *
    461461                 * @param array  $where_conditions Current conditions for MySQL WHERE statement.
    … …  
    473473                 * Filters the preferred order of indexes for activity item.
    474474                 *
    475                  * @since BuddyPress (1.6.0)
     475                 * @since 1.6.0
    476476                 *
    477477                 * @param array Array of indexes in preferred order.
    … …  
    507507                 * It is not recommended to use the legacy structure, but allowed to if needed.
    508508                 *
    509                  * @since BuddyPress (2.0.0)
     509                 * @since 2.0.0
    510510                 *
    511511                 * @param bool                 $value Whether to use legacy structure or not.
    … …  
    530530                                 * Filters the legacy MySQL query statement so plugins can alter before results are fetched.
    531531                                 *
    532                                  * @since BuddyPress (1.5.0)
     532                                 * @since 1.5.0
    533533                                 *
    534534                                 * @param string $value      Concatenated MySQL statement pieces to be query results with for legacy query.
    … …  
    554554                         * Filters the paged activities MySQL statement.
    555555                         *
    556                          * @since BuddyPress (2.0.0)
     556                         * @since 2.0.0
    557557                         *
    558558                         * @param string $activity_ids_sql MySQL statement used to query for Activity IDs.
    … …  
    605605                         * Filters the total activities MySQL statement.
    606606                         *
    607                          * @since BuddyPress (1.5.0)
     607                         * @since 1.5.0
    608608                         *
    609609                         * @param string $value     MySQL statement used to query for total activities.
    … …  
    629629         * Convert activity IDs to activity objects, as expected in template loop.
    630630         *
    631          * @since BuddyPress (2.0.0)
     631         * @since 2.0.0
    632632         *
    633633         * @param array $activity_ids Array of activity IDs.
    … …  
    694694         * Append xProfile fullnames to an activity array.
    695695         *
    696          * @since BuddyPress (2.0.0)
     696         * @since 2.0.0
    697697         *
    698698         * @param array $activities Activities array.
    … …  
    735735         * their own caches at the beginning of an activity loop.
    736736         *
    737          * @since BuddyPress (2.0.0)
     737         * @since 2.0.0
    738738         *
    739739         * @param array $activities Array of activities.
    … …  
    746746                 * Filters inside prefetch_object_data method to aid in pre-fetching object data associated with activity item.
    747747                 *
    748                  * @since BuddyPress (2.0.0)
     748                 * @since 2.0.0
    749749                 *
    750750                 * @param array $activities Array of activities.
    … …  
    761761         * be left in place.
    762762         *
    763          * @since BuddyPress (2.0.0)
     763         * @since 2.0.0
    764764         *
    765765         * @param array $activities Array of activities.
    … …  
    789789         * AND keyword from the 'where' clause).
    790790         *
    791          * @since BuddyPress (1.8.0)
     791         * @since 1.8.0
    792792         *
    793793         * @param array $meta_query An array of meta_query filters. See the
    … …  
    830830         * keyword from the query).
    831831         *
    832          * @since BuddyPress (2.1.0)
     832         * @since 2.1.0
    833833         *
    834834         * @param array $date_query An array of date_query parameters. See the
    … …  
    857857         * Can handle multiple scopes.
    858858         *
    859          * @since BuddyPress (2.2.0)
     859         * @since 2.2.0
    860860         *
    861861         * @param  mixed $scope  The activity scope. Accepts string or array of scopes.
    … …  
    906906                         *   - bp_friends_filter_activity_scope() - used for 'friends' scope
    907907                         *
    908                          * @since BuddyPress (2.2.0)
     908                         * @since 2.2.0
    909909                         *
    910910                         *  @param array {
    … …  
    959959         * As of 1.5.x, use BP_Activity_Activity::get() with an 'in' parameter instead.
    960960         *
    961          * @since BuddyPress (1.2.0)
     961         * @since 1.2.0
    962962         *
    963963         * @deprecated 1.5
    … …  
    10471047         * Otherwise use the filters.
    10481048         *
    1049          * @since BuddyPress (1.2.0)
     1049         * @since 1.2.0
    10501050         *
    10511051         * @param array $args {
    … …  
    11551155                 * Action to allow intercepting activity items to be deleted.
    11561156                 *
    1157                  * @since BuddyPress (2.3.0)
     1157                 * @since 2.3.0
    11581158                 *
    11591159                 * @param array $activities Array of activities.
    … …  
    11731173                 * Action to allow intercepting activity items just deleted.
    11741174                 *
    1175                  * @since BuddyPress (2.3.0)
     1175                 * @since 2.3.0
    11761176                 *
    11771177                 * @param array $activities Array of activities.
    … …  
    12221222         * use it going forward, and use BP_Activity_Activity::delete() instead.
    12231223         *
    1224          * @since BuddyPress (1.2.0)
    1225          * @deprecated BuddyPress (2.3.0)
     1224         * @since 1.2.0
     1225         * @deprecated 2.3.0
    12261226         *
    12271227         * @param array $activity_ids Activity IDs whose comments should be deleted.
    … …  
    12531253         * Delete the meta entries associated with a set of activity items.
    12541254         *
    1255          * @since BuddyPress (1.2.0)
     1255         * @since 1.2.0
    12561256         *
    12571257         * @param array $activity_ids Activity IDs whose meta should be deleted.
    … …  
    12721272         * Append activity comments to their associated activity items.
    12731273         *
    1274          * @since BuddyPress (1.2.0)
     1274         * @since 1.2.0
    12751275         *
    12761276         * @global wpdb $wpdb WordPress database object.
    … …  
    13031303         * Get activity comments that are associated with a specific activity ID.
    13041304         *
    1305          * @since BuddyPress (1.2.0)
     1305         * @since 1.2.0
    13061306         *
    13071307         * @global wpdb $wpdb WordPress database object.
    … …  
    13601360                         * Filters if BuddyPress should use the legacy activity query.
    13611361                         *
    1362                          * @since BuddyPress (2.0.0)
     1362                         * @since 2.0.0
    13631363                         *
    13641364                         * @param bool                 $value     Whether or not to use the legacy query.
    … …  
    13711371                                 * Filters the MySQL prepared statement for the legacy activity query.
    13721372                                 *
    1373                                  * @since BuddyPress (1.5.0)
     1373                                 * @since 1.5.0
    13741374                                 *
    13751375                                 * @param string $value       Prepared statement for the activity query.
    … …  
    14631463         * Rebuild nested comment tree under an activity or activity comment.
    14641464         *
    1465          * @since BuddyPress (1.2.0)
     1465         * @since 1.2.0
    14661466         *
    14671467         * @global wpdb $wpdb WordPress database object.
    … …  
    15031503         * Get child comments of an activity or activity comment.
    15041504         *
    1505          * @since BuddyPress (1.2.0)
     1505         * @since 1.2.0
    15061506         *
    15071507         * @global wpdb $wpdb WordPress database object.
    … …  
    15691569         * Create SQL IN clause for filter queries.
    15701570         *
    1571          * @since BuddyPress (1.5.0)
     1571         * @since 1.5.0
    15721572         *
    15731573         * @see BP_Activity_Activity::get_filter_sql()
    … …  
    16071607         * Create filter SQL clauses.
    16081608         *
    1609          * @since BuddyPress (1.5.0)
     1609         * @since 1.5.0
    16101610         *
    16111611         * @param array $filter_array {
    … …  
    16871687         * Get the date/time of last recorded activity.
    16881688         *
    1689          * @since BuddyPress (1.2.0)
     1689         * @since 1.2.0
    16901690         *
    16911691         * @return string ISO timestamp.
    … …  
    17021702         * Get favorite count for a given user.
    17031703         *
    1704          * @since BuddyPress (1.2.0)
     1704         * @since 1.2.0
    17051705         *
    17061706         * @param int $user_id The ID of the user whose favorites you're counting.
    … …  
    17621762         * Subject to removal once WordPress makes PHP 5.3.0 the minimum requirement.
    17631763         *
    1764          * @since BuddyPress (2.2.0)
     1764         * @since 2.2.0
    17651765         *
    17661766         * @see http://php.net/manual/en/function.array-replace-recursive.php#109390
Note: See TracChangeset for help on using the changeset viewer.