Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/13/2015 02:02:56 AM (10 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Core component.

See #6576.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-core/classes/class-bp-user-query.php

    r10043 r10108  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    1616 * Member directories, the Friends component, etc.
    1717 *
    18  * @since BuddyPress (1.7.0)
     18 * @since 1.7.0
    1919 *
    2020 * @param array $query {
     
    6666     * Unaltered params as passed to the constructor.
    6767     *
    68      * @since BuddyPress (1.8.0)
     68     * @since 1.8.0
    6969     * @var array
    7070     */
     
    7474     * Array of variables to query with.
    7575     *
    76      * @since BuddyPress (1.7.0)
     76     * @since 1.7.0
    7777     * @var array
    7878     */
     
    8383     *
    8484     * @access public To allow components to manipulate them.
    85      * @since BuddyPress (1.7.0)
     85     * @since 1.7.0
    8686     * @var array
    8787     */
     
    9292     *
    9393     * @access public To allow components to manipulate it.
    94      * @since BuddyPress (1.7.0)
     94     * @since 1.7.0
    9595     * @var int
    9696     */
     
    101101     *
    102102     * @access public To allow components to manipulate it.
    103      * @since BuddyPress (1.7.0)
     103     * @since 1.7.0
    104104     * @var array
    105105     */
     
    110110     *
    111111     * @access public To allow components to manipulate it.
    112      * @since BuddyPress (1.7.0)
     112     * @since 1.7.0
    113113     * @var array
    114114     */
     
    118118     * SQL table where the user ID is being fetched from.
    119119     *
    120      * @since BuddyPress (2.2.0)
     120     * @since 2.2.0
    121121     * @access public
    122122     * @var string
     
    127127     * SQL database column name to order by.
    128128     *
    129      * @since BuddyPress (1.7.0)
     129     * @since 1.7.0
    130130     * @var string
    131131     */
     
    136136     *
    137137     * @access protected
    138      * @since BuddyPress (1.7.0)
     138     * @since 1.7.0
    139139     * @var string
    140140     */
     
    147147     * Constructor.
    148148     *
    149      * @since BuddyPress (1.7.0)
     149     * @since 1.7.0
    150150     *
    151151     * @param string|array $query See {@link BP_User_Query}.
     
    183183             * Fires before the construction of the BP_User_Query query.
    184184             *
    185              * @since BuddyPress (1.7.0)
     185             * @since 1.7.0
    186186             *
    187187             * @param BP_User_Query $this Current instance of the BP_User_Query. Passed by reference.
     
    223223     * {@link BP_Group_Member_Query::setup_hooks()} for an example.
    224224     *
    225      * @since BuddyPress (1.8.0)
     225     * @since 1.8.0
    226226     */
    227227    public function setup_hooks() {}
     
    230230     * Prepare the query for user_ids.
    231231     *
    232      * @since BuddyPress (1.7.0)
     232     * @since 1.7.0
    233233     */
    234234    public function prepare_user_ids_query() {
     
    277277                 * Filters the threshold for activity timestamp minutes since to indicate online status.
    278278                 *
    279                  * @since BuddyPress (1.8.0)
     279                 * @since 1.8.0
    280280                 *
    281281                 * @param int $value Amount of minutes for threshold. Default 15.
     
    471471         * Filters the clauses for the user query.
    472472         *
    473          * @since BuddyPress (2.0.0)
     473         * @since 2.0.0
    474474         *
    475475         * @param array         $sql  Array of SQL clauses to be used in the query.
     
    488488         * Fires before the BP_User_Query query is made.
    489489         *
    490          * @since BuddyPress (1.7.0)
     490         * @since 1.7.0
    491491         *
    492492         * @param BP_User_Query $this Current BP_User_Query instance. Passed by reference.
     
    503503     * Also used to quickly perform user total counts.
    504504     *
    505      * @since BuddyPress (1.7.0)
     505     * @since 1.7.0
    506506     */
    507507    public function do_user_ids_query() {
     
    526526             * use a "SELECT COUNT()" query statement.
    527527             *
    528              * @since BuddyPress (1.7.0)
     528             * @since 1.7.0
    529529             *
    530530             * @param string        $value SQL statement to select FOUND_ROWS().
     
    543543     * Use WP_User_Query() to pull data for the user IDs retrieved in the main query.
    544544     *
    545      * @since BuddyPress (1.7.0)
     545     * @since 1.7.0
    546546     */
    547547    public function do_wp_user_query() {
     
    556556         * Filters the WP User Query arguments before passing into the class.
    557557         *
    558          * @since BuddyPress (1.7.0)
     558         * @since 1.7.0
    559559         *
    560560         * @param array         $value Array of arguments for the user query.
     
    621621     * for an example.
    622622     *
    623      * @since BuddyPress (1.8.0)
     623     * @since 1.8.0
    624624     *
    625625     * @param array $include Sanitized array of user IDs, as passed to the 'include'
     
    639639     * action to loop in the things they want.
    640640     *
    641      * @since BuddyPress (1.7.0)
     641     * @since 1.7.0
    642642     *
    643643     * @global WPDB $wpdb Global WordPress database access object.
     
    678678         * @see bp_friends_filter_user_query_populate_extras()
    679679         *
    680          * @since BuddyPress (1.7.0)
     680         * @since 1.7.0
    681681         *
    682682         * @param BP_User_Query $this         Current BP_User_Query instance.
Note: See TracChangeset for help on using the changeset viewer.