Elgg\Database\Plugins::getEntitiesFromUserSettings PHP Method

getEntitiesFromUserSettings() public method

Takes all the options for {@link elgg_get_entities_from_private_settings()} in addition to the ones below.
public getEntitiesFromUserSettings ( array $options = [] ) : mixed
$options array Array in the format: plugin_id => STR The plugin id. Required. plugin_user_setting_names => null|ARR private setting names plugin_user_setting_values => null|ARR metadata values plugin_user_setting_name_value_pairs => null|ARR ( name => 'name', value => 'value', 'operand' => '=', ) Currently if multiple values are sent via an array (value => array('value1', 'value2') the pair's operand will be forced to "IN". plugin_user_setting_name_value_pairs_operator => null|STR The operator to use for combining (name = value) OPERATOR (name = value); default AND
return mixed int If count, int. If not count, array. false on errors.
    function getEntitiesFromUserSettings(array $options = array())
    {
        $singulars = array('plugin_user_setting_name', 'plugin_user_setting_value', 'plugin_user_setting_name_value_pair');
        $options = _elgg_normalize_plural_options_array($options, $singulars);
        // rewrite plugin_user_setting_name_* to the right PS ones.
        $map = array('plugin_user_setting_names' => 'private_setting_names', 'plugin_user_setting_values' => 'private_setting_values', 'plugin_user_setting_name_value_pairs' => 'private_setting_name_value_pairs', 'plugin_user_setting_name_value_pairs_operator' => 'private_setting_name_value_pairs_operator');
        foreach ($map as $plugin => $private) {
            if (!isset($options[$plugin])) {
                continue;
            }
            if (isset($options[$private])) {
                if (!is_array($options[$private])) {
                    $options[$private] = array($options[$private]);
                }
                $options[$private] = array_merge($options[$private], $options[$plugin]);
            } else {
                $options[$private] = $options[$plugin];
            }
        }
        $prefix = $this->namespacePrivateSetting('user_setting', '', $options['plugin_id']);
        $options['private_setting_name_prefix'] = $prefix;
        return elgg_get_entities_from_private_settings($options);
    }