Method type #
non-static
Description #
Get vendors as an array based on arguments.
Parameters #
$args
(array)(optional) Different parameters to get vendors..
- role__in
( array ) array of roles default [ ‘seller’, ‘administrator’ ] - number
( integer ) number of posts default 10 - offset
( integer ) Retrieve from id default 0 - orderby
( string ) get vendors by default registered - order
( string ) show result in ascending or descending default ASC - status
( array ) vendor status default [ ‘approved’ ] - featured
( string ) value can be yes or no default ” - meta_query
( array ) custom meta agruments. - fields
( string ) default ‘all’
Return #
( array ) array of queried vendors.
More informaiton #
Usage #
$defaults = [
'role__in' => [ 'seller', 'administrator' ],
'number' => 10,
'offset' => 0,
'orderby' => 'registered',
'order' => 'ASC',
'status' => [ 'approved' ],
'featured' => 'yes',
'meta_query' => [],
'fields' => 'all',
];
$all_vendors = dokan()->vendor->get_vendors( $args );
Alternative global function #
dokan_get_sellers( $args = [] );