settings = AA_settings();
$this->tabs = array();
}
/**
* Set a field id callback handler
*
* @access public
*
* @param callback $callback
*
* @return void
*/
function setFieldIdCallback( $callback ) {
if ( is_callable( $callback ) ) {
$this->field_id_callback = $callback;
} else {
trigger_error( 'Error: callback function is not callable.', E_USER_ERROR );
$this->field_id_callback = null;
}
}
/**
* Set a field name callback handler
*
* @access public
*
* @param callback $callback
*
* @return void
*/
function setFieldNameCallback( $callback ) {
if ( is_callable( $callback ) ) {
$this->field_name_callback = $callback;
} else {
trigger_error( 'Error: callback function is not callable.', E_USER_ERROR );
$this->field_name_callback = null;
}
}
/**
* Return the field id
*
* @access protected
*
* @param string $id
*
* @return string
*/
function _getFieldId( $id ) {
if ( $this->field_id_callback != null ) {
$id = call_user_func( $this->field_id_callback, $id );
}
return $id;
}
/**
* Return the field name
*
* @access protected
*
* @param string $name
*
* @return string
*/
function _getFieldName( $name ) {
if ( $this->field_name_callback != null ) {
$name = call_user_func( $this->field_name_callback, $name );
}
// TODO: remove when core fixed
// hack to handle cange in core in WP 4.4
if ( ( strlen( $name ) - 1 ) !== strrpos( $name, ']' ) ) {
$name = $name . ']';
}
$name = str_replace( ']]', ']', $name );
return $name;
}
/**
* Renders the blog filter select field.
*
* @param mixed $values the field values
* @param string $name the field name
*
* @return string
*/
function renderFieldBlogs( $values = array(), $name = 'blogs' ) {
$html = '';
if ( $this->settings->blog_selection_allowed() ) {
$id = $this->_getFieldId( $name );
$name = $this->_getFieldName( $name );
$html .= '' . AAFormHelper::choice( $name, Array( - 1 => "All" ) + $this->_getAllBlogs(), $values, array(
'id' => $id,
'multiple' => true,
'label' => '' . __( 'Show users from blogs', 'author-avatars' ) . ':
',
'help' => '
' . __( 'If no blog is selected only users from the current blog are displayed.', 'author-avatars' ) . '',
) ) . '
';
}
return $html;
}
/**
* Retrieves all blogs, and returns them as an associative array (blog id -> blog name)
*
* The list only contains public blogs which are not marked as archived, deleted
* or spam and the list is ordered by blog name.
*
* @see http://codex.wordpress.org/WPMU_Functions/get_blog_list
* @access private
* @return Array of blog names
*/
function _getAllBlogs() {
global $wpdb;
$where_options = array(
'public' => 1,
'archived' => 0,
'mature' => 0,
'spam' => 0,
'deleted' => 0
);
$where_options_filtered = apply_filters( 'aa_get_all_blogs_where', $where_options );
$where_string = '';
foreach ( $where_options_filtered as $key => $where ) {
if ( ! array_key_exists( $key, $where_options ) ) {
continue;
}
$bool = ( 1 == $where ) ? 1 : 0;
$where_string .= " AND $key = '$bool'";
}
$blogs = $wpdb->get_results( $wpdb->prepare( "SELECT blog_id, path FROM $wpdb->blogs WHERE 1 = 1 AND site_id = %d $where_string", $wpdb->siteid ), ARRAY_A );
$blog_list = array();
foreach ( (array) $blogs as $details ) {
$blog_list[ $details['blog_id'] ] = get_blog_option( $details['blog_id'], 'blogname', $details['path'] ) . ' (' . $details['blog_id'] . ')';
}
asort( $blog_list );
return $blog_list;
}
/**
* Renders the group by field, which is either a dropdown field or a single checkbox if only one option is available.
*
* @param mixed $values the field values
* @param string $name the field name
*
* @return string
*/
function renderFieldGroupBy( $values = array(), $name = 'group_by' ) {
$group_by_options = Array();
if ( $this->settings->blog_selection_allowed() ) {
$group_by_options['blog'] = __( 'Group by blogs', 'author-avatars' );
}
$html = '';
if ( ! empty( $group_by_options ) ) {
$attributes = array();
$attributes['id'] = $this->_getFieldId( $name );
$attributes['expanded'] = true;
if ( count( $group_by_options ) > 1 ) {
$attributes['label'] = __( 'User list grouping', 'author-avatars' ) . ':
';
} else {
$attributes['wrapper_tag'] = 'p';
}
$name = $this->_getFieldName( $name );
$html = AAFormHelper::choice( $name, $group_by_options, $values, $attributes );
}
return $html;
}
/**
* Renders the roles field
*
* @param mixed $values the field values
* @param string $name the field name
*
* @return string
*/
function renderFieldRoles( $values = array(), $name = 'roles' ) {
$roles = $this->_getAllRoles();
$roles = array_merge( $roles, array( 'Commentator' => __( 'Commentators', 'author-avatars' ) ) );
global $coauthors_plus;
if ( $coauthors_plus ) {
$roles = array_merge( $roles, array( 'coauthors_plus' => __( 'Co-Author Plus Guest Authors', 'author-avatars' ) ) );
}
$html = '';
if ( ! empty( $roles ) ) {
$attributes = array(
'id' => $this->_getFieldId( $name ),
'expanded' => true,
'multiple' => true,
'wrapper_tag' => 'p',
'label' => '' . __( 'Show roles', 'author-avatars' ) . ':
',
);
if ( AA_is_wpmu() && AA_is_bp() ) {
if ( version_compare( BP_VERSION, '1.3', '<=' ) ) {
$attributes['help'] = '
Warning: Commentator avatars are not displayed properly with BuddyPress versions <= 1.3!';
}
}
$name = $this->_getFieldName( $name );
$html .= AAFormHelper::choice( $name, $roles, $values, $attributes );
}
return $html;
}
/**
* Retrieves all roles, and returns them as an associative array (key -> role name)
*
* @access private
* @return Array of role names.
*/
function _getAllRoles() {
global $wpdb;
$roles_data = get_option( $wpdb->prefix . 'user_roles' );
$roles = array();
if ( false === $roles_data ) {
return $roles;
}
foreach ( $roles_data as $key => $role ) {
$roles[ $key ] = $this->_roleStripLevel( $role['name'] );
}
return $roles;
}
/**
* Strips the user level from a role name (see option user_roles)
*
* @access private
*
* @param $element A role name, $role['name']
*
* @return the clean role name without user level added on the end.
*/
function _roleStripLevel( $element ) {
$parts = explode( '|', $element );
return $parts[0];
}
/**
* Renders the hiddenusers input text field.
*
* @param string $value the field value
* @param string $name the field name
*
* @return string
*/
function render_field_hidden_users( $value = '', $name = 'hiddenusers' ) {
$attributes = array(
'id' => $this->_getFieldId( $name ),
'label' => '' . __( 'Hidden users', 'author-avatars' ) . ':
',
'help' => '
(' . __( 'Comma separate list of user login ids. Hidden user are removed before the white list', 'author-avatars' ) . ')',
'rows' => 2,
'style' => 'width:95%;',
);
$name = $this->_getFieldName( $name );
return '' . AAFormHelper::input( 'text', $name, $value, $attributes ) . '
';
}
/**
* Renders the hiddenusers input text field.
*
* @param string $value the field value
* @param string $name the field name
*
* @return string
*/
function render_field_white_list_users( $value = '', $name = 'whitelistusers' ) {
$attributes = array(
'id' => $this->_getFieldId( $name ),
'label' => '' . __( 'White List of users', 'author-avatars' ) . ':
',
'help' => '
(' . __( '0nly show these users, Comma separate list of user login ids', 'author-avatars' ) . ')',
'rows' => 2,
'style' => 'width:95%;',
);
$name = $this->_getFieldName( $name );
return '' . AAFormHelper::input( 'text', $name, $value, $attributes ) . '
';
}
/**
* Renders the set of display options (as it's used in the widget atm)
*
* @param string $display_values
* @param string $name_base
*
* @return string
* @deprecated this is used on the old widget admin should be replaced by the new tab base one...
*/
function renderDisplayOptions( $display_values = array(), $name_base = 'display' ) {
$html = '';
$html .= $this->renderFieldDisplayOptions( $display_values, $name_base );
$html .= $this->renderFieldMaxBioLength( $display_values, $name_base );
$html .= $this->renderFieldUserLink( $display_values, $name_base . '[user_link]' );
$html .= $this->renderFieldOrder( $display_values['order'], $name_base . '[order]' );
$html .= $this->renderFieldSortDirection( $display_values['sort_direction'], $name_base . '[sort_direction]' );
$html .= '
';
$html .= $this->renderFieldLimit( $display_values['limit'], $name_base . '[limit]' );
$html .= '
';
$html .= $this->renderFieldMinPostCount( $display_values['min_post_count'], $name_base . '[min_post_count]' );
$html .= '
';
$html .= $this->renderFieldAvatarSize( $display_values['avatar_size'], $name_base . '[avatar_size]' );
return $html;
}
/**
* Renders the display options checkbox matrix (show name?)
*
* @param mixed $values the field values
* @param string $name the field name
*
* @return string
*/
function renderFieldDisplayOptions( $values = array(), $name = 'display' ) {
$display_options = Array(
'show_name' => __( 'Show name', 'author-avatars' ),
'show_email' => __( 'Show email', 'author-avatars' ),
'show_nickname' => __( 'Show Nickname', 'author-avatars' ),
'show_biography' => __( 'Show biography', 'author-avatars' ),
'show_postcount' => __( 'Show number of posts', 'author-avatars' ),
'show_last_post' => __( 'Show link to authors last post', 'author-avatars' ),
);
if ( AA_is_bbpress() ) {
$display_options['show_bbpress_post_count'] = __( 'Show BBPress Post Count', 'author-avatars' );
}
$display_options = apply_filters( 'aa_render_field_display_options', $display_options );
$attributes = array(
'id' => $this->_getFieldId( $name ),
'expanded' => true,
'multiple' => true,
'label' => '' . __( 'Display options', 'author-avatars' ) . '
',
'wrapper_tag' => 'p',
);
$name = $this->_getFieldName( $name );
return AAFormHelper::choice( $name, $display_options, $values, $attributes );
}
/**
* Renders the "order by" dropdown
*
* @param mixed $values the field values
* @param string $name the field name
*
* @return string
*/
function renderFieldOrder( $values = array(), $name = 'order' ) {
$order_options = Array(
'date_registered' => __( 'Date of Registration', 'author-avatars' ),
'display_name' => __( 'Display Name', 'author-avatars' ),
'nickname' => __( 'Nickname', 'author-avatars' ),
'first_name' => __( 'First Name', 'author-avatars' ),
'last_name' => __( 'Last Name', 'author-avatars' ),
'user_login' => __( 'Login Name', 'author-avatars' ),
'post_count' => __( 'Number of Posts', 'author-avatars' ),
'random' => __( 'Random', 'author-avatars' ),
'whitelist' => __( 'White List', 'author-avatars' ),
'user_id' => __( 'User Id', 'author-avatars' ),
'recent_post_activity' => __( 'Recent Posts Activity', 'author-avatars' ),
'recent_site_activity' => __( 'Recent Sitewide Activity', 'author-avatars' ),
);
if ( AA_is_bbpress() ) {
$order_options['bbpress_post_count'] = __( 'BBPress Post Count', 'author-avatars' );
}
if ( AA_is_bp() ) {
$order_options['budy_press_recent_activity'] = __( 'BudyPress last activity', 'author-avatars' );
}
$attributes = array(
'id' => $this->_getFieldId( $name ),
'label' => __( 'Sorting order', 'author-avatars' ) . ': ',
);
$name = $this->_getFieldName( $name );
return '' . AAFormHelper::choice( $name, $order_options, $values, $attributes ) . '
';
}
/**
* Renders the "user_link" dropdown
*
* @param mixed $values the field values
* @param string $name the field name
*
* @return string
*/
function renderFieldUserLink( $values = array(), $name = 'user_link' ) {
$user_link_options = Array(
'' => '-',
'authorpage' => __( 'Author Page', 'author-avatars' ),
'website' => __( 'Website', 'author-avatars' ),
'last_post' => __( 'Users Last Post this blog', 'author-avatars' ),
'last_post_filtered' => __( 'Filtered Last Post', 'author-avatars' ),
);
if ( AA_is_bp() ) {
$user_link_options['bp_memberpage'] = __( 'BP Member Page', 'author-avatars' );
}
if ( class_exists( 'UM_API' ) ) {
$user_link_options['um_profile'] = __( 'UM Profile Page', 'author-avatars' );
}
if ( AA_is_wpmu() ) {
$user_link_options['last_post_all'] = __( 'Users Last Post ALL blogs', 'author-avatars' );
$user_link_options['blog'] = __( 'Blog', 'author-avatars' );
}
if ( AA_is_bbpress() ) {
$user_link_options['bbpress_memberpage'] = __( 'BBpress Member Page', 'author-avatars' );
}
$attributes = array(
'id' => $this->_getFieldId( $name ),
'label' => __( 'Link users to', 'author-avatars' ) . ': ',
);
$name = $this->_getFieldName( $name );
return '' . AAFormHelper::choice( $name, $user_link_options, $values, $attributes ) . '
';
}
/**
* Renders the "order by" dropdown
*
* @param mixed $values the field values
* @param string $name the field name
*
* @return string
*/
function renderFieldSortDirection( $values = array(), $name = 'sort_direction' ) {
$order_options = Array(
'asc' => __( 'Ascending', 'author-avatars' ),
'desc' => __( 'Descending', 'author-avatars' )
);
$attributes = array(
'id' => $this->_getFieldId( $name ),
'label' => __( 'Sorting direction', 'author-avatars' ) . ': ',
);
$name = $this->_getFieldName( $name );
return '' . AAFormHelper::choice( $name, $order_options, $values, $attributes ) . '
';
}
/**
* Renders the "limit" input field
*
* @param string $value the field value
* @param string $name the field name
*
* @return string
*/
function renderFieldLimit( $value = '', $name = 'limit' ) {
$attributes = array(
'id' => $this->_getFieldId( $name ),
'label' => __( 'Max. number of avatars shown', 'author-avatars' ) . ': ',
'size' => '5'
);
$name = $this->_getFieldName( $name );
return '' . AAFormHelper::input( 'text', $name, $value, $attributes ) . '
';
}
/**
* Renders the "limit" input field
*
* @param string $value the field value
* @param string $name the field name
*
* @return string
*/
function renderPageLimit( $value = '', $name = 'page_size' ) {
$attributes = array(
'id' => $this->_getFieldId( $name ),
'label' => __( 'Max. number of avatars per page', 'author-avatars' ) . ': ',
'size' => '5'
);
$name = $this->_getFieldName( $name );
return '' . AAFormHelper::input( 'text', $name, $value, $attributes ) . '
';
}
/**
* Renders the "max bio length" input field
*
* @param string $value the field value
* @param string $name the field name
*
* @return string
*/
function renderFieldMaxBioLength( $value = '', $name = 'max_bio_length' ) {
$attributes = array(
'id' => $this->_getFieldId( $name ),
'label' => __( 'Trim Bio Length to ', 'author-avatars' ),
'help' => ' characters.',
'size' => '4'
);
$name = $this->_getFieldName( $name );
return '' . AAFormHelper::input( 'text', $name, $value, $attributes ) . '
';
}
/**
* Renders the "min_post_count" input field
*
* @param string $value the field value
* @param string $name the field name
*
* @return string
*/
function renderFieldMinPostCount( $value = '', $name = 'min_post_count' ) {
$attributes = array(
'id' => $this->_getFieldId( $name ),
'label' => __( 'Required minimum number of posts', 'author-avatars' ) . ': ',
'size' => '5'
);
$name = $this->_getFieldName( $name );
return '' . AAFormHelper::input( 'text', $name, $value, $attributes ) . '
';
}
/**
* Renders the avatar size input field.
*
* @param string $value the field value
* @param string $name the field name
* @param bool $preview If set to true (default) the "avatar_size_preview" div is rendered. jQuery UI and "js/widget.admin.js" needs to included in order for this to work.
*/
function renderFieldAvatarSize( $value = '', $name = 'avatar_size', $preview = true ) {
$attributes = array(
'id' => $this->_getFieldId( $name ),
'label' => __( 'Avatar Size', 'author-avatars' ) . ': ',
'help' => 'px',
'class' => 'avatar_size_input',
'size' => '5'
);
$name = $this->_getFieldName( $name );
$html = '' . AAFormHelper::input( 'text', $name, $value, $attributes ) . '
';
if ( $preview == true ) {
global $user_email;
wp_get_current_user();
$html .= '' . get_avatar( $user_email, $value ) . '
';
}
return $html;
}
/**
* Renders the shortcode type selection field
*
* @param mixed $values the field values
* @param string $name the field name
*
* @return string
*/
function renderFieldShortcodeType( $values = array(), $name = 'shortcode_type' ) {
$type_options = array(
'show_avatar' => __( 'Single Avatar', 'author-avatars' ),
'authoravatars' => __( 'List of Users', 'author-avatars' ),
);
$attributes = array(
'id' => $this->_getFieldId( $name ),
'label' => '' . __( 'Shortcode Type', 'author-avatars' ) . ':
',
'expanded' => true,
'inline' => true,
);
$name = $this->_getFieldName( $name );
return '' . AAFormHelper::choice( $name, $type_options, $values, $attributes ) . '
';
}
/**
* Renders the email/userid input field for the show_avatar wizard
*
* @param string $value the field value
* @param string $name the field name
*
* @return string
*/
function renderFieldEmail( $value = '', $name = 'email' ) {
$attributes = array(
'id' => $this->_getFieldId( $name ),
'style' => 'width: 95%;',
);
$name = $this->_getFieldName( $name );
return AAFormHelper::input( 'text', $name, $value, $attributes ) . '';
}
/**
* Renders the User pick input field for the show_avatar wizard
*
* @param string $value the field value
* @param string $name the field name
*
* @return string
*/
function renderFieldUsers( $values = array(), $name = 'user_id' ) {
$attributes = array(
'id' => $this->_getFieldId( $name ),
'label' => '' . __( 'Email address or user id', 'author-avatars' ) . ':
',
'style' => 'width: 95%;',
);
$users = $this->_get_all_users( array( - 1 => __( 'Custom value', 'author-avatars' ) ) );
return '' . AAFormHelper::choice( $name, $users, $values, $attributes );
}
/**
* Retrieves all roles, and returns them as an associative array (key -> role name)
*
* @access private
* @return Array of role names.
*/
function _get_all_users( $users = array() ) {
global $wpdb;
$user_data = get_users();
foreach ( $user_data as $key => $user ) {
$users[ "" . $user->ID . "" ] = $user->user_nicename;
}
return $users;
}
/**
* Renders the alignment radio fields for the show_avatar wizard
*
* @param mixed $values the field values
* @param string $name the field name
*
* @return string
*/
function renderFieldAlignment( $values = '', $name = 'alignment' ) {
$alignment_options = array(
'' => __( 'None', 'author-avatars' ),
'left' => __( 'Left', 'author-avatars' ),
'center' => __( 'Center', 'author-avatars' ),
'right' => __( 'Right', 'author-avatars' ),
);
$attributes = array(
'id' => $this->_getFieldId( $name ),
'label' => '' . __( 'Alignment', 'author-avatars' ) . '
',
'expanded' => true,
'inline' => true,
'class' => 'alignment',
);
$name = $this->_getFieldName( $name );
return '
' . AAFormHelper::choice( $name, $alignment_options, $values, $attributes ) . '
';
}
/**
* Renders an opening tab div
*
* @param string $title The tab title
* @param string $id tab id (optional). Generated from $title if empty.
*
* @return string
*/
function renderTabStart( $title, $id = '' ) {
if ( empty( $id ) ) {
$id = 'tab-' . $title;
}
$id = AAFormHelper::cleanHtmlId( $id );
if ( isset( $this->tabs[ $id ] ) ) {
trigger_error( 'Warning: id "' . $id . '" has already been used as tab identifier.', E_USER_WARNING );
} else {
$this->tabs[ $id ] = $title;
}
return '';
}
/**
* Renders a closing tab div.
*
* @return string
*/
function renderTabEnd() {
return '
';
}
/**
* Renders the list of all tabs
*
* @return string
*/
function renderTabList() {
if ( empty( $this->tabs ) ) {
trigger_error( 'Tabs array is empty. Nothing to render.', E_USER_WARNING );
return;
}
$html = "\n" . '';
foreach ( $this->tabs as $id => $title ) {
$html .= "\n\t" . '- ' . $title . '
';
}
$html .= "\n" . '
';
return $html;
}
/**
* Renders the two given bits of html in columns next to each other.
*
* @param string $left Contents of the left column
* @param string $right Contents of the right column
* @param string html
*/
function renderColumns( $left = '', $right = '' ) {
if ( empty( $left ) || empty( $right ) ) {
return $left . $right;
}
$html = '';
$html .= '
' . $left . '
';
$html .= '
' . $right . '
';
$html .= '