create shortcode to list users with specific meta key value

Question

I have a function that I use to list users within a specific role, that match a specific meta key value. It works when I use it directly on the page ---

<?php 
$bmail = $current_user->user_email;
   $user_query = new WP_User_Query( array( 'meta_key' => 'broker_email', 'meta_value' => $bmail,  'fields' => 'all'  ) );
   $users = $user_query->get_results();

  if (!empty($users)) {
    echo '<ul>';
    foreach ($users as $user){
        echo '<li>' . $user->display_name . '</li>';
    }
    echo '</ul>';
  } else {
    echo 'No users found';
  };
?>

But when I try to create as a shortcode --

function thebroker_agents() {
  global $current_user;
$bmail = $current_user->user_email;
   $user_query = new WP_User_Query( array( 'meta_key' => 'broker_email', 'meta_value' => $bmail,  'fields' => 'all'  ) );
   $users = $user_query->get_results();
  if (!empty($users)) {
    echo '<ul>';
    foreach ($users as $user){
        echo '<li>' . $user->display_name . '</li>';
    }
    echo '</ul>';
  } else {
    echo 'No users found';
  }
// Adds the above function as as shortcode
add_shortcode( 'your_agents', 'thebroker_agents' );

And call on the same page like so --

<?php echo do_shortcode('[your_agents]'); ?>

It doesn't do anything except echo out the text - "[your_agents]"

What am I doing wrong with my shortcode function?

Answer 1

Try this:

function thebroker_agents() {
    global $current_user;
    $bmail = $current_user->user_email;
    $user_query = new WP_User_Query( array( 'meta_key' => 'broker_email', 'meta_value' => $bmail,  'fields' => 'all'  ) );
    $users = $user_query->get_results();
    if (!empty($users)) {
        $results = '<ul>';
        foreach ($users as $user){
            $results = '<li>' . $user->display_name . '</li>';
        }
        $results =  '</ul>';
    } else {
        $results =  'No users found';
    }
    wp_reset_postdata();
    return $results;
}
// Adds the above function as as shortcode
add_shortcode( 'your_agents', 'thebroker_agents' );

You were missing a last bracket. Also I changed the code a bit from echoing, to returning your results. I also reset your post data. Not sure why you didn't use a while statement in your code, but left that alone.

Since you are calling your function in php, you don't need a short code. you can call it just like this:

echo thebroker_agents();

However your echo do shortcode will still work as well.