Wie filtere ich Benutzer auf der Admin-Benutzerseite nach benutzerdefiniertem Metafeld?

UPDATE 2018-06-28

Während der folgende Code meistens gut funktioniert, ist hier eine Umschreibung des Codes für WP> = 4.6.0 (unter Verwendung von PHP 7):

function add_course_section_filter( $which ) {

    // create sprintf templates for <select> and <option>s
    $st = '<select name="course_section_%s" style="float:none;"><option value="">%s</option>%s</select>';
    $ot = '<option value="%s" %s>Section %s</option>';

    // determine which filter button was clicked, if any and set section
    $button = key( array_filter( $_GET, function($v) { return __( 'Filter' ) === $v; } ) );
    $section = $_GET[ 'course_section_' . $button ] ?? -1;

    // generate <option> and <select> code
    $options = implode( '', array_map( function($i) use ( $ot, $section ) {
        return sprintf( $ot, $i, selected( $i, $section, false ), $i );
    }, range( 1, 3 ) ));
    $select = sprintf( $st, $which, __( 'Course Section...' ), $options );

    // output <select> and submit button
    echo $select;
    submit_button(__( 'Filter' ), null, $which, false);
}
add_action('restrict_manage_users', 'add_course_section_filter');

function filter_users_by_course_section($query)
{
    global $pagenow;
    if (is_admin() && 'users.php' == $pagenow) {
        $button = key( array_filter( $_GET, function($v) { return __( 'Filter' ) === $v; } ) );
        if ($section = $_GET[ 'course_section_' . $button ]) {
            $meta_query = [['key' => 'courses','value' => $section, 'compare' => 'LIKE']];
            $query->set('meta_key', 'courses');
            $query->set('meta_query', $meta_query);
        }
    }
}
add_filter('pre_get_users', 'filter_users_by_course_section');

Ich habe einige Ideen von @birgire und @cale_b aufgenommen, die auch Lösungen anbieten, die es wert sind, gelesen zu werden. Insbesondere ich:

1. Verwendete die Variable $which, die in v4.6.0 hinzugefügt wurde
2. Verwendete Best Practice für i18n unter Verwendung übersetzbarer Zeichenfolgen, z. __( 'Filter' )
3. Ausgetauschte Schleifen für die (modischeren?) array_map(), array_filter() und range()
4. Wird sprintf() zum Generieren der Markup-Vorlagen verwendet
5. Verwendete die eckige Klammer-Array-Notation anstelle von array()

Zuletzt entdeckte ich einen Fehler in meinen früheren Lösungen. Diese Lösungen bevorzugen immer den TOP <select> gegenüber dem BOTTOM <select>. Wenn Sie also eine Filteroption aus der oberen Dropdown-Liste ausgewählt und anschließend eine aus der unteren Dropdown-Liste ausgewählt haben, verwendet der Filter immer noch nur den Wert, der oben oben angegeben wurde (sofern er nicht leer ist). Diese neue Version behebt diesen Fehler.

UPDATE 2018-02-14

Dieses Problem wurde behoben seit WP 4.6.0 und die Änderungen sind in den offiziellen Dokumenten dokumentiert . Die unten stehende Lösung funktioniert jedoch immer noch.

Was hat das Problem verursacht (WP <4.6.0)

Das Problem bestand darin, dass die Aktion restrict_manage_users zweimal aufgerufen wurde: einmal ÜBER der Tabelle Users und einmal UNTER dieser. Dies bedeutet, dass ZWEI select Dropdowns mit dem gleichen Namen erstellt werden. Wenn auf die Schaltfläche Filter geklickt wird, überschreibt der Wert im zweiten Element select (d. H. Unter der Tabelle) den Wert im ersten Element, d. H. Den Wert über der Tabelle.

Wenn Sie in die Quelle WP eintauchen möchten, wird die Aktion restrict_manage_users innerhalb von WP_Users_List_Table::extra_tablenav($which) ausgelöst. Diese Funktion erstellt das systemeigene Dropdown-Menü, um die Rolle eines Benutzers zu ändern. Diese Funktion verfügt über die $which-Variable, die angibt, ob der select über oder unter dem Formular erstellt wird, und die es ermöglicht, den beiden Dropdowns unterschiedliche name-Attribute zuzuweisen. Leider wird die Variable $which nicht an die Aktion restrict_manage_users übergeben, daher müssen wir uns eine andere Methode ausdenken, um unsere eigenen benutzerdefinierten Elemente zu unterscheiden.

Eine Möglichkeit, dies zu tun, besteht, wie @Linnea oben vorschlägt, darin, JavaScript hinzuzufügen, um den Klick Filter abzufangen und die Werte der beiden Dropdowns zu synchronisieren. Ich entschied mich für eine reine PHP-Lösung, die ich jetzt beschreiben werde.

Wie man es repariert

Sie können die Möglichkeit nutzen, HTML-Eingaben in Felder mit Werten umzuwandeln und das Feld dann zu filtern, um nicht definierte Werte zu entfernen. Hier ist der Code:

function add_course_section_filter() {
    if ( isset( $_GET[ 'course_section' ]) ) {
        $section = $_GET[ 'course_section' ];
        $section = !empty( $section[ 0 ] ) ? $section[ 0 ] : $section[ 1 ];
    } else {
        $section = -1;
    }
    echo ' <select name="course_section[]" style="float:none;"><option value="">Course Section...</option>';
    for ( $i = 1; $i <= 3; ++$i ) {
        $selected = $i == $section ? ' selected="selected"' : '';
        echo '<option value="' . $i . '"' . $selected . '>Section ' . $i . '</option>';
    }
    echo '<input type="submit" class="button" value="Filter">';
}
add_action( 'restrict_manage_users', 'add_course_section_filter' );

function filter_users_by_course_section( $query ) {
    global $pagenow;

    if ( is_admin() && 
         'users.php' == $pagenow && 
         isset( $_GET[ 'course_section' ] ) && 
         is_array( $_GET[ 'course_section' ] )
        ) {
        $section = $_GET[ 'course_section' ];
        $section = !empty( $section[ 0 ] ) ? $section[ 0 ] : $section[ 1 ];
        $meta_query = array(
            array(
                'key' => 'course_section',
                'value' => $section
            )
        );
        $query->set( 'meta_key', 'course_section' );
        $query->set( 'meta_query', $meta_query );
    }
}
add_filter( 'pre_get_users', 'filter_users_by_course_section' );

Bonus: PHP 7 Refactor

Da ich von PHP 7 begeistert bin, ist hier für den Fall, dass Sie WP auf einem PHP 7-Server ausführen, eine kürzere, aufreizendere Version mit der Option null Vereinigungsoperator ?? :

function add_course_section_filter() {
    $section = $_GET[ 'course_section' ][ 0 ] ?? $_GET[ 'course_section' ][ 1 ] ?? -1;
    echo ' <select name="course_section[]" style="float:none;"><option value="">Course Section...</option>';
    for ( $i = 1; $i <= 3; ++$i ) {
        $selected = $i == $section ? ' selected="selected"' : '';
        echo '<option value="' . $i . '"' . $selected . '>Section ' . $i . '</option>';
    }
    echo '<input type="submit" class="button" value="Filter">';
}
add_action( 'restrict_manage_users', 'add_course_section_filter' );

function filter_users_by_course_section( $query ) {
    global $pagenow;

    if ( is_admin() && 'users.php' == $pagenow) {
        $section = $_GET[ 'course_section' ][ 0 ] ?? $_GET[ 'course_section' ][ 1 ] ?? null;
        if ( null !== $section ) {
            $meta_query = array(
                array(
                    'key' => 'course_section',
                    'value' => $section
                )
            );
            $query->set( 'meta_key', 'course_section' );
            $query->set( 'meta_query', $meta_query );
        }
    }
}
add_filter( 'pre_get_users', 'filter_users_by_course_section' );

Genießen!