Contents

Code Reference Classes BP_Messages_Box_Template BP_Messages_Box_Template::__construct()

BP_Messages_Box_Template::__construct( array $args = array() )

Constructor method.

Description

Parameters

$args

(Optional) Array of arguments. See bp_has_message_threads() for full description.

Default value: array()

Source

File: bp-messages/classes/class-bp-messages-box-template.php

108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
public function __construct( $args = array() ) {
 
    // Backward compatibility with old method of passing arguments.
    if ( ! is_array( $args ) || func_num_args() > 1 ) {
        _deprecated_argument( __METHOD__, '2.2.0', sprintf( __( 'Arguments passed to %1$s should be in an associative array. See the inline documentation at %2$s for more details.', 'buddyboss' ), __METHOD__, __FILE__ ) );
 
        $old_args_keys = array(
            0 => 'user_id',
            1 => 'box',
            2 => 'per_page',
            3 => 'max',
            4 => 'type',
            5 => 'search_terms',
            6 => 'page_arg'
        );
 
        $args = bp_core_parse_args_array( $old_args_keys, func_get_args() );
    }
 
    $r = wp_parse_args( $args, array(
        'page'         => 1,
        'per_page'     => 10,
        'page_arg'     => 'mpage',
        'box'          => 'inbox',
        'type'         => 'all',
        'user_id'      => bp_loggedin_user_id(),
        'max'          => false,
        'search_terms' => '',
        'include'      => false,
        'meta_query'   => array(),
    ) );
 
    $this->pag_arg      = sanitize_key( $r['page_arg'] );
    $this->pag_page     = bp_sanitize_pagination_arg( $this->pag_arg, $r['page']     );
    $this->pag_num      = bp_sanitize_pagination_arg( 'num',          $r['per_page'] );
    $this->user_id      = $r['user_id'];
    $this->box          = $r['box'];
    $this->type         = $r['type'];
    $this->search_terms = $r['search_terms'];
    $this->include      = $r['include'];
 
    if ( 'notices' === $this->box ) {
        $this->threads = BP_Messages_Notice::get_notices( array(
            'pag_num'  => $this->pag_num,
            'pag_page' => $this->pag_page
        ) );
    } else {
        $threads = BP_Messages_Thread::get_current_threads_for_user( array(
            'user_id'      => $this->user_id,
            'box'          => $this->box,
            'type'         => $this->type,
            'limit'        => $this->pag_num,
            'page'         => $this->pag_page,
            'search_terms' => $this->search_terms,
            'include'      => $this->include,
            'meta_query'   => $r['meta_query'],
        ) );
 
        $this->threads            = $threads['threads'];
        $this->total_thread_count = $threads['total'];
    }
 
    if ( !$this->threads ) {
        $this->thread_count       = 0;
        $this->total_thread_count = 0;
    } else {
        $total_notice_count = BP_Messages_Notice::get_total_notice_count();
 
        if ( empty( $r['max'] ) || ( (int) $r['max'] >= (int) $total_notice_count ) ) {
            if ( 'notices' === $this->box ) {
                $this->total_thread_count = (int) $total_notice_count;
            }
        } else {
            $this->total_thread_count = (int) $r['max'];
        }
 
        if ( ! empty( $r['max'] ) ) {
            if ( (int) $r['max'] >= count( $this->threads ) ) {
                $this->thread_count = count( $this->threads );
            } else {
                $this->thread_count = (int) $r['max'];
            }
        } else {
            $this->thread_count = count( $this->threads );
        }
    }
 
    if ( (int) $this->total_thread_count && (int) $this->pag_num ) {
        $pag_args = array(
            $r['page_arg'] => '%#%',
        );
 
        if ( defined( 'DOING_AJAX' ) && true === (bool) DOING_AJAX ) {
            $base = remove_query_arg( 's', wp_get_referer() );
        } else {
            $base = '';
        }
 
        $add_args = array();
 
        if ( ! empty( $this->search_terms ) ) {
            $add_args['s'] = $this->search_terms;
        }
 
        $this->pag_links = paginate_links( array(
            'base'      => add_query_arg( $pag_args, $base ),
            'format'    => '',
            'total'     => ceil( (int) $this->total_thread_count / (int) $this->pag_num ),
            'current'   => $this->pag_page,
            'prev_text' => __( '←', 'buddyboss' ),
            'next_text' => __( '→', 'buddyboss' ),
            'mid_size'  => 1,
            'add_args'  => $add_args,
        ) );
    }
}

Expand full source code Collapse full source code

Uses

Uses
Uses Description
bp-messages/classes/class-bp-messages-notice.php: BP_Messages_Notice::get_notices()

Pulls up a list of notices.
bp-messages/classes/class-bp-messages-notice.php: BP_Messages_Notice::get_total_notice_count()

Returns the total number of recorded notices.
bp-messages/classes/class-bp-messages-thread.php: BP_Messages_Thread::get_current_threads_for_user()

Get current message threads for a user.
bp-core/bp-core-template.php: bp_loggedin_user_id()

Get the ID of the currently logged-in user.
bp-core/bp-core-functions.php: bp_sanitize_pagination_arg()

Sanitizes a pagination argument based on both the request override and the original value submitted via a query argument, likely to a template class responsible for limiting the resultset of a template loop.
bp-core/bp-core-functions.php: bp_core_parse_args_array()

A utility for parsing individual function arguments into an array.
Show 1 more use Hide more uses

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.