Cara Membuat Plugin Manajemen Avatar WordPress: Sentuhan Akhir

() translation by (you can also view the original English article)

Avatar Manager untuk WordPress adalah plugin yang manis dan sederhana untuk menyimpan avatar secara lokal dan banyak lagi. Dengan mudah.

Tingkatkan situs WordPress Anda dengan memungkinkan pengguna memilih antara menggunakan Gravatar atau gambar avatar yang dihosting sendiri langsung dari layar profil mereka. Alur kerja yang ditingkatkan, pembuatan gambar on-demand dan izin pengguna khusus di bawah antarmuka asli. Ucapkan salam ke plugin Avatar Manager.

Rekap Cepat

Pada bagian pertama dari tutorial, kita meninjau:

Apa itu WordPress plugin;
cara membuat plugin WordPress dasar, pilih lisensi dan format yang sesuai untuk nomor versi;
apa itu action dan filter hooks dan bagaimana menggunakannya untuk membuat plugin;
cara menambahkan pengaturan baru ke layar pengaturan yang ada;
cara membuat plugin lebih fleksibel dengan menggunakan opsi khusus.

Hari ini, kita akan mengambil langkah lebih jauh dan menyelesaikan plugin: kita akan menangani unggahan avatar dan pembuatan gambar sesuai permintaan, menginternasionalisasikan plugin, dan banyak lagi.

Langkah 1. Mengubah Ukuran Gambar Avatar

Mari kita mulai dengan menulis fungsi berikut:

/**
 * Generates a resized copy of the specified avatar image.
 *
 * @uses wp_upload_dir() For retrieving path information on the currently
 * configured uploads directory.
 * @uses wp_basename() For i18n friendly version of basename().
 * @uses wp_get_image_editor() For retrieving a WP_Image_Editor instance and
 * loading a file into it.
 * @uses is_wp_error() For checking whether the passed variable is a WordPress
 * Error.
 * @uses do_action() For calling the functions added to an action hook.
 *
 * @since Avatar Manager 1.0.0
 *
 * @param string $url URL of the avatar image to resize.
 * @param int $size Size of the new avatar image.
 * @return array Array with the URL of the new avatar image.
 */
function avatar_manager_avatar_resize( $url, $size ) {
  // Retrieves path information on the currently configured uploads directory.
	$upload_dir = wp_upload_dir();

	$filename  = str_replace( $upload_dir['baseurl'], $upload_dir['basedir'], $url );
	$pathinfo  = pathinfo( $filename );
	$dirname   = $pathinfo['dirname'];
	$extension = $pathinfo['extension'];

	// i18n friendly version of basename().
	$basename = wp_basename( $filename, '.' . $extension );

	$suffix    = $size . 'x' . $size;
	$dest_path = $dirname . '/' . $basename . '-' . $suffix . '.' . $extension;
	$avatar    = array();

	if ( file_exists( $dest_path ) ) {
		$avatar['url']  = str_replace( $upload_dir['basedir'], $upload_dir['baseurl'], $dest_path );
		$avatar['skip'] = true;
	} else {
		// Retrieves a WP_Image_Editor instance and loads a file into it.
		$image = wp_get_image_editor( $filename );

		if ( ! is_wp_error( $image ) ) {
			// Resizes current image.
			$image->resize( $size, $size, true );

			// Saves current image to file.
			$image->save( $dest_path );

			$avatar['url']  = str_replace( $upload_dir['basedir'], $upload_dir['baseurl'], $dest_path );
			$avatar['skip'] = false;
		}
	}

	// Calls the functions added to avatar_manager_avatar_resize action hook.
	do_action( 'avatar_manager_avatar_resize', $url, $size );

	return $avatar;
}

Ringkasan

Fungsi avatar_manager_avatar_resize() menghasilkan salinan ukuran gambar avatar yang ditentukan.
Panggilan wp_upload_dir() mengembalikan larik yang berisi informasi jalur pada direktori unggahan yang saat ini dikonfigurasikan.
Fungsi str_replace() menggantikan semua kemunculan string pencarian dengan string pengganti.
Fungsi pathinfo() mengembalikan informasi tentang path file.
Fungsi wp_basename() adalah versi ramah iunn dari basename() yang mengembalikan trailing name component dari sebuah path.
Fungsi file_exists() memeriksa apakah file atau direktori ada.
Bendera skip diatur ke true jika file gambar tujuan sudah ada, jika ada gambar baru yang dihasilkan.
Fungsi wp_get_image_editor() mengembalikan instance WP_Image_Editor dan memuat file ke dalamnya. Dengan itu kita dapat memanipulasi gambar dengan memanggil metode di atasnya.
Fungsi is_wp_error() memeriksa apakah variabel yang diteruskan adalah kesalahan WordPress.
Kemudian, kita mengubah ukuran dan menyimpan gambar dengan memanggil metode resize() dan save() dari objek $image.
Do_action() mengeksekusi hook yang dibuat oleh add_action(); ini memungkinkan tema dan plugin untuk menghubungkan ke tindakan avatar_manager_avatar_resize yang dipicu setelah mengubah ukuran gambar avatar.

Langkah 2. Menghapus Gambar Avatar

Sebelum mengurus pembaruan profil, kita perlu mendefinisikan satu fungsi lagi:

/**
 * Deletes an avatar image based on attachment ID.
 *
 * @uses get_post_meta() For retrieving attachment meta fields.
 * @uses wp_upload_dir() For retrieving path information on the currently
 * configured uploads directory.
 * @uses delete_post_meta() For deleting attachment meta fields.
 * @uses get_users() For retrieving an array of users.
 * @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 $attachment_id An attachment ID
 */
function avatar_manager_delete_avatar( $attachment_id ) {
	// Retrieves attachment meta field based on attachment ID.
	$is_custom_avatar = get_post_meta( $attachment_id, '_avatar_manager_is_custom_avatar', true );

	if ( ! $is_custom_avatar )
		return;

	// Retrieves path information on the currently configured uploads directory.
	$upload_dir = wp_upload_dir();

	// 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 $file ) {
			if ( ! $file['skip'] ) {
				$file = str_replace( $upload_dir['baseurl'], $upload_dir['basedir'], $file['url'] );
				@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' );

	// 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 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' );
	}

	// Calls the functions added to avatar_manager_delete_avatar action hook.
	do_action( 'avatar_manager_delete_avatar', $attachment_id );
}

add_action( 'delete_attachment', 'avatar_manager_delete_avatar' );

Ringkasan

Kaitan tindakan delete_attachment dipanggil saat lampiran dihapus oleh wp_delete_attachment().
get_post_meta() mengembalikan nilai dari kolom kustom dengan kunci yang ditentukan dari posting yang ditentukan. Pertama, kita menguji apakah lampiran dengan ID yang ditentukan adalah gambar avatar.
Panggilan is_array() menemukan apakah suatu variabel adalah larik.
Kemudian, kita menggunakan fungsi unlink() untuk menghapus gambar avatar termasuk salinan yang diubah ukurannya, tetapi melewatkannya dengan flag skip diatur ke true.
Fungsi delete_post_meta() menghapus semua kolom kustom dengan kunci yang ditentukan dari posting yang ditentukan.
Fungsi get_users() mengambil array pengguna yang cocok dengan kriteria yang diberikan dalam $args.
Fungsi delete_user_meta() menghapus kriteria pencocokan metadata dari pengguna.
Terakhir, kita menjalankan hook tindakan avatar_manager_delete_avatar.

Langkah 3. Memperbarui Profil Pengguna

Saat memperbarui profil pengguna, kita tidak hanya perlu menyimpan opsi yang diubah oleh pengguna tetapi juga untuk menangani unggahan dan penghapusan avatar. Ayo lakukan:

/**
 * Updates user profile based on user ID.
 *
 * @uses avatar_manager_get_options() For retrieving plugin options.
 * @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 avatar_manager_delete_avatar() For deleting an avatar image.
 * @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_avatar_resize() For generating a resized copy of the
 * specified avatar image.
 * @uses avatar_manager_delete_avatar() For deleting an avatar image based on
 * attachment ID.
 * @uses get_edit_user_link() For getting the link to the users 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 User to update.
 */
function avatar_manager_edit_user_profile_update( $user_id ) {
	// Retrieves plugin options.
	$options = avatar_manager_get_options();

	// 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.
	$custom_avatar = get_user_meta( $user_id, 'avatar_manager_custom_avatar', true );

	if ( ! empty( $custom_avatar ) ) {
		// 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( $custom_avatar, '_avatar_manager_custom_avatar_rating', $custom_avatar_rating );
	}

	...
}

add_action( 'edit_user_profile_update', 'avatar_manager_edit_user_profile_update' );
add_action( 'personal_options_update', 'avatar_manager_edit_user_profile_update' );

Ringkasan

edit_user_profile_update dan personal_options_update tindakan umumnya digunakan untuk menghemat custom fields yang telah ditambahkan ke halaman profil WordPress.
Fungsi sanitize_text_field() membersihkan string dari input pengguna atau dari database.
update_user_meta() fungsi memperbarui bidang meta pengguna berdasarkan ID pengguna, sementara get_user_meta() mengambil satu bidang meta atau semua bidang data meta pengguna untuk pengguna yang diberikan.
Fungsi update_post_meta() memperbarui nilai kunci meta yang ada (bidang kustom) untuk posting tertentu.

Penanganan Upload Avatar

Untuk menangani unggahan avatar, tulis kode berikut:

if ( isset( $_POST['avatar-manager-upload-avatar'] ) && $_POST['avatar-manager-upload-avatar'] ) {
	if ( ! function_exists( 'wp_handle_upload' ) )
		require_once( ABSPATH . 'wp-admin/includes/file.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.
	$avatar = wp_handle_upload( $_FILES['avatar_manager_import'], $overrides );

	if ( isset( $avatar['error'] ) )
		// Kills WordPress execution and displays HTML error message.
		wp_die( $avatar['error'],  __( 'Image Upload Error', 'avatar-manager' ) );

	if ( ! empty( $custom_avatar ) )
		// Deletes users old avatar image.
		avatar_manager_delete_avatar( $custom_avatar );

	// An associative array about the attachment.
	$attachment = array(
		'guid'           => $avatar['url'],
		'post_content'   => $avatar['url'],
		'post_mime_type' => $avatar['type'],
		'post_title'     => basename( $avatar['file'] )
	);

	// Inserts the attachment into the media library.
	$attachment_id = wp_insert_attachment( $attachment, $avatar['file'] );

	// Generates metadata for the attachment.
	$attachment_metadata = wp_generate_attachment_metadata( $attachment_id, $avatar['file'] );

	// Updates metadata for the attachment.
	wp_update_attachment_metadata( $attachment_id, $attachment_metadata );

	$custom_avatar = array();

	// Generates a resized copy of the avatar image.
	$custom_avatar[ $options['default_size'] ] = avatar_manager_avatar_resize( $avatar['url'], $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 );

	// 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 );
}

Ringkasan

function_exists() mengembalikan true jika fungsi yang diberikan telah didefinisikan, maka require_once() pernyataan memeriksa apakah file yang ditentukan telah dimasukkan, dan jika demikian, tidak memasukkannya lagi.
Fungsi wp_handle_upload() menangani upload PHP di WordPress, membersihkan nama file, memeriksa ekstensi untuk tipe mime, dan memindahkan file ke direktori yang sesuai dalam direktori upload.
Sebelum menambahkan gambar avatar baru, kita memanggil avatar_manager_delete_avatar() fungsi untuk menghapus avatar lama, jika ada yang diatur.
Fungsi wp_insert_attachment() menyisipkan lampiran ke perpustakaan media.
Fungsi wp_generate_attachment_metadata() menghasilkan metadata untuk lampiran gambar; itu juga menciptakan thumbnail dan ukuran menengah lainnya dari lampiran gambar berdasarkan ukuran yang ditentukan pada Pengaturan Layar Media.
Fungsi wp_update_attachment_metadata() memperbarui metadata untuk lampiran.
Selanjutnya, kita memanggil fungsi avatar_manager_avatar_resize() untuk menghasilkan salinan gambar avatar pada ukuran default.
Terakhir, kita memperbarui metadata untuk lampiran dan untuk pengguna yang saat ini sedang diedit.

Menghapus Gambar Avatar

Sekarang, saatnya untuk membuat plugin untuk benar-benar menghapus gambar avatar saat diminta:

if ( isset( $_GET['avatar_manager_action'] ) && $_GET['avatar_manager_action'] ) {
	global $wp_http_referer;

	$action = $_GET['avatar_manager_action'];

	switch ( $action ) {
		case 'remove-avatar':
			// Deletes avatar image based on attachment ID.
			avatar_manager_delete_avatar( $_GET['avatar_manager_custom_avatar'] );

			break;
	}

	// Gets the link to the users 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;
}

Ringkasan

Jika nilai dari tindakan yang diminta adalah remove-avatar, kita memanggil avatar_manager_delete_avatar() untuk menghapus gambar avatar yang ditentukan.
Fungsi get_edit_user_link() mendapat tautan ke pengguna mengedit halaman profil di admin WordPress.
Fungsi urlencode() mengkodekan string yang akan digunakan dalam bagian query dari URL.
Pada akhir fungsi, kita memanggil fungsi wp_redirect() untuk mengarahkan kembali pengguna ke profil pengguna yang diperbarui.
Panggilan exit akan menghentikan eksekusi skrip; ini adalah konstruksi bahasa dan itu bisa disebut tanpa tanda kurung jika tidak ada status yang dilewatkan.

Langkah 4. Mengambil Gambar Avatar Kustom

Selanjutnya, kita akan menulis fungsi pembantu untuk mengambil gambar avatar khusus:

/**
 * 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 get_post_meta() For retrieving attachment meta fields.
 * @uses wp_get_attachment_image_src() For retrieving an array with the image
 * attributes "url", "width" and "height", of an image attachment file.
 * @uses avatar_manager_avatar_resize() For generating a resized copy of the
 * specified avatar image.
 * @uses update_post_meta() For updating attachment meta fields.
 * @uses apply_filters() For calling the functions added to a filter hook.
 *
 * @since Avatar Manager 1.0.0
 *
 * @param int $user_id User to update.
 * @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 <img> 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['avatar-manager-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.
	$custom_avatar = get_user_meta( $user_id, 'avatar_manager_custom_avatar', true );

	// Returns if no attachment ID was retrieved.
	if ( empty( $custom_avatar ) )
		return false;

	// Retrieves attachment meta field based on attachment ID.
	$custom_avatar_rating = get_post_meta( $custom_avatar, '_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.
		$avatar = get_post_meta( $custom_avatar, '_avatar_manager_custom_avatar', true );

		if ( empty( $avatar[ $size ] ) ) {
			// Retrieves an array with the image attributes "url", "width"
			// and "height", of the image attachment file.
			$url = wp_get_attachment_image_src( $custom_avatar, 'full' );

			// Generates a resized copy of the avatar image.
			$avatar[ $size ] = avatar_manager_avatar_resize( $url[0], $size );

			// Updates attachment meta field based on attachment ID.
			update_post_meta( $custom_avatar, '_avatar_manager_custom_avatar', $avatar );
		}

		$src    = $avatar[ $size ]['url'];
		$avatar = '<img alt="' . $alt . '" class="avatar avatar-' . $size . ' photo avatar-default" height="' . $size . '" src="' . $src . '" width="' . $size . '">';
	} else {
		$src  = $host . '/avatar/';
		$src .= $email_hash;
		$src .= '?s=' . $size;
		$src .= '&d=' . urlencode( $default );
		$src .= '&forcedefault=1';

		$avatar = '<img alt="' . $alt . '" class="avatar avatar-' . $size . ' photo avatar-default" height="' . $size . '" src="' . $src . '" width="' . $size . '">';
	}

	// Calls the functions added to avatar_manager_get_custom_avatar
	// filter hook.
	return apply_filters( 'avatar_manager_get_custom_avatar', $avatar, $user_id, $size, $default, $alt );
}

Ringkasan

Fungsi avatar_manager_get_custom_avatar mengembalikan gambar avatar kustom berdasarkan ID pengguna atau false jika menampilkan avatar tidak diaktifkan. Fungsi mengambil opsi plugin, membersihkan parameter $size dan melepaskan atribut HTML dari variabel $alt.
Kemudian, ia mengambil gambar default untuk digunakan sebagai pengganti gambar avatar jika peringkat avatar tidak cocok. Salinan gambar avatar yang diubah ukurannya dibuat sesuai permintaan jika ukuran yang diminta tidak cocok dengan file gambar yang ada.
Fungsi get_userdata() mengembalikan objek WP_User dengan informasi yang berkaitan dengan pengguna yang ID-nya diteruskan ke sana.
The md5() mengembalikan fungsi MD5 hash untuk string yang disediakan.
Fungsi strtolower() mengembalikan string yang disediakan tetapi dengan semua karakter alfabetik diubah menjadi huruf kecil.
Panggilan is_ssl() memeriksa jika SSL sedang digunakan.
Fungsi sprintf() mengembalikan string berformat.
Fungsi hexdec() mengembalikan nilai desimal desimal dari angka heksadesimal yang ditentukan.
Panggilan strpos() menemukan posisi numerik dari terjadinya needle pertama di tumpukan haystack.
Fungsi wp_get_attachment_image_src() mengembalikan array dengan url atribut gambar, width dan height, file lampiran gambar.
Terakhir, kita menggunakan fungsi apply_filters() untuk memanggil fungsi yang ditambahkan ke hook filter avatar_manager_get_custom_avatar.

Langkah 5. Mengambil Gambar Avatar

Pada dasarnya, fungsi selanjutnya adalah fungsi utama dari plugin:

/**
 * 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 <img> 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['avatar-manager-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 );

Ringkasan

Fungsi avatar_manager_get_avatar() mengembalikan avatar untuk pengguna yang memberikan ID pengguna atau alamat email, atau salah jika menampilkan avatar tidak diaktifkan.
Kita menggunakan filter get_avatar untuk mengubah output fungsi get_avatar(). Fungsi kita mengambil opsi plugin, membersihkan parameter $size dan menemukan ID dari pengguna yang ditentukan.
Kemudian, mengembalikan hasil dari avatar_manager_get_custom_avatar() fungsi panggilan, atau output yang tidak dimodifikasi dari get_avatar() jika pengguna tidak menggunakan avatar kustom.
Panggilan is_object() menemukan apakah suatu variabel adalah objek.
Fungsi email_exists() memeriksa apakah alamat email yang diberikan sudah terdaftar untuk nama pengguna, dan mengembalikan ID pengguna itu, atau salah jika tidak ada.

Untuk menguji hasilnya, buka Pengguna -> Layar Profil Anda.

Opsi Plugin Manajer Avatar di bawah Layar Pengguna Profil Anda

Jelajahi gambar dan unggah. Sekarang, Anda harus dapat memilih antara menggunakan Gravatar atau gambar avatar kustom yang baru saja Anda unggah.

Langkah 6. Menghilangkan Hook Filter yang Tidak Diperlukan

Jika Anda pergi ke Layar Pengaturan Pengaturan Anda akan melihat bahwa avatar dari pengaturan Avatar Default diganti dengan avatar kustom Anda. Untuk memperbaiki masalah ini, kita akan mengembalikan avatar default dengan menghapus fungsi kustom kita ketika tidak diperlukan dengan bantuan hook filter avatar_defaults. Untuk melakukannya, tambahkan kode berikut:

/**
 * 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 );

Untuk mencegah avatar kustom diterapkan ke pengaturan Avatar Default, kita memanggil fungsi remove_filter(). Ini menghapus fungsi yang melekat pada hook filter yang ditentukan. Metode ini dapat digunakan untuk menghapus fungsi-fungsi standar yang melekat pada hook filter tertentu dan mungkin menggantikannya dengan pengganti.

Langkah 7. Menampilkan Negara Media Kustom

Layar Pustaka Media memungkinkan Anda untuk mengedit, melihat, dan menghapus gambar, video, rekaman, dan file yang sebelumnya diunggah ke blog Anda. Untuk mengidentifikasi lampiran yang digunakan sebagai gambar avatar, kita akan menampilkan status media khusus untuknya:

/**
 * 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.0.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 );

Filter display_media_states digunakan untuk menampilkan status media khusus untuk attachmets yang telah ditambahkan ke Media Library. Kita menggunakan variabel global $post untuk mengambil ID dari lampiran saat ini. Jika bidang kustom _avatar_manager_is_custom_avatar tidak kosong, lampiran adalah gambar avatar sehingga kita menambahkan status media khusus untuknya.

Jika Anda tidak memiliki gambar avatar khusus apa pun, unggah satu dan masuk ke Layar Pustaka Media.

Status media plugin Avatar Manager berada di bawah Layar Media Library

Perhatikan bahwa setiap lampiran yang digunakan sebagai gambar avatar khusus memiliki gambar Avatar yang ditambahkan di samping nama file.

Langkah 8. Menambahkan Uninstaller

Untuk menangani proses uninstal, plugin harus membuat file bernama uninstall.php di direktori plugin dasar daripada menggunakan register_uninstall_hook(). File ini akan dipanggil, jika ada, selama proses penghapusan instalasi melewati hook penginstalan. Untuk melakukannya, buka avatar-manager/uninstall.php dan tambahkan kode berikut:

<?php
/**
 * @package Avatar_Manager
 * @subpackage Uninstaller
 */

// Exits if uninstall is not called from WordPress.
if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) )
	exit;

if ( ! function_exists( 'avatar_manager_delete_avatar' ) )
	include_once( 'avatar-manager.php' );

// Deletes plugin options.
delete_option( 'avatar_manager' );

// An associative array with criteria to match.
$args = array(
	'meta_key' => 'avatar_manager_custom_avatar'
);

// Retrieves an array of users matching the criteria given in $args.
$users = get_users( $args );

foreach ( $users as $user ) {
	// Deletes avatar image based on attachment ID.
	avatar_manager_delete_avatar( $user->avatar_manager_custom_avatar );
}
?>

Saat menggunakan uninstall.php plugin harus selalu memeriksa konstanta WP_UNINSTALL_PLUGIN, sebelum mengeksekusi. Konstanta WP_UNINSTALL_PLUGIN didefinisikan oleh WordPress pada saat runtime selama plugin uninstall dan itu tidak akan hadir jika uninstall.php diminta secara langsung. Yang define() memeriksa apakah ada konstanta bernama yang diberikan. Pernyataan include_once menyertakan dan mengevaluasi file yang ditentukan selama eksekusi skrip; jika kode dari file sudah dimasukkan, itu tidak akan dimasukkan lagi. Fungsi delete_option() menghapus opsi bernama dari tabel database opsi.

Langkah 9. Internasionalisasi dan Penerjemahan Plugin

Setelah Anda memiliki pemrograman untuk plugin Anda selesai, pertimbangan lain adalah internasionalisasi. Internasionalisasi, sering disingkat sebagai i18n, adalah proses pengaturan perangkat lunak sehingga dapat dilokalisasi; lokalisasi, atau l10n, adalah proses menerjemahkan teks yang ditampilkan oleh perangkat lunak ke dalam bahasa yang berbeda. WordPress menggunakan pustaka gettext dan alat untuk i18n.

Sangat disarankan agar Anda menginternasionalkan plugin Anda, sehingga pengguna dari berbagai negara dapat melokalkannya.

String diterjemahkan

Untuk membuat string yang dapat diterjemahkan, Anda hanya harus membungkus string asli dalam panggilan fungsi __(). Jika kode Anda harus menggemakan string ke browser, gunakan fungsi _e() sebagai gantinya. Seperti yang Anda ketahui, kita sudah melakukannya di plugin.

Teks Domain

Domain teks adalah pengenal unik, yang memastikan WordPress dapat membedakan antara semua terjemahan yang dimuat. Menggunakan basename dari plugin Anda selalu merupakan pilihan yang baik. Anda dapat memuat string terjemahan plugin dengan memanggil fungsi load_plugin_textdomain(), yang telah dilakukan di bagian pertama dari tutorial.

File PO

Sekarang, kita perlu membuat file .po untuk penerjemah. Untuk melakukan ini, kita akan menggunakan perangkat lunak penerjemahan Poedit. Setelah Anda mengunduhnya, klik File -> New Catalog ... untuk menyiapkan katalog baru. Jendela baru seharusnya terbuka. Buka tab Info proyek dan masukkan Avatar Manager sebagai nama proyek.

Tab Info Proyek Poedit di bawah jendela Pengaturan

Pada tab Paths, mari tinggalkan jalur dasar sebagai . yang mengacu pada direktori di mana katalog tersebut.

Tab Paths Poedit di bawah jendela Pengaturan

Selanjutnya, buka tab Keywords. Hapus semua item di sana, dan tambahkan kata kunci ini: __, _e, _n, dan _x.

Tab Keywords Poedit di bawah jendela Pengaturan

Tekan OK dan simpan file sebagai avatar-manager/languages/avatar-manager-default.po. Sekarang, file sudah siap untuk diterjemahkan.

Jendela utama Poedit

Terjemahkan semua string yang Anda inginkan dan kemudian simpan file sebagai avatar-manager/languages/avatar-manager-{locale}.po. Lokal adalah kode bahasa dan/atau kode negara yang Anda tentukan dalam WPLANG konstan dalam file wp-config.php.

MO file

File .mo adalah file biner yang berisi semua string asli dan terjemahannya dalam format yang cocok untuk ekstraksi terjemahan cepat. Konversi dilakukan secara otomatis jika Anda pergi ke Edit -> Preferences -> Editor dan check Automatically compile .mo file on save.

Langkah 10. Melepaskan dan Mempromosikan Plugin

Bagian ini membahas langkah-langkah untuk mengambil plugin yang Anda buat dan mendistribusikannya secara luas.

Mengirimkan ke Direktori Plugin WordPress

Cara tercepat, termudah, dan terbaik untuk mengeluarkan plugin Anda adalah mengunggah plugin Anda ke Direktori Plugin WordPress. Untuk detail lebih lanjut tentang mengirimkan plugin Anda, lihat tentang halaman atau lompat langsung ke halaman pengiriman plugin.

Mempromosikan dan Mendokumentasikan Plugin Anda

Untuk mengirimkan dan mempromosikan plugin Anda ke Komunitas WordPress, pertama-tama buat halaman untuk plugin di situs Anda dengan instruksi yang lengkap dan ditulis dengan baik. Sertakan tautan ke halaman penjelasan ini di tajuk plugin, sehingga orang dapat dengan mudah memeriksa pembaruan dan informasi serta bantuan lebih lanjut.

Jika Anda memilih untuk mengirimkan plugin Anda ke Direktori Plugin WordPress, buat juga informasi ini sejelas mungkin sehingga mereka dapat mengkategorikan dan membantu orang lain memahami penggunaan plugin Anda. Anda juga perlu membuat file readme.txt dalam format standar, dan sertakan dengan plugin Anda.

Kesimpulan

Ini menutup tutorial; sekarang, kita memiliki plugin yang berfungsi penuh dan belajar beberapa tips dan trik praktis tentang pengembangan plugin WordPress. Ide di balik plugin ini dimulai sebagai fitur yang diminta di inti WordPress; Saya akan senang mendengar pendapat Anda tentang hal itu. Apakah itu meningkatkan alur kerja saat ini? Akankah Anda menemukan pendekatan serupa yang berguna tetapi mengelola gambar Gravatar langsung dari layar profil Anda?

Sebagai bonus, plugin Avatar Manager juga tersedia di WordPress Plugin Directory dan GitHub. Lihat untuk mendapatkan info terbaru tentang rilis terbaru. Terima kasih sudah membaca!

Referensi

Standar Coding WordPress - Informasi umum tentang standar pengkodean untuk pengembangan WordPress.
Menulis Plugin - Tempat awal terbaik untuk belajar tentang cara mengembangkan plugin WordPress.
API Plugin - Deskripsi cara menggunakan hook tindakan dan filter di plugin WordPress Anda, dan fungsi inti yang dapat diganti plugin.
Referensi Fungsi - Sebuah artikel dengan banyak fungsi inti WordPress yang berguna untuk plugin dan pengembang tema; daftar sebagian besar fungsi inti, kecuali Tag Template.
I18n untuk Pengembang WordPress - Internasionalisasi, termasuk bagian tentang cara menginternasionalisasikan plugin Anda.
Pengajuan dan Promosi Plugin - Setelah Anda menulis plugin Anda, berikut beberapa petunjuk untuk mendistribusikannya secara luas.

Tautan Eksternal

Manajer Avatar pada Direktori Plugin WordPress - Rumah resmi untuk plugin Avatar Manager.
Avatar Manager di GitHub - Kode sumber dari plugin Avatar Manager.