Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
04/15/2016 04:59:34 AM (10 years ago)
Author:
tw2113
Message:

Plenty of @since tag updates for the Members component.

See #6402.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-members/classes/class-bp-core-members-template.php

    r10521 r10711  
    1414 *
    1515 * Responsible for loading a group of members into a loop for display.
     16 *
     17 * @since 1.0.0
    1618 */
    1719class BP_Core_Members_Template {
    … …  
    2022     * The loop iterator.
    2123     *
     24     * @since 1.0.0
    2225     * @var int
    2326     */
    … …  
    2730     * The number of members returned by the paged query.
    2831     *
     32     * @since 1.0.0
    2933     * @var int
    3034     */
    … …  
    3438     * Array of members located by the query.
    3539     *
     40     * @since 1.0.0
    3641     * @var array
    3742     */
    … …  
    4146     * The member object currently being iterated on.
    4247     *
     48     * @since 1.0.0
    4349     * @var object
    4450     */
    … …  
    4854     * A flag for whether the loop is currently being iterated.
    4955     *
     56     * @since 1.0.0
    5057     * @var bool
    5158     */
    … …  
    5562     * The type of member being requested. Used for ordering results.
    5663     *
     64     * @since 2.3.0
    5765     * @var string
    5866     */
    … …  
    6270     * The unique string used for pagination queries.
    6371     *
     72     * @since 2.2.0
    6473     * @var string
    6574     */
    … …  
    6978     * The page number being requested.
    7079     *
     80     * @since 1.0.0
    7181     * @var string
    7282     */
    … …  
    7686     * The number of items being requested per page.
    7787     *
     88     * @since 1.0.0
    7889     * @var string
    7990     */
    … …  
    8394     * An HTML string containing pagination links.
    8495     *
     96     * @since 1.0.0
    8597     * @var string
    8698     */
    … …  
    90102     * The total number of members matching the query parameters.
    91103     *
     104     * @since 1.0.0
    92105     * @var int
    93106     */
    … …  
    96109    /**
    97110     * Constructor method.
     111     *
     112     * @since 1.5.0
    98113     *
    99114     * @see BP_User_Query for an in-depth description of parameters.
    … …  
    185200     * Whether there are members available in the loop.
    186201     *
     202     * @since 1.0.0
     203     *
    187204     * @see bp_has_members()
    188205     *
    … …  
    199216     * Set up the next member and iterate index.
    200217     *
     218     * @since 1.0.0
     219     *
    201220     * @return object The next member to iterate over.
    202221     */
    … …  
    210229    /**
    211230     * Rewind the members and reset member index.
     231     *
     232     * @since 1.0.0
    212233     */
    213234    function rewind_members() {
    … …  
    224245     * that controls iteration inside the members loop, eg:
    225246     *     while ( bp_members() ) { ...
     247     *
     248     * @since 1.2.0
    226249     *
    227250     * @see bp_members()
    … …  
    255278     * reference to the current member.
    256279     *
     280     * @since 1.0.0
     281     *
    257282     * @see bp_the_member()
    258283     */
Note: See TracChangeset for help on using the changeset viewer.