Contents

Code Reference Functions bp_sort_by_key()

bp_sort_by_key( array $items, string|int $key, string $type = 'alpha', bool $preserve_keys = false )

Sort an array of objects or arrays by a specific key/property.

Description

The main purpose for this function is so that you can avoid having to create your own awkward callback function for usort().

Parameters

$items

(Required) The items to be sorted. Its constituent items can be either associative arrays or objects.

$key

(Required) The array index or property name to sort by.

$type

(Optional) Sort type. 'alpha' for alphabetical, 'num' for numeric. Default: 'alpha'.

Default value: 'alpha'

$preserve_keys

(Optional) Whether to keep the keys or not.

Default value: false

Return

(array) $items The sorted array.

Source

File: bp-core/bp-core-functions.php

118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
function bp_sort_by_key( $items, $key, $type = 'alpha', $preserve_keys = false ) {
    $callback = function( $a, $b ) use ( $key, $type ) {
        $values = array( 0 => false, 1 => false );
        foreach ( func_get_args() as $indexi => $index ) {
            if ( isset( $index->{$key} ) ) {
                $values[ $indexi ] = $index->{$key};
            } elseif ( isset( $index[ $key ] ) ) {
                $values[ $indexi ] = $index[ $key ];
            }
        }
 
        if ( isset( $values[0], $values[1] ) ) {
            if ( 'num' === $type ) {
                $cmp = $values[0] - $values[1];
            } else {
                $cmp = strcmp( $values[0], $values[1] );
            }
 
            if ( 0 > $cmp ) {
                $retval = -1;
            } elseif ( 0 < $cmp ) {
                $retval = 1;
            } else {
                $retval = 0;
            }
            return $retval;
        } else {
            return 0;
        }
    };
 
    if ( true === $preserve_keys ) {
        uasort( $items, $callback );
    } else {
        usort( $items, $callback );
    }
 
    return $items;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 2.7.0 Added $preserve_keys parameter. BuddyPress 2.7.0 Added $preserve_keys parameter.
BuddyPress 2.2.0 Introduced.
Used By
Used By Description
bp-groups/bp-groups-functions.php: bp_get_user_groups()

Get a list of groups of which the specified user is a member.
bp-friends/classes/class-bp-friends-friendship.php: BP_Friends_Friendship::get_friendships()

Get the friendships for a given user.
bp-templates/bp-nouveau/includes/activity/functions.php: bp_nouveau_activity_localize_scripts()

Localize the strings needed for the Activity Post form UI
bp-templates/bp-nouveau/includes/groups/functions.php: bp_nouveau_groups_localize_scripts()

Localize the strings needed for the Group’s Invite UI
bp-core/classes/class-bp-component.php: BP_Component::setup_admin_bar()

Set up the component entries in the WordPress Admin Bar.
bp-core/bp-core-functions.php: bp_alpha_sort_by_key()

Sort an array of objects or arrays by alphabetically sorting by a specific key/property.
bp-core/bp-core-attachments.php: bp_attachments_enqueue_scripts()

Enqueues the script needed for the Uploader UI.
bp-activity/bp-activity-functions.php: bp_activity_set_action()

Register an activity ‘type’ and its action description/callback.
Show 3 more used by Hide more used by

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.