[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-core/classes/ -> class-bp-suggestions.php (summary)

Core component classes.

File Size: 145 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 3 functions

  __construct()
  set_query()
  validate()

Functions
Functions that are not part of a class:

__construct( array $args = array()   X-Ref
Constructor.

param: array $args Optional. If set, used as the parameters for the suggestions service query.
since: 2.1.0

set_query( array $args = array()   X-Ref
Set the parameters for the suggestions service query.

param: array $args {
since: 2.1.0

validate()   X-Ref
Validate and sanitise the parameters for the suggestion service query.

Be sure to call this class' version of this method when implementing it in your own service.
If validation fails, you must return a WP_Error object.

return: true|WP_Error If validation fails, return a WP_Error object. On success, return true (bool).
since: 2.1.0



Generated: Wed Dec 2 01:01:35 2020 Cross-referenced by PHPXref 0.7.1