WP Smith

Creating WordPress & Genesis Websites Since 2010

How to Get All Users of a Specific Role

WordPress Users
Recently, I needed to get all users of a certain role to modify a Comments Widget to remove those. Since WordPress 3.1, WordPress has made this quite easy to do now.

[php]
function wps_get_users_of_role( $role ) {
$wp_user_search = new WP_User_Query( array( 'role' => $role ) );
return $wp_user_search->get_results();
}
[/php]

This will give you an array that contains the following in an object:
[php]<pre>stdClass Object
(
[ID] => 1
[user_login] => username
[user_pass] => serialized PASSWORD
[user_nicename] => mynicename
[user_email] => [email protected]
[user_url] => http://mydomain.com
[user_registered] => GMT Time Stamp
[user_activation_key] => Something funky!
[user_status] => 0
[display_name] => My Display Name
)</pre>
[/php]

You can even set a predefined array and get only necessary information.

[php]
$args = array();
$args[0] = 'user_login';
$args[1] = 'user_nicename';
$args[2] = 'user_email';
$args[3] = 'user_url';
$wp_user_search = new WP_User_Query( array( 'role' => 'editor', 'fields' => $args ) );
$editors = $wp_user_search->get_results();
[/php]

Here's the result:
[php]<pre>stdClass Object
(
[user_login] => wpsmith
[user_nicename] => wpsmith
[user_email] => [email protected]
[user_url] =>
)</pre>
[/php]

How to Enable Genesis Author Boxes Automatically for ALL Users

In Genesis there are two ways to do this: there is the direct filter or the simple function call. Calling the function calls the filter, so either way the filter is being called.

To enable the Author Box you can add the following to your functions.php file.
[php]
// Enable Author Box on Single/Archive pages
add_filter( 'get_the_author_genesis_author_box_single', '__return_true' );
add_filter( 'get_the_author_genesis_author_box_archive', '__return_true' );
[/php]

Or, the Genesis way to do this is:
[php]
// Enable Author Box on Single/Archive pages
genesis_enable_author_box();
genesis_enable_author_box( array( 'type' => 'archive' ) );
[/php]

How to Add a Body Class to the WordPress Activation Page for Targeted CSS Styling

So the activation page (for a multisite network) can be a bit difficult to style for a full-width site that has a background on the body and a background on the #content-sidebar-wrap. Since this section is not part of Genesis (or any theme/framework for that matter) and is part of WordPress (thus no real hooks within the page), you need to add a body class to be able to target style.

[php]
add_action( 'activate_header' , 'wps_add_activate_class' );
/*
* Call body_class filter on activate_header action hook that only appears on wp-activate.php
* @author Travis Smith
*/
function wps_add_activate_class() {
add_filter( 'body_class' , 'wps_activate_class' );
}

/*
* Add specific CSS class by filter
* @author Travis Smith
*/
function wps_activate_class( $classes ) {

// add 'class-name' to the $classes array
$classes[] = 'activation-page';

// return the $classes array
return $classes;
}[/php]

Speaking at WordCamp Atlanta

Speaking at WordCamp AtlantaSo, I have been rather lazy announcing this, but I am speaking at WordCamp Atlanta coming up on February 4th at 11am on Professional Rapid Web Development Using the Genesis Framework.

During this seminar I plan to do the following:

  1. Introduce Genesis 1.8 and the new built-in Genesis Admin Class
  2. Introduce/Discuss 3 Other Classes including an Admin Builder Class (by Nick Croft), the Custom Metabox Class (by Jared Atchinson, Bill Erickson, & Andrew Norcross), and the Plugin Activation Class (by Thomas Griffin and Gary Jones) for rapid development
  3. Introduce my Genesis Starter Theme, WPS Starter Flex, which includes nearly everything a Genesis developer will need
  4. Discuss the Core Functionality Plugin approach to building websites
  5. Discuss the various resources available to a Genesis developer including the very active community

Beyond all these things, StudioPress has graciously donated some WordPress swag to give away during the presentation including 1 ProPlus Package & 3 Theme Packages (e.g., AgentPress).

Did I miss anything? Is there anything else that I should include? Please let me know!! I'll see you there!

How to Add a Custom Screen Icon for Genesis Admin Pages

In a previous post I discussed how to create a child theme admin page, and talked about a few of the new features of Genesis 1.8, . However, one thing I didn't discuss in the creation of the new admin pages is setting a custom screen icon.

While this may or may not make Genesis core, it is a simple addition. So in your __construct() method with $page_ops, enter a screen icon of 'custom'.
[php highlight="22,23,24"]
/**
* Create an admin menu item and settings page.
*
* @since 1.0.0
*/
function __construct() {

// Specify a unique page ID.
$page_id = 'child';

// Set it as a child to genesis, and define the menu and page titles
$menu_ops = array(
'submenu' => array(
'parent_slug' => 'genesis',
'page_title' => 'Genesis - WPS Starter Settings',
'menu_title' => 'WPS Starter Settings',
'capability' => 'manage_options',
)
);

// Set up page options. These are optional, so only uncomment if you want to change the defaults
$page_ops = array(
'screen_icon' => 'custom', // see $this->screen_icon() below
);

// Give it a unique settings field.
// You'll access them from genesis_get_option( 'option_name', CHILD_SETTINGS_FIELD );
$settings_field = CHILD_SETTINGS_FIELD;

// Set the default values
$default_settings = array(
'phone' => '',
'address' => '',
);

// Create the Admin Page
$this->create( $page_id, $menu_ops, $page_ops, $settings_field, $default_settings );

// Initialize the Sanitization Filter
add_action( 'genesis_settings_sanitizer_init', array( $this, 'sanitization_filters' ) );
}
[/php]

Next you will need a method to output the necessary CSS to display your icon.
[php highlight="42,43"]
/**
* Create an admin menu item and settings page.
*
* @since 1.0.0
*/
function __construct() {

// Specify a unique page ID.
$page_id = 'child';

// Set it as a child to genesis, and define the menu and page titles
$menu_ops = array(
'submenu' => array(
'parent_slug' => 'genesis',
'page_title' => 'Genesis - WPS Starter Settings',
'menu_title' => 'WPS Starter Settings',
'capability' => 'manage_options',
)
);

// Set up page options. These are optional, so only uncomment if you want to change the defaults
$page_ops = array(
'screen_icon' => 'custom', // see $this->screen_icon() below
);

// Give it a unique settings field.
// You'll access them from genesis_get_option( 'option_name', CHILD_SETTINGS_FIELD );
$settings_field = CHILD_SETTINGS_FIELD;

// Set the default values
$default_settings = array(
'phone' => '',
'address' => '',
);

// Create the Admin Page
$this->create( $page_id, $menu_ops, $page_ops, $settings_field, $default_settings );

// Initialize the Sanitization Filter
add_action( 'genesis_settings_sanitizer_init', array( $this, 'sanitization_filters' ) );

// Add custom screen icon
add_action( 'admin_head' , array( $this, 'screen_icon' ) );
}
[/php]

Now you will need to create the method within the class extension.
[php]

/**
* Custom Admin screen icon
*
* See /lib/classes/sanitization.php for all available filters.
*
* @since 1.0.0
*/
public function screen_icon() { ?>
<style>
#icon-custom { background-image: url('<?php echo WPS_ADMIN_IMAGES . '/staff_32x32.png'; ?>'); background-repeat: no-repeat; }
</style>
<?php
}
[/php]