BP_User_Query::get_include_ids( array $include = array() )

Fetch the IDs of users to put in the IN clause of the main query.


Description Description

By default, returns the value passed to it ($this->query_vars[‘include’]). Having this abstracted into a standalone method means that extending classes can override the logic, parsing together their own user_id limits with the ‘include’ ids passed to the class constructor. See BP_Group_Member_Query for an example.


Parameters Parameters

$include

(Optional) Sanitized array of user IDs, as passed to the 'include' parameter of the class constructor.

Default value: array()


Top ↑

Return Return

(array) The list of users to which the main query should be limited.


Top ↑

Source Source

File: bp-core/classes/class-bp-user-query.php

	public function get_include_ids( $include = array() ) {
		return $include;
	}

Top ↑

Changelog Changelog

Changelog
Version Description
1.8.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.