JavaScript array_filter

Filters elements from the array via the callback.

function array_filter (arr, func) {
    // Filters elements from the array via the callback.  
    // 
    // version: 1109.2015
    // discuss at: http://phpjs.org/functions/array_filter    // +   original by: Brett Zamir (http://brett-zamir.me)
    // %        note 1: Takes a function as an argument, not a function's name
    // *     example 1: var odd = function (num) {return (num & 1);}; 
    // *     example 1: array_filter({"a": 1, "b": 2, "c": 3, "d": 4, "e": 5}, odd);
    // *     returns 1: {"a": 1, "c": 3, "e": 5}    // *     example 2: var even = function (num) {return (!(num & 1));}
    // *     example 2: array_filter([6, 7, 8, 9, 10, 11, 12], even);
    // *     returns 2: {0: 6, 2: 8, 4: 10, 6: 12} 
    var retObj = {},
        k; 
    for (k in arr) {
        if (func(arr[k])) {
            retObj[k] = arr[k];
        }    }
 
    return retObj;
}

external links: original PHP docs | raw js source

Examples

» Example 1

Running

1 2	var odd = function (num) {return (num & 1);}; array_filter({"a": 1, "b": 2, "c": 3, "d": 4, "e": 5}, odd);

Should return

1	{"a": 1, "c": 3, "e": 5}

» Example 2

Running

1 2	var even = function (num) {return (!(num & 1));} array_filter([6, 7, 8, 9, 10, 11, 12], even);

Should return

1	{0: 6, 2: 8, 4: 10, 6: 12}

Dependencies

No dependencies, you can use this function standalone.

Open syntax issues

php.js uses JsLint to help us keep our code consistent and prevent some common bugs.

Eventually we want all code to pass or at least take into consideration most fixes suggested by JsLint, following this JsLint configuration we’ve decided on.

Authors

Thanks to the following developers, you get to have array_filter goodness in JavaScript.

Brett Zamir ( original )

Comments

Add Comment

Name

Website

Title

Content

Use:

[CODE]
your_stuff('here');
[/CODE]

for proper code formatting
By submitting code here you are allowing us to use it in php.js hence dual licensing it under the MIT and GPL licenses

بوابة نعم
Apr 17th

http://an3m1.com/('بوابة نعم');

بوابة نعم
Apr 17th

I have a lot to benefit from this article and thank you for this wonderful effort to this article and will continue my many articles you have other
<a href="http://an3m1.com/">بوابة نعم</a>

Tim Younger
Feb 22nd

blast, i tried to solve it concisely without needing to loop twice. this one actually works though:

if (arr instanceof Array) { var retArr = []; for(k in retObj) {retArr.push(retObj[k])}; return retArr; }

Tim Younger
Feb 22nd

might want to return an array if param was an array. i'm sure there is a more secure way to evaluate if the param was an array, but is_array is overkill for native support.

if ('number'==typeof arr.length && isFinite(arr.length)) {return Array.prototype.slice.call(retObj);}

Brett Zamir
8 Oct '11

@max4ever: The latest version in Git now adds support for a single-argument-only call. Thanks!

max4ever
7 Oct '11

usually in php array_filter($array), filters empty values(like '', 0, false ...)

Brett Zamir
18 Aug '09

Of course that's a typo with array_filter2 (which should just be array_filter)

Brett Zamir
18 Aug '09

@J: Sorry, no difference. If you set a key on a JS array, it will fill in the gaps with 'undefined'.

Try this with our function:

var arr = array_filter2([3, 4, 5, 6], function (n) {return n >= 5;});
alert(arr.length); // Should be 2, but is 4

Yours gives four, while ours doesn't pretend to be an array (there's no length at all), so it is not confusing.

J
18 Aug '09

Oops, I meant to put retObj.length to omit the null ones..
Not sure if that makes any diff..

if(!this.is_null(arr[i])){
	retObj[retObj.length] = arr[i];
}

Brett Zamir
17 Aug '09

Sorry, I meant, "we really have to return an object"

Brett Zamir
17 Aug '09

@J.: While I know it's definitely tempting to try it that way, a problem arises when the preserved filtered results are not all sequential at the beginning of the array (probably most times); the keys will either end up not being preserved (as they are in PHP), or, as in your code, we'd end up making an array with "undefined" values throughout in place of missing values and which showed a size equal to the original array instead of the length of filter-positive values (as most people would probably want it).

In a number of functions we really have to return an array, though there may be a few which could be adapted to try to return a genuine array where possible. But as far as array_filter, the cases where this would be valid (positive results all sequential at the beginning) would be uncommon, and probably confusing if we didn't follow a uniform policy (unless, again, the results would be consistent).

J.
17 Aug '09

php handles both array and object, unfortunately JS does not distinguish indexed array and hashed array object...

array_filter in php handles both types and returns type intacted.. Can we add type check like below?

array_filter: function  (arr, func) {
	    var retObj, k, type = 'array';
	    func_set = 0;
	    
	    if(this.isset(func))
	    	func_set = 1;
	    // Check for 'length'
	    if(arr.length === undefined){
	    	type = 'hashed_array';
	    }
	    if(type == 'hashed_array'){
	    	retObj = {};
		    for (k in arr) {
		    	if(func_set){
			        if (func(arr[k])) {
			            retObj[k] = arr[k];
			        }
		    	}else{
		    		if(this.is_null(arr[k]))
		    			continue;
		    		retObj[k] = arr[k];
		    	}
		    }
	    }else{
	    	retObj = [];
	    	for(i=0;i<arr.length;++i){
	    		if(func_set){
			        if (func(arr[i])) {
			            retObj[i] = arr[i];
			        }
		    	}else{
		    		if(this.is_null(arr[i]))
		    			continue;
		    		retObj[i] = arr[i];
		    	}
	    	}
	    }
	    
	    return retObj;
	}

Contribute a New function