AVATAR_MANAGER_AVATAR_UPLOADS,
'default_size' => AVATAR_MANAGER_DEFAULT_SIZE
);
return $options;
}
/**
* Returns plugin options.
*
* @uses get_option() For getting values for a named option.
* @uses avatar_manager_get_default_options() For retrieving plugin default
* options.
*
* @since Avatar Manager 1.0.0
*
* @return array Plugin options.
*/
function avatar_manager_get_options() {
return get_option( 'avatar_manager', avatar_manager_get_default_options() );
}
/**
* Sanitizes and validates plugin options.
*
* @uses avatar_manager_get_default_options() For retrieving plugin default
* options.
* @uses absint() For converting a value to a non-negative integer.
*
* @since Avatar Manager 1.0.0
*
* @param array $input An associative array with user input.
* @return array Sanitized plugin options.
*/
function avatar_manager_sanitize_options( $input ) {
$options = avatar_manager_get_default_options();
if ( isset( $input['avatar_uploads'] ) && trim( $input['avatar_uploads'] ) )
$options['avatar_uploads'] = trim( $input['avatar_uploads'] ) ? 1 : 0;
if ( isset( $input['default_size'] ) && is_numeric( trim( $input['default_size'] ) ) ) {
$options['default_size'] = absint( trim( $input['default_size'] ) );
if ( $options['default_size'] < 1 )
$options['default_size'] = 1;
elseif ( $options['default_size'] > 512 )
$options['default_size'] = 512;
}
return $options;
}
/**
* Prints Avatar Uploads settings field.
*
* @uses avatar_manager_get_options() For retrieving plugin options.
* @uses _e() For displaying the translated string from the translate().
* @uses checked() For comparing two given values.
*
* @since Avatar Manager 1.0.0
*/
function avatar_manager_avatar_uploads_settings_field() {
// Retrieves plugin options.
$options = avatar_manager_get_options();
?>
avatar_manager_avatar_type ) ? $profileuser->avatar_manager_avatar_type : 'gravatar';
if ( isset( $profileuser->avatar_manager_custom_avatar ) ) {
// Determines whether Multisite support is enabled.
if ( is_multisite() ) {
// Switches the current blog to a different blog.
switch_to_blog( $profileuser->avatar_manager_blog_id );
}
// Retrieves attachment meta fields based on attachment ID.
$custom_avatar_rating = get_post_meta( $profileuser->avatar_manager_custom_avatar, '_avatar_manager_custom_avatar_rating', true );
$user_has_custom_avatar = get_post_meta( $profileuser->avatar_manager_custom_avatar, '_avatar_manager_is_custom_avatar', true );
// Determines whether Multisite support is enabled.
if ( is_multisite() ) {
// Restores the current blog.
restore_current_blog();
}
}
if ( ! isset( $custom_avatar_rating ) || empty( $custom_avatar_rating ) )
$custom_avatar_rating = 'G';
if ( ! isset( $user_has_custom_avatar ) || empty( $user_has_custom_avatar ) )
$user_has_custom_avatar = false;
if ( $user_has_custom_avatar ) {
// Removes the function attached to the specified action hook.
remove_filter( 'get_avatar', 'avatar_manager_get_avatar' );
}
?>
resize( $size, $size, true );
// Saves current image to file.
$image->save( $dest_path );
$skip = false;
}
}
// Calls the functions added to avatar_manager_resize_avatar action hook.
do_action( 'avatar_manager_resize_avatar', $attachment_id, $size );
return $skip;
}
/**
* Sets user's avatar.
*
* @uses get_post_meta() For retrieving attachment meta fields.
* @uses avatar_manager_get_options() For retrieving plugin options.
* @uses avatar_manager_resize_avatar() For generating a resized copy of the
* specified avatar image.
* @uses update_post_meta() For updating attachment meta fields.
* @uses get_user_meta() For retrieving user meta fields.
* @uses avatar_manager_delete_avatar() For deleting an avatar image based on
* user ID.
* @uses update_user_meta() For updating user meta fields.
* @uses is_multisite() For determining whether Multisite support is enabled.
* @uses get_current_blog_id() For retrieving the current blog id.
*
* @since Avatar Manager 1.6.0
*
* @param int $user_id ID of the user.
* @param int $attachment_id ID of the attachment.
*/
function avatar_manager_set_avatar( $user_id, $attachment_id ) {
// Retrieves attachment meta field based on attachment ID.
$meta_avatar = get_post_meta( $attachment_id, '_avatar_manager_is_custom_avatar', true );
if ( empty( $meta_avatar ) ) {
// Retrieves plugin options.
$options = avatar_manager_get_options();
// Generates a resized copy of the avatar image.
$custom_avatar[ $options['default_size'] ] = avatar_manager_resize_avatar( $attachment_id, $options['default_size'] );
// Updates attachment meta fields based on attachment ID.
update_post_meta( $attachment_id, '_avatar_manager_custom_avatar', $custom_avatar );
update_post_meta( $attachment_id, '_avatar_manager_custom_avatar_rating', 'G' );
update_post_meta( $attachment_id, '_avatar_manager_is_custom_avatar', true );
}
// Retrieves user meta field based on user ID.
$custom_avatar = get_user_meta( $user_id, 'avatar_manager_custom_avatar', true );
if ( ! empty( $custom_avatar ) && $custom_avatar != $attachment_id ) {
// Deletes user's old avatar image.
avatar_manager_delete_avatar( $user_id );
}
// Updates user meta fields based on user ID.
update_user_meta( $user_id, 'avatar_manager_avatar_type', 'custom' );
update_user_meta( $user_id, 'avatar_manager_custom_avatar', $attachment_id );
// Determines whether Multisite support is enabled.
if ( is_multisite() ) {
// Retrieves the current blog id.
update_user_meta( $user_id, 'avatar_manager_blog_id', get_current_blog_id() );
}
}
/**
* Deletes an avatar image based on user ID.
*
* @uses get_user_meta() For retrieving user meta fields.
* @uses is_multisite() For determining whether Multisite support is enabled.
* @uses switch_to_blog() For switching the current blog to a different blog.
* @uses get_post_meta() For retrieving attachment meta fields.
* @uses avatar_manager_generate_avatar_path() For generating a file path of an
* avatar image based on attachment ID and size.
* @uses delete_post_meta() For deleting attachment meta fields.
* @uses restore_current_blog() For restoring the current blog.
* @uses delete_user_meta() For deleting user meta fields.
* @uses do_action() For calling the functions added to an action hook.
*
* @since Avatar Manager 1.0.0
*
* @param int $user_id ID of the user.
* @return bool Operation status.
*/
function avatar_manager_delete_avatar( $user_id ) {
// Retrieves user meta field based on user ID.
$attachment_id = get_user_meta( $user_id, 'avatar_manager_custom_avatar', true );
if ( empty( $attachment_id ) )
return false;
// Determines whether Multisite support is enabled.
if ( is_multisite() ) {
// Switches the current blog to a different blog.
switch_to_blog( get_user_meta( $user_id, 'avatar_manager_blog_id', true ) );
}
// Retrieves attachment meta field based on attachment ID.
$custom_avatar = get_post_meta( $attachment_id, '_avatar_manager_custom_avatar', true );
if ( is_array( $custom_avatar ) ) {
foreach ( $custom_avatar as $size => $skip ) {
if ( ! $skip ) {
// Generates a file path of an avatar image based on attachment
// ID and size.
$file = avatar_manager_generate_avatar_path( $attachment_id, $size );
@unlink( $file );
}
}
}
// Deletes attachment meta fields based on attachment ID.
delete_post_meta( $attachment_id, '_avatar_manager_custom_avatar' );
delete_post_meta( $attachment_id, '_avatar_manager_custom_avatar_rating' );
delete_post_meta( $attachment_id, '_avatar_manager_is_custom_avatar' );
// Determines whether Multisite support is enabled.
if ( is_multisite() ) {
// Restores the current blog.
restore_current_blog();
}
// Deletes user meta fields based on user ID.
delete_user_meta( $user_id, 'avatar_manager_avatar_type' );
delete_user_meta( $user_id, 'avatar_manager_custom_avatar' );
// Determines whether Multisite support is enabled.
if ( is_multisite() )
delete_user_meta( $user_id, 'avatar_manager_blog_id' );
// Calls the functions added to avatar_manager_delete_avatar action hook.
do_action( 'avatar_manager_delete_avatar', $user_id );
return true;
}
add_action( 'delete_user', 'avatar_manager_delete_avatar' );
add_action( 'wpmu_delete_user', 'avatar_manager_delete_avatar' );
/**
* Deletes an avatar image based on attachment ID.
*
* @uses get_post_meta() For retrieving attachment meta fields.
* @uses get_users() For retrieving an array of users matching the criteria
* given in $args.
* @uses avatar_manager_delete_avatar() For deleting an avatar image based on
* user ID.
*
* @since Avatar Manager 1.5.0
*
* @param int $attachment_id ID of the attachment.
*/
function avatar_manager_delete_attachment( $attachment_id ) {
// Retrieves attachment meta field based on attachment ID.
$meta_avatar = get_post_meta( $attachment_id, '_avatar_manager_is_custom_avatar', true );
if ( empty( $meta_avatar ) )
return;
// An associative array with criteria to match.
$args = array(
'meta_key' => 'avatar_manager_custom_avatar',
'meta_value' => $attachment_id
);
// Retrieves an array of users matching the criteria given in $args.
$users = get_users( $args );
foreach ( $users as $user ) {
// Deletes an avatar image based on user ID.
avatar_manager_delete_avatar( $user->ID );
}
}
add_action( 'delete_attachment', 'avatar_manager_delete_attachment' );
/**
* Updates user profile based on user ID.
*
* @uses sanitize_text_field() For sanitizing a string from user input or from
* the database.
* @uses update_user_meta() For updating user meta fields.
* @uses get_user_meta() For retrieving user meta fields.
* @uses update_post_meta() For updating attachment meta fields.
* @uses wp_handle_upload() For handling PHP uploads in WordPress.
* @uses wp_die() For killing WordPress execution and displaying HTML error
* message.
* @uses __() For retrieving the translated string from the translate().
* @uses wp_insert_attachment() For inserting an attachment into the media
* library.
* @uses wp_generate_attachment_metadata() For generating metadata for an
* attachment.
* @uses wp_update_attachment_metadata() For updating metadata for an
* attachment.
* @uses avatar_manager_set_avatar() For setting user's avatar.
* @uses avatar_manager_delete_avatar() For deleting an avatar image based on
* user ID.
* @uses get_edit_user_link() For getting the link to the user's edit profile
* page in the WordPress admin.
* @uses add_query_arg() For retrieving a modified URL (with) query string.
* @uses wp_redirect() For redirecting the user to a specified absolute URI.
*
* @since Avatar Manager 1.0.0
*
* @param int $user_id ID of the user to update.
*/
function avatar_manager_edit_user_profile_update( $user_id ) {
// Sanitizes the string from user input.
$avatar_type = isset( $_POST['avatar_manager_avatar_type'] ) ? sanitize_text_field( $_POST['avatar_manager_avatar_type'] ) : 'gravatar';
// Updates user meta field based on user ID.
update_user_meta( $user_id, 'avatar_manager_avatar_type', $avatar_type );
// Retrieves user meta field based on user ID.
$attachment_id = get_user_meta( $user_id, 'avatar_manager_custom_avatar', true );
if ( ! empty( $attachment_id ) ) {
// Sanitizes the string from user input.
$custom_avatar_rating = isset( $_POST['avatar_manager_custom_avatar_rating'] ) ? sanitize_text_field( $_POST['avatar_manager_custom_avatar_rating'] ) : 'G';
// Updates attachment meta field based on attachment ID.
update_post_meta( $attachment_id, '_avatar_manager_custom_avatar_rating', $custom_avatar_rating );
}
if ( isset( $_POST['avatar_manager_submit'] ) && $_POST['avatar_manager_submit'] ) {
if ( ! function_exists( 'wp_handle_upload' ) )
require_once( ABSPATH . 'wp-admin/includes/file.php' );
if ( ! function_exists( 'wp_generate_attachment_metadata' ) )
require_once( ABSPATH . 'wp-admin/includes/image.php' );
// An associative array with allowed MIME types.
$mimes = array(
'bmp' => 'image/bmp',
'gif' => 'image/gif',
'jpe' => 'image/jpeg',
'jpeg' => 'image/jpeg',
'jpg' => 'image/jpeg',
'png' => 'image/png',
'tif' => 'image/tiff',
'tiff' => 'image/tiff'
);
// An associative array to override default variables.
$overrides = array(
'mimes' => $mimes,
'test_form' => false
);
// Handles PHP uploads in WordPress.
$file_attr = wp_handle_upload( $_FILES['avatar_manager_import'], $overrides );
if ( isset( $file_attr['error'] ) ) {
// Kills WordPress execution and displays HTML error message.
wp_die( $file_attr['error'], __( 'Image Upload Error', 'avatar-manager' ) );
}
// An associative array about the attachment.
$attachment = array(
'guid' => $file_attr['url'],
'post_content' => $file_attr['url'],
'post_mime_type' => $file_attr['type'],
'post_title' => basename( $file_attr['file'] )
);
// Inserts the attachment into the media library.
$attachment_id = wp_insert_attachment( $attachment, $file_attr['file'] );
// Generates metadata for the attachment.
$attachment_metadata = wp_generate_attachment_metadata( $attachment_id, $file_attr['file'] );
// Updates metadata for the attachment.
wp_update_attachment_metadata( $attachment_id, $attachment_metadata );
// Sets user's avatar.
avatar_manager_set_avatar( $user_id, $attachment_id );
}
if ( isset( $_GET['avatar_manager_action'] ) && $_GET['avatar_manager_action'] ) {
global $wp_http_referer;
$action = $_GET['avatar_manager_action'];
switch ( $action ) {
case 'set-avatar':
if ( isset( $_GET['avatar_manager_attachment_id'] ) ) {
// Sets user's avatar.
avatar_manager_set_avatar( $user_id, absint( $_GET['avatar_manager_attachment_id'] ) );
}
break;
case 'remove-avatar':
// Deletes an avatar image based on user ID.
avatar_manager_delete_avatar( $user_id );
break;
}
// Gets the link to the user's edit profile page in the WordPress admin.
$edit_user_link = get_edit_user_link( $user_id );
// Retrieves a modified URL (with) query string.
$redirect = add_query_arg( 'updated', true, $edit_user_link );
if ( $wp_http_referer ) {
// Retrieves a modified URL (with) query string.
$redirect = add_query_arg( 'wp_http_referer', urlencode( $wp_http_referer ), $redirect );
}
// Redirects the user to a specified absolute URI.
wp_redirect( $redirect );
exit;
}
}
add_action( 'edit_user_profile_update', 'avatar_manager_edit_user_profile_update' );
add_action( 'personal_options_update', 'avatar_manager_edit_user_profile_update' );
/**
* Returns user custom avatar based on user ID.
*
* @uses get_option() For getting values for a named option.
* @uses avatar_manager_get_options() For retrieving plugin options.
* @uses get_userdata() For retrieving user data by user ID.
* @uses is_ssl() For checking if SSL is being used.
* @uses add_query_arg() For retrieving a modified URL (with) query string.
* @uses esc_attr() For escaping HTML attributes.
* @uses get_user_meta() For retrieving user meta fields.
* @uses is_multisite() For determining whether Multisite support is enabled.
* @uses switch_to_blog() For switching the current blog to a different blog.
* @uses get_post_meta() For retrieving attachment meta fields.
* @uses avatar_manager_resize_avatar() For generating a resized copy of the
* specified avatar image.
* @uses update_post_meta() For updating attachment meta fields.
* @uses avatar_manager_generate_avatar_url() For generating a full URI of an
* avatar image based on attachment ID and size.
* @uses restore_current_blog() For restoring the current blog.
* @uses apply_filters() For calling the functions added to a filter hook.
*
* @since Avatar Manager 1.0.0
*
* @param int $user_id ID of the user.
* @param int $size Size of the avatar image.
* @param string $default URL to a default image to use if no avatar is
* available.
* @param string $alt Alternative text to use in image tag. Defaults to blank.
* @return string tag for the user's avatar.
*/
function avatar_manager_get_custom_avatar( $user_id, $size = '', $default = '', $alt = false ) {
// Returns if showing avatars is not enabled.
if ( ! get_option( 'show_avatars' ) )
return false;
// Retrieves plugin options.
$options = avatar_manager_get_options();
if ( empty( $size ) || ! is_numeric( $size ) ) {
$size = $options['default_size'];
} else {
$size = absint( $size );
if ( $size < 1 )
$size = 1;
elseif ( $size > 512 )
$size = 512;
}
// Retrieves user data by user ID.
$user = get_userdata( $user_id );
// Returns if no user data was retrieved.
if ( empty( $user ) )
return false;
$email = $user->user_email;
if ( empty( $default ) ) {
// Retrieves values for the named option.
$avatar_default = get_option( 'avatar_default' );
if ( empty( $avatar_default ) )
$default = 'mystery';
else
$default = $avatar_default;
}
$email_hash = md5( strtolower( trim( $email ) ) );
if ( is_ssl() )
$host = 'https://secure.gravatar.com';
else
$host = sprintf( 'http://%d.gravatar.com', ( hexdec( $email_hash[0] ) % 2 ) );
if ( $default == 'mystery' ) {
$default = $host . '/avatar/ad516503a11cd5ca435acc9bb6523536?s=' . $size;
} elseif ( $default == 'gravatar_default' ) {
$default = '';
} elseif ( strpos( $default, 'http://' ) === 0 ) {
// Retrieves a modified URL (with) query string.
$default = add_query_arg( 's', $size, $default );
}
if ( $alt === false ) {
$alt = '';
} else {
// Escapes HTML attributes.
$alt = esc_attr( $alt );
}
// Retrieves values for the named option.
$avatar_rating = get_option( 'avatar_rating' );
// Retrieves user meta field based on user ID.
$attachment_id = get_user_meta( $user_id, 'avatar_manager_custom_avatar', true );
// Returns if no attachment ID was retrieved.
if ( empty( $attachment_id ) )
return false;
// Determine whether Multisite support is enabled.
if ( is_multisite() ) {
// Switches the current blog to a different blog.
switch_to_blog( get_user_meta( $user_id, 'avatar_manager_blog_id', true ) );
}
// Retrieves attachment meta field based on attachment ID.
$custom_avatar_rating = get_post_meta( $attachment_id, '_avatar_manager_custom_avatar_rating', true );
$ratings['G'] = 1;
$ratings['PG'] = 2;
$ratings['R'] = 3;
$ratings['X'] = 4;
if ( $ratings[ $custom_avatar_rating ] <= $ratings[ $avatar_rating ] ) {
// Retrieves attachment meta field based on attachment ID.
$custom_avatar = get_post_meta( $attachment_id, '_avatar_manager_custom_avatar', true );
if ( ! isset( $custom_avatar[ $size ] ) ) {
// Generates a resized copy of the avatar image.
$custom_avatar[ $size ] = avatar_manager_resize_avatar( $attachment_id, $size );
// Updates attachment meta field based on attachment ID.
update_post_meta( $attachment_id, '_avatar_manager_custom_avatar', $custom_avatar );
}
// Generates a full URI of an avatar image based on attachment ID and
// size.
$src = avatar_manager_generate_avatar_url( $attachment_id, $size );
$custom_avatar = '';
} else {
$src = $host . '/avatar/';
$src .= $email_hash;
$src .= '?s=' . $size;
$src .= '&d=' . urlencode( $default );
$src .= '&forcedefault=1';
$custom_avatar = '';
}
// Determines whether Multisite support is enabled.
if ( is_multisite() ) {
// Restores the current blog.
restore_current_blog();
}
// Calls the functions added to avatar_manager_get_custom_avatar filter
// hook.
return apply_filters( 'avatar_manager_get_custom_avatar', $custom_avatar, $user_id, $size, $default, $alt );
}
/**
* Returns the avatar for a user who provided a user ID or email address.
*
* @uses get_option() For getting values for a named option.
* @uses avatar_manager_get_options() For retrieving plugin options.
* @uses get_userdata() For retrieving user data by user ID.
* @uses avatar_manager_get_custom_avatar() For retrieving user custom avatar
* based on user ID.
* @uses apply_filters() For calling the functions added to a filter hook.
*
* @since Avatar Manager 1.0.0
*
* @param int|string|object $id_or_email A user ID, email address, or comment
* object.
* @param int $size Size of the avatar image.
* @param string $default URL to a default image to use if no avatar is
* available.
* @param string $alt Alternative text to use in image tag. Defaults to blank.
* @return string tag for the user's avatar.
*/
function avatar_manager_get_avatar( $avatar = '', $id_or_email, $size = '', $default = '', $alt = false ) {
// Returns if showing avatars is not enabled.
if ( ! get_option( 'show_avatars' ) )
return false;
// Retrieves plugin options.
$options = avatar_manager_get_options();
if ( empty( $size ) || ! is_numeric( $size ) ) {
$size = $options['default_size'];
} else {
$size = absint( $size );
if ( $size < 1 )
$size = 1;
elseif ( $size > 512 )
$size = 512;
}
$email = '';
if ( is_numeric( $id_or_email ) ) {
$id = (int) $id_or_email;
// Retrieves user data by user ID.
$user = get_userdata( $id );
if ( $user )
$email = $user->user_email;
} elseif ( is_object( $id_or_email ) ) {
if ( ! empty( $id_or_email->user_id ) ) {
$id = (int) $id_or_email->user_id;
// Retrieves user data by user ID.
$user = get_userdata( $id );
if ( $user )
$email = $user->user_email;
} elseif ( ! empty( $id_or_email->comment_author_email ) ) {
$email = $id_or_email->comment_author_email;
}
} else {
$email = $id_or_email;
if ( $id = email_exists( $email ) ) {
// Retrieves user data by user ID.
$user = get_userdata( $id );
}
}
if ( isset( $user ) )
$avatar_type = $user->avatar_manager_avatar_type;
else
return $avatar;
if ( $avatar_type == 'custom' ) {
// Retrieves user custom avatar based on user ID.
$avatar = avatar_manager_get_custom_avatar( $user->ID, $size, $default, $alt );
}
// Calls the functions added to avatar_manager_get_avatar filter hook.
return apply_filters( 'avatar_manager_get_avatar', $avatar, $id_or_email, $size, $default, $alt );
}
add_filter( 'get_avatar', 'avatar_manager_get_avatar', 10, 5 );
/**
* Prevents custom avatars from being applied to the Default Avatar setting.
*
* @uses remove_filter() For removing a function attached to a specified action
* hook.
*
* @since Avatar Manager 1.0.0
*
* @param array $avatar_defaults An associative array with default avatars.
* @return array An associative array with default avatars.
*/
function avatar_manager_avatar_defaults( $avatar_defaults ) {
// Removes the avatar_manager_get_avatar function attached to get_avatar
// action hook.
remove_filter( 'get_avatar', 'avatar_manager_get_avatar' );
return $avatar_defaults;
}
add_filter( 'avatar_defaults', 'avatar_manager_avatar_defaults', 10, 1 );
/**
* Displays media states for avatar images.
*
* @uses get_post_meta() For retrieving attachment meta fields.
* @uses __() For retrieving the translated string from the translate().
* @uses apply_filters() For calling the functions added to a filter hook.
*
* @since Avatar Manager 1.2.0
*
* @param array $media_states An associative array with media states.
* @return array An associative array with media states.
*/
function avatar_manager_display_media_states( $media_states ) {
global $post;
// Retrieves attachment meta field based on attachment ID.
$meta_avatar = get_post_meta( $post->ID, '_avatar_manager_is_custom_avatar', true );
if ( ! empty( $meta_avatar ) )
$media_states[] = __( 'Avatar Image', 'avatar-manager' );
// Calls the functions added to avatar_manager_display_media_states filter
// hook.
return apply_filters( 'avatar_manager_display_media_states', $media_states );
}
add_filter( 'display_media_states', 'avatar_manager_display_media_states', 10, 1 );
/**
* Deletes user's custom avatar image.
*
* @uses get_user_meta() For retrieving user meta fields.
* @uses do_action() For calling the functions added to an action hook.
* @uses avatar_manager_delete_avatar() For deleting an avatar image based on
* user ID.
*
* @since Avatar Manager 1.3.0
*
* @param array $args An associative array with username and passowrd.
* @return bool Operation status.
*/
function avatar_manager_deleteCustomAvatar( $args ) {
global $wp_xmlrpc_server;
if ( count( $args ) < 2 )
return new IXR_Error( 400, __( 'Insufficient arguments passed to this XML-RPC method.', 'avatar-manager' ) );
// Sanitizes the string or array of strings from user input.
$wp_xmlrpc_server->escape( $args );
$username = $args[0];
$password = $args[1];
if ( ! $user = $wp_xmlrpc_server->login( $username, $password ) )
return $wp_xmlrpc_server->error;
// Retrieves user meta field based on user ID.
$attachment_id = get_user_meta( $user->ID, 'avatar_manager_custom_avatar', true );
// Returns if no attachment ID was retrieved.
if ( empty( $attachment_id ) )
return new IXR_Error( 404, __( 'Sorry, you don\'t have a custom avatar.', 'avatar-manager' ) );
// Calls the functions added to xmlrpc_call action hook.
do_action( 'xmlrpc_call', 'avatarManager.deleteCustomAvatar' );
// Deletes an avatar image based on user ID.
return avatar_manager_delete_avatar( $user->ID );
}
/**
* Returns user's avatar type.
*
* @uses do_action() For calling the functions added to an action hook.
* @uses get_user_meta() For retrieving user meta fields.
*
* @since Avatar Manager 1.3.0
*
* @param array $args An associative array with username and passowrd.
* @return string Avatar type.
*/
function avatar_manager_getAvatarType( $args ) {
global $wp_xmlrpc_server;
if ( count( $args ) < 2 )
return new IXR_Error( 400, __( 'Insufficient arguments passed to this XML-RPC method.', 'avatar-manager' ) );
// Sanitizes the string or array of strings from user input.
$wp_xmlrpc_server->escape( $args );
$username = $args[0];
$password = $args[1];
if ( ! $user = $wp_xmlrpc_server->login( $username, $password ) )
return $wp_xmlrpc_server->error;
// Calls the functions added to xmlrpc_call action hook.
do_action( 'xmlrpc_call', 'avatarManager.getAvatarType' );
// Retrieves user meta field based on user ID.
$avatar_type = get_user_meta( $user->ID, 'avatar_manager_avatar_type', true );
// Defaults to Gravatar if avatar type is empty.
$avatar_type = empty( $avatar_type ) ? 'gravatar' : $avatar_type;
return $avatar_type;
}
/**
* Returns user's custom avatar attachment ID, image and rating.
*
* @uses get_user_meta() For retrieving user meta fields.
* @uses do_action() For calling the functions added to an action hook.
* @uses avatar_manager_get_custom_avatar() For retrieving user custom avatar
* based on user ID.
* @uses get_post_meta() For retrieving attachment meta fields.
*
* @since Avatar Manager 1.3.0
*
* @param array $args An associative array with username, passowrd, avatar image
* size (optional), default avatar image (optional) and alternate text
* (optional).
* @return array An associative array with custom avatar image and rating.
*/
function avatar_manager_getCustomAvatar( $args ) {
global $wp_xmlrpc_server;
if ( count( $args ) < 2 )
return new IXR_Error( 400, __( 'Insufficient arguments passed to this XML-RPC method.', 'avatar-manager' ) );
// Sanitizes the string or array of strings from user input.
$wp_xmlrpc_server->escape( $args );
$username = $args[0];
$password = $args[1];
$size = isset( $args[2] ) ? $args[2] : '';
$default = isset( $args[3] ) ? $args[3] : '';
$alt = isset( $args[4] ) ? $args[4] : false;
if ( ! $user = $wp_xmlrpc_server->login( $username, $password ) )
return $wp_xmlrpc_server->error;
// Retrieves user meta field based on user ID.
$attachment_id = get_user_meta( $user->ID, 'avatar_manager_custom_avatar', true );
// Returns if no attachment ID was retrieved.
if ( empty( $attachment_id ) )
return new IXR_Error( 404, __( 'Sorry, you don\'t have a custom avatar.', 'avatar-manager' ) );
// Calls the functions added to xmlrpc_call action hook.
do_action( 'xmlrpc_call', 'avatarManager.getCustomAvatar' );
$custom_avatar = array(
'id' => $attachment_id,
'image' => avatar_manager_get_custom_avatar( $user->ID, $size, $default, $alt ),
'rating' => get_post_meta( $attachment_id, '_avatar_manager_custom_avatar_rating', true )
);
return $custom_avatar;
}
/**
* Sets user's avatar type.
*
* @uses get_user_meta() For retrieving user meta fields.
* @uses do_action() For calling the functions added to an action hook.
* @uses update_user_meta() For updating user meta fields.
*
* @since Avatar Manager 1.3.0
*
* @param array $args An associative array with username, passowrd and avatar
* type.
* @return bool Operation status.
*/
function avatar_manager_setAvatarType( $args ) {
global $wp_xmlrpc_server;
if ( count( $args ) < 3 )
return new IXR_Error( 400, __( 'Insufficient arguments passed to this XML-RPC method.', 'avatar-manager' ) );
// Sanitizes the string or array of strings from user input.
$wp_xmlrpc_server->escape( $args );
$username = $args[0];
$password = $args[1];
$avatar_type = $args[2];
if ( ! $user = $wp_xmlrpc_server->login( $username, $password ) )
return $wp_xmlrpc_server->error;
if ( ! in_array( $avatar_type, array( 'gravatar', 'custom' ) ) )
return new IXR_Error( 401, __( 'Invalid avatar type.', 'avatar-manager' ) );
// Retrieves user meta field based on user ID.
$attachment_id = get_user_meta( $user->ID, 'avatar_manager_custom_avatar', true );
// Returns if no attachment ID was retrieved and requested avatar type is
// set to custom.
if ( empty( $attachment_id ) && $avatar_type == 'custom' )
return new IXR_Error( 404, __( 'Sorry, you don\'t have a custom avatar.', 'avatar-manager' ) );
// Calls the functions added to xmlrpc_call action hook.
do_action( 'xmlrpc_call', 'avatarManager.setAvatarType' );
// Updates user meta field based on user ID.
update_user_meta( $user->id, 'avatar_manager_avatar_type', $avatar_type );
return true;
}
/**
* Sets user's custom avatar rating.
*
* @uses get_user_meta() For retrieving user meta fields.
* @uses do_action() For calling the functions added to an action hook.
* @uses update_post_meta() For updating attachment meta fields.
*
* @since Avatar Manager 1.3.0
*
* @param array $args An associative array with username, passowrd and custom
* avatar rating.
* @return bool Operation status.
*/
function avatar_manager_setCustomAvatarRating( $args ) {
global $wp_xmlrpc_server;
if ( count( $args ) < 3 )
return new IXR_Error( 400, __( 'Insufficient arguments passed to this XML-RPC method.', 'avatar-manager' ) );
// Sanitizes the string or array of strings from user input.
$wp_xmlrpc_server->escape( $args );
$username = $args[0];
$password = $args[1];
$custom_avatar_rating = $args[2];
if ( ! $user = $wp_xmlrpc_server->login( $username, $password ) )
return $wp_xmlrpc_server->error;
if ( ! in_array( $custom_avatar_rating, array( 'G', 'PG', 'R', 'X' ) ) )
return new IXR_Error( 401, __( 'Invalid custom avatar rating.', 'avatar-manager' ) );
// Retrieves user meta field based on user ID.
$attachment_id = get_user_meta( $user->ID, 'avatar_manager_custom_avatar', true );
// Returns if no attachment ID was retrieved.
if ( empty( $attachment_id ) )
return new IXR_Error( 404, __( 'Sorry, you don\'t have a custom avatar.', 'avatar-manager' ) );
// Calls the functions added to xmlrpc_call action hook.
do_action( 'xmlrpc_call', 'avatarManager.setCustomAvatarRating' );
// Updates attachment meta field based on attachment ID.
update_post_meta( $attachment_id, '_avatar_manager_custom_avatar_rating', $custom_avatar_rating );
return true;
}
/**
* Uploads an avatar image and sets it as user's custom avatar image.
*
* @uses avatar_manager_get_options() For retrieving plugin options.
* @uses apply_filters() For calling the functions added to a filter hook.
* @uses sanitize_file_name() For sanitizing a filename replacing whitespace
* with dashes.
* @uses wp_upload_bits() For creating a file in the upload folder with given
* content.
* @uses do_action() For calling the functions added to an action hook.
* @uses wp_insert_attachment() For inserting an attachment into the media
* library.
* @uses wp_generate_attachment_metadata() For generating metadata for an
* attachment.
* @uses wp_update_attachment_metadata() For updating metadata for an
* attachment.
* @uses avatar_manager_set_avatar() For setting user's avatar.
*
* @since Avatar Manager 1.3.0
*
* @param array $args An associative array with username and passowrd.
* @return array On success, returns an associative array of file attributes. On
* failure, returns $overrides['upload_error_handler']( &$file, $message ) or
* array( 'error' => $message ).
*/
function avatar_manager_uploadCustomAvatar( $args ) {
global $wpdb, $wp_xmlrpc_server;
if ( count( $args ) < 3 )
return new IXR_Error( 400, __( 'Insufficient arguments passed to this XML-RPC method.', 'avatar-manager' ) );
$username = $wpdb->escape($args[0]);
$password = $wpdb->escape($args[1]);
$file = $args[2];
if ( ! $user = $wp_xmlrpc_server->login( $username, $password ) )
return $wp_xmlrpc_server->error;
// Retrieves plugin options.
$options = avatar_manager_get_options();
if ( ! current_user_can( 'upload_files' ) && ! $options['avatar_uploads'] )
return new IXR_Error( 401, __( 'Sorry, you don\'t have permission to upload files.', 'avatar-manager' ) );
if ( $upload_error = apply_filters( 'pre_upload_error', false ) )
return new IXR_Error( 500, $upload_error );
// Sanitizes a filename replacing whitespace with dashes.
$filename = sanitize_file_name( $file['name'] );
// An associative array with allowed MIME types.
$mimes = array(
'bmp' => 'image/bmp',
'gif' => 'image/gif',
'jpe' => 'image/jpeg',
'jpeg' => 'image/jpeg',
'jpg' => 'image/jpeg',
'png' => 'image/png',
'tif' => 'image/tiff',
'tiff' => 'image/tiff'
);
if ( ! in_array( $file['type'], $mimes ) )
return new IXR_Error( 401, __( 'Sorry, this file type is not permitted for security reasons.', 'avatar-manager' ) );
// Creates a file in the upload folder with given content.
$file_attr = wp_upload_bits( $filename, null, $file['bits'] );
if ( ! empty( $file_attr['error'] ) )
return new IXR_Error( 500, $file_attr['error'] );
// Calls the functions added to xmlrpc_call action hook.
do_action( 'xmlrpc_call', 'avatarManager.uploadCustomAvatar' );
// An associative array about the attachment.
$attachment = array(
'guid' => $file_attr['url'],
'post_content' => $file_attr['url'],
'post_mime_type' => $file['type'],
'post_title' => $filename
);
// Inserts the attachment into the media library.
$attachment_id = wp_insert_attachment( $attachment, $file_attr['file'] );
// Generates metadata for the attachment.
$attachment_metadata = wp_generate_attachment_metadata( $attachment_id, $file_attr['file'] );
// Updates metadata for the attachment.
wp_update_attachment_metadata( $attachment_id, $attachment_metadata );
// Sets user's avatar.
avatar_manager_set_avatar( $user->ID, $attachment_id );
$struct = array(
'id' => strval( $attachment_id ),
'file' => $filename,
'url' => $file_attr['url'],
'type' => $file['type']
);
// Calls the functions added to wp_handle_upload filter hook.
return apply_filters( 'wp_handle_upload', $struct, 'upload' );
}
/**
* Extends the WordPress XML-RPC API.
*
* @since Avatar Manager 1.3.0
*
* @param array $methods An associative array with WordPress XML-RPC API
* methods.
* @return array An associative array with WordPress XML-RPC API methods.
*/
function avatar_manager_xmlrpc_methods( $methods ) {
$methods['avatarManager.deleteCustomAvatar'] = 'avatar_manager_deleteCustomAvatar';
$methods['avatarManager.getAvatarType'] = 'avatar_manager_getAvatarType';
$methods['avatarManager.getCustomAvatar'] = 'avatar_manager_getCustomAvatar';
$methods['avatarManager.setAvatarType'] = 'avatar_manager_setAvatarType';
$methods['avatarManager.setCustomAvatarRating'] = 'avatar_manager_setCustomAvatarRating';
$methods['avatarManager.uploadCustomAvatar'] = 'avatar_manager_uploadCustomAvatar';
return $methods;
}
add_filter( 'xmlrpc_methods', 'avatar_manager_xmlrpc_methods' );
?>