Cómo mostrar enlaces de paginación para WP_User_Query

Realmente no deberías usar la respuesta de Pippin. La consulta es muy ineficiente. $user_count_query en el ejemplo puede devolver hasta 999,999 usuarios de tu base de datos a tu script, con todos los campos de usuario. Esto seguramente alcanzará los límites de memoria y/o tiempo de PHP si/cuando tu sitio crezca lo suficiente.

Pero puede que esa haya sido la única solución en 2012.

Aquí hay una mejor manera de hacerlo. En este ejemplo solo tengo página siguiente y anterior pero si necesitas paginación numerada, las variables están ahí para construirla. WordPress no tiene una función de paginación compatible con WP_User_Query (que yo sepa).

<?php

// Variables de paginación
$current_page = get_query_var('paged') ? (int) get_query_var('paged') : 1;
$users_per_page = 2; // AUMENTA ESTO DESPUÉS DE PROBAR ;)

$args = array(
    'number' => $users_per_page, // Cuántos por página
    'paged' => $current_page // Qué página obtener, comenzando desde 1.
);

$users = new WP_User_Query( $args );

$total_users = $users->get_total(); // Cuántos usuarios tenemos en total (más allá de la página actual)
$num_pages = ceil($total_users / $users_per_page); // Cuántas páginas de usuarios necesitaremos

?>
    <h3>Página <?php echo $current_page; ?> de <?php echo $num_pages; ?></h3>
    <p>Mostrando <?php echo $users_per_page; ?> de <?php echo $total_users; ?> usuarios</p>

    <table>
        <thead>
            <tr>
                <th>Nombre</th>
                <th>Apellido</th>
                <th>Correo electrónico</th>
            </tr>
        </thead>

        <tbody>
            <?php
            if ( $users->get_results() ) foreach( $users->get_results() as $user )  {
                $firstname = $user->first_name;
                $lastname = $user->last_name;
                $email = $user->user_email;
                ?>
                <tr>
                    <td><?php echo esc_html($firstname); ?></td>
                    <td><?php echo esc_html($lastname); ?></td>
                    <td><?php echo esc_html($email); ?></td>
                </tr>
                <?php
            }
            ?>
        </tbody>
    </table>

    <p>
        <?php
        // Página anterior
        if ( $current_page > 1 ) {
            echo '<a href="'. add_query_arg(array('paged' => $current_page-1)) .'">Página Anterior</a>';
        }

        // Página siguiente
        if ( $current_page < $num_pages ) {
            echo '<a href="'. add_query_arg(array('paged' => $current_page+1)) .'">Página Siguiente</a>';
        }
        ?>
    </p>

Ejemplo mostrando página 2:

Actualización 8/6/2018: Cómo añadir números de página en lugar de Siguiente/Anterior

Si quieres tener números de página en lugar de enlaces de página siguiente/anterior, aquí está cómo puedes configurarlo. Ten en cuenta que necesitarás reemplazar los números con enlaces de página, no serán clickeables en este ejemplo (basado en https://stackoverflow.com/a/11274294/470480, modificado para mostrar una cantidad consistente de números intermedios y no añadir "..." a menos que se salte una página).

También puedes ver mi archivo gist que contiene una función reusable para este propósito.

$current_page = 5; // Ejemplo
$num_pages = 10; // Ejemplo

$edge_number_count = 2; // Cambia esto, opcional

$start_number = $current_page - $edge_number_count;
$end_number = $current_page + $edge_number_count;

// Menos uno para no dividir el número inicial innecesariamente, ej: "1 ... 2 3" debería empezar como "1 2 3"
if ( ($start_number - 1) < 1 ) {
    $start_number = 1;
    $end_number = min($num_pages, $start_number + ($edge_number_count*2));
}

// Más uno para no dividir el número final innecesariamente, ej: "8 9 ... 10" debería permanecer como "8 9 10"
if ( ($end_number + 1) > $num_pages ) {
    $end_number = $num_pages;
    $start_number = max(1, $num_pages - ($edge_number_count*2));
}

if ($start_number > 1) echo " 1 ... ";

for($i=$start_number; $i<=$end_number; $i++) {
    if ( $i === $current_page ) echo " [{$i}] ";
    else echo " {$i} ";
}

if ($end_number < $num_pages) echo " ... {$num_pages} ";

Salida (de la página 1 a 10):

[1]  2  3  4  5  ... 10 
1  [2]  3  4  5  ... 10 
1  2  [3]  4  5  ... 10 
1  2  3  [4]  5  ... 10 

1 ...  3  4  [5]  6  7  ... 10 
1 ...  4  5  [6]  7  8  ... 10 

1 ...  6  [7]  8  9  10
1 ...  6  7  [8]  9  10
1 ...  6  7  8  [9]  10
1 ...  6  7  8  9  [10]

Todos los créditos deberían ir para @radley-sustaire por su respuesta, pero noté un pequeño error en ella, así que comparto mi versión de la respuesta aquí.

Con mi versión también estaba filtrando resultados por ubicación, palabra clave, etc., por lo que algunas páginas tenían menos resultados que la variable '$users_per_page'. Por ejemplo, si tenía configurado mostrar 10 usuarios por página, pero el filtro solo devolvía 3 usuarios, obtenía "Mostrando 10 de 3 usuarios" en la parte superior de la página. Obviamente esto no tenía sentido, así que agregué una simple declaración "if" para verificar si el conteo de resultados era mayor que la variable '$users_per_page'.

Radley, si editas tu respuesta con esta actualización, con gusto votaré por ella como la respuesta correcta, ya que creo que es mejor que la solución de Pippin.

Así que este es el código final para quien lo necesite.

<?php

// Variables de paginación
$current_page = get_query_var('paged') ? (int) get_query_var('paged') : 1;
$users_per_page = 10;

$args = array(
    'number' => $users_per_page, // Cuántos por página
    'paged' => $current_page // Qué página obtener, comenzando desde 1.
);

$users = new WP_User_Query( $args );

$total_users = $users->get_total(); // Cuántos usuarios tenemos en total (más allá de la página actual)
$num_pages = ceil($total_users / $users_per_page); // Cuántas páginas de usuarios necesitaremos

if ($total_users < $users_per_page) {$users_per_page = $total_users;}

?>
    <h3>Página <?php echo $current_page; ?> de <?php echo $num_pages; ?></h3>
    <p>Mostrando <?php echo $users_per_page; ?> de <?php echo $total_users; ?> usuarios</p>

    <table>
        <thead>
            <tr>
                <th>Nombre</th>
                <th>Apellido</th>
                <th>Correo electrónico</th>
            </tr>
        </thead>

        <tbody>
            <?php
            if ( $users->get_results() ) foreach( $users->get_results() as $user )  {
                $firstname = $user->first_name;
                $lastname = $user->last_name;
                $email = $user->user_email;
                ?>
                <tr>
                    <td><?php echo esc_html($firstname); ?></td>
                    <td><?php echo esc_html($lastname); ?></td>
                    <td><?php echo esc_html($email); ?></td>
                </tr>
                <?php
            }
            ?>
        </tbody>
    </table>

    <p>
        <?php
        // Página anterior
        if ( $current_page > 1 ) {
            echo '<a href="'. add_query_arg(array('paged' => $current_page-1)) .'">Página anterior</a>';
        }

        // Página siguiente
        if ( $current_page < $num_pages ) {
            echo '<a href="'. add_query_arg(array('paged' => $current_page+1)) .'">Página siguiente</a>';
        }
        ?>
    </p>