get_avatar

函式


      get_avatar ( $id_or_email, $size = 96, $default = '', $alt = '', $args = null )

引數

(mixed) $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.

Required: 是
(int) $size Optional. Height and width of the avatar image file in pixels. Default 96.

Required: 否

Default: 96
(string) $default Optional. URL for the default image or a default type. Accepts '404' (return a 404 instead of a default image), 'retro' (8bit), 'monsterid' (monster), 'wavatar' (cartoon face), 'indenticon' (the "quilt"), 'mystery', 'mm', or 'mysteryman' (The Oyster Man), 'blank' (transparent GIF), or 'gravatar_default' (the Gravatar logo). Default is the value of the 'avatar_default' option, with a fallback of 'mystery'.

Required: 否

Default: (empty)
(string) $alt Optional. Alternative text to use in img tag. Default empty.

Required: 否

Default: (empty)
(array) $args { Optional. Extra arguments to retrieve the avatar. @type int $height Display height of the avatar in pixels. Defaults to $size. @type int $width Display width of the avatar in pixels. Defaults to $size. @type bool $force_default Whether to always show the default image, never the Gravatar. Default false. @type string $rating What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are judged in that order. Default is the value of the 'avatar_rating' option. @type string $scheme URL scheme to use. See set_url_scheme() for accepted values. Default null. @type array|string $class Array or string of additional classes to add to the img element. Default null. @type bool $force_display Whether to always show the avatar - ignores the show_avatars option. Default false. @type string $loading Value for the `loading` attribute. Default null. @type string $extra_attr HTML attributes to insert in the IMG element. Is not sanitized. Default empty. }

Required: 否

Default: null

返回值

(string|false) `<img>` tag for the user's avatar. False on failure.

定義位置

wp-includes/pluggable.php , line 2779

相關方法: get_avatar_url get_avatar_data get_metadata get_tag get_metadata_raw

引入: 2.5.0

棄用: -

get_avatar: 這個函式根據電子郵件地址或使用者ID，返回顯示使用者頭像的HTML程式碼。它接受兩個引數：$id_or_email和$size。$id_or_email引數可以是電子郵件地址或使用者ID。$size引數是可選的，用於指定頭像的尺寸，單位是畫素。

檢索使用者、電子郵件地址、MD5雜湊值、評論或文章的頭像`<img>`標籤。

function get_avatar( $id_or_email, $size = 96, $default = '', $alt = '', $args = null ) {
		$defaults = array(
			// get_avatar_data() args.
			'size'          => 96,
			'height'        => null,
			'width'         => null,
			'default'       => get_option( 'avatar_default', 'mystery' ),
			'force_default' => false,
			'rating'        => get_option( 'avatar_rating' ),
			'scheme'        => null,
			'alt'           => '',
			'class'         => null,
			'force_display' => false,
			'loading'       => null,
			'extra_attr'    => '',
			'decoding'      => 'async',
		);

		if ( wp_lazy_loading_enabled( 'img', 'get_avatar' ) ) {
			$defaults['loading'] = wp_get_loading_attr_default( 'get_avatar' );
		}

		if ( empty( $args ) ) {
			$args = array();
		}

		$args['size']    = (int) $size;
		$args['default'] = $default;
		$args['alt']     = $alt;

		$args = wp_parse_args( $args, $defaults );

		if ( empty( $args['height'] ) ) {
			$args['height'] = $args['size'];
		}
		if ( empty( $args['width'] ) ) {
			$args['width'] = $args['size'];
		}

		if ( is_object( $id_or_email ) && isset( $id_or_email->comment_ID ) ) {
			$id_or_email = get_comment( $id_or_email );
		}

		/**
		 * Allows the HTML for a user's avatar to be returned early.
		 *
		 * Returning a non-null value will effectively short-circuit get_avatar(), passing
		 * the value through the {@see 'get_avatar'} filter and returning early.
		 *
		 * @since 4.2.0
		 *
		 * @param string|null $avatar      HTML for the user's avatar. Default null.
		 * @param mixed       $id_or_email The avatar to retrieve. Accepts a user_id, Gravatar MD5 hash,
		 *                                 user email, WP_User object, WP_Post object, or WP_Comment object.
		 * @param array       $args        Arguments passed to get_avatar_url(), after processing.
		 */
		$avatar = apply_filters( 'pre_get_avatar', null, $id_or_email, $args );

		if ( ! is_null( $avatar ) ) {
			/** This filter is documented in wp-includes/pluggable.php */
			return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );
		}

		if ( ! $args['force_display'] && ! get_option( 'show_avatars' ) ) {
			return false;
		}

		$url2x = get_avatar_url( $id_or_email, array_merge( $args, array( 'size' => $args['size'] * 2 ) ) );

		$args = get_avatar_data( $id_or_email, $args );

		$url = $args['url'];

		if ( ! $url || is_wp_error( $url ) ) {
			return false;
		}

		$class = array( 'avatar', 'avatar-' . (int) $args['size'], 'photo' );

		if ( ! $args['found_avatar'] || $args['force_default'] ) {
			$class[] = 'avatar-default';
		}

		if ( $args['class'] ) {
			if ( is_array( $args['class'] ) ) {
				$class = array_merge( $class, $args['class'] );
			} else {
				$class[] = $args['class'];
			}
		}

		// Add `loading` attribute.
		$extra_attr = $args['extra_attr'];
		$loading    = $args['loading'];

		if ( in_array( $loading, array( 'lazy', 'eager' ), true ) && ! preg_match( '/bloadings*=/', $extra_attr ) ) {
			if ( ! empty( $extra_attr ) ) {
				$extra_attr .= ' ';
			}

			$extra_attr .= "loading='{$loading}'";
		}

		if ( in_array( $args['decoding'], array( 'async', 'sync', 'auto' ) ) && ! preg_match( '/bdecodings*=/', $extra_attr ) ) {
			if ( ! empty( $extra_attr ) ) {
				$extra_attr .= ' ';
			}
			$extra_attr .= "decoding='{$args['decoding']}'";
		}

		$avatar = sprintf(
			"<img alt='%s' src='%s' srcset='%s' class='%s' height='%d' width='%d' %s/>",
			esc_attr( $args['alt'] ),
			esc_url( $url ),
			esc_url( $url2x ) . ' 2x',
			esc_attr( implode( ' ', $class ) ),
			(int) $args['height'],
			(int) $args['width'],
			$extra_attr
		);

		/**
		 * Filters the HTML for a user's avatar.
		 *
		 * @since 2.5.0
		 * @since 4.2.0 The `$args` parameter was added.
		 *
		 * @param string $avatar      HTML for the user's avatar.
		 * @param mixed  $id_or_email The avatar to retrieve. Accepts a user_id, Gravatar MD5 hash,
		 *                            user email, WP_User object, WP_Post object, or WP_Comment object.
		 * @param int    $size        Square avatar width and height in pixels to retrieve.
		 * @param string $default     URL for the default image or a default type. Accepts '404', 'retro', 'monsterid',
		 *                            'wavatar', 'indenticon', 'mystery', 'mm', 'mysteryman', 'blank', or 'gravatar_default'.
		 * @param string $alt         Alternative text to use in the avatar image tag.
		 * @param array  $args        Arguments passed to get_avatar_data(), after processing.
		 */
		return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );
	}
endif;

if ( ! function_exists( 'wp_text_diff' ) ) :
	/**
	 * Displays a human readable HTML representation of the difference between two strings.
	 *
	 * The Diff is available for getting the changes between versions. The output is
	 * HTML, so the primary use is for displaying the changes. If the two strings
	 * are equivalent, then an empty string will be returned.
	 *
	 * @since 2.6.0
	 *
	 * @see wp_parse_args() Used to change defaults to user defined settings.
	 * @uses Text_Diff
	 * @uses WP_Text_Diff_Renderer_Table
	 *
	 * @param string       $left_string  "old" (left) version of string.
	 * @param string       $right_string "new" (right) version of string.
	 * @param string|array $args {
	 *     Associative array of options to pass to WP_Text_Diff_Renderer_Table().
	 *
	 *     @type string $title           Titles the diff in a manner compatible
	 *                                   with the output. Default empty.
	 *     @type string $title_left      Change the HTML to the left of the title.
	 *                                   Default empty.
	 *     @type string $title_right     Change the HTML to the right of the title.
	 *                                   Default empty.
	 *     @type bool   $show_split_view True for split view (two columns), false for
	 *                                   un-split view (single column). Default true.
	 * }
	 * @return string Empty string if strings are equivalent or HTML with differences.
	 */

常見問題

FAQs

如何使用get_users獲取所有使用者列表？
要使用` get_users `函式獲取所有使用者列表，可以按照以下步驟進行：

1. 使用` get_users `函式呼叫獲取使用者列表：
```
$users = get_users();
```
2. 您可以按需使用引數來過濾結果。例如，您可以通過角色、使用者ID、使用者登入名等過濾使用者列表。以下是一個根據使用者角色為過濾條件的示例：
```
$users = get_users( array(
    'role' => 'subscriber' // 將角色名稱替換為您要過濾的角色
) );
```
在上述示例中，將` role `引數設定為所需的角色名稱來過濾使用者列表。

3. 您可以使用迴圈遍歷獲取的使用者列表，並訪問每個使用者的屬性。例如，以下示例將顯示每個使用者的使用者名稱和電子郵件地址：
```
foreach( $users as $user ) {
    echo '使用者名稱：' . $user->user_login . ', 電子郵件：' . $user->user_email . ;
}
```
在上述示例中，通過` $user->user_login `和` $user->user_email `訪問每個使用者的使用者名稱和電子郵件地址。

請注意，` get_users `函式預設返回所有使用者，並可以根據需要使用更多引數進行過濾。您可以參閱WordPress官方文件中的` get_users `函式文件，瞭解更多可用引數和用法示例。

總結起來，使用` get_users `函式獲取所有使用者列表的步驟是：
1. 呼叫` get_users `函式獲取使用者列表。
2. 使用可選的過濾引數，根據需要過濾使用者列表。
3. 使用迴圈遍歷使用者列表，並訪問每個使用者的屬性。
如何使用WP_PLUGIN_DIR和WP_PLUGIN_URL定義外掛的目錄和URL？
在WordPress中，可以使用WP_PLUGIN_DIR和WP_PLUGIN_URL常量來定義外掛的目錄路徑和URL。

1. `WP_PLUGIN_DIR`：這是一個常量，用於定義外掛的目錄路徑（檔案系統路徑）。您可以使用以下程式碼在外掛檔案中訪問該常量：
```
$plugin_dir = WP_PLUGIN_DIR . '/your-plugin-folder/';
```
在上述程式碼中，將"your-plugin-folder"替換為您外掛的實際資料夾名稱。使用該常量，您可以獲取外掛檔案的完整路徑。

2. `WP_PLUGIN_URL`：這是一個常量，用於定義外掛的URL（用於在網頁上訪問外掛檔案）。以下是一個使用該常量的示例：
```
$plugin_url = WP_PLUGIN_URL . '/your-plugin-folder/';
```
同樣，請將"your-plugin-folder"替換為您外掛的實際資料夾名稱。使用該常量，您可以獲取外掛在網頁上的完整URL。

請注意，`WP_PLUGIN_DIR`和`WP_PLUGIN_URL`常量在WordPress版本2.6之後引入。從WordPress 5.5版本開始，這兩個常量被標記為過時（deprecated），因為WordPress更傾向於使用新的外掛檔案結構。如果您正在開發新外掛，建議使用新的外掛檔案結構和相關函式。

在新的外掛檔案結構中，可以使用以下函式來獲取外掛的目錄路徑和URL：

- `plugin_dir_path()`：獲取外掛目錄路徑。
- `plugin_dir_url()`：獲取外掛URL。

這些函式會自動將外掛的版本、多站點和SSL等考慮因素納入計算。

總結起來，使用`WP_PLUGIN_DIR`和`WP_PLUGIN_URL`常量定義外掛的目錄和URL的方法是：
```
$plugin_dir = WP_PLUGIN_DIR . '/your-plugin-folder/';
$plugin_url = WP_PLUGIN_URL . '/your-plugin-folder/';
```
但請注意，這兩個常量已被標記為過時，建議使用新的外掛檔案結構和相關函式來獲取外掛的路徑和URL。
如何使用PHP在WordPress中新增自定義功能？
使用PHP在WordPress中新增自定義功能可以通過以下方式實現：
- 建立一個自定義外掛，將功能程式碼新增到外掛中。
- 使用WordPress的鉤子系統，將自定義功能繫結到適當的鉤子上。
- 在主題檔案中新增自定義功能程式碼，例如functions.php檔案。
- 使用WordPress的短程式碼功能，將自定義功能封裝為短程式碼。
- 使用WordPress的外掛或主題編輯器，將自定義功能程式碼新增到適當的位置。
下面是一個實操示例。

要在WordPress中新增自定義功能，可以按照以下步驟使用PHP編寫並新增自定義功能：
1. 開啟WordPress安裝目錄中的主題資料夾，通常位於wp-content/themes/下，找到正在使用的主題資料夾。
2. 在主題資料夾中，可以建立一個名為functions.php的檔案。如果該檔案已經存在，可以直接編輯它。
3. 在functions.php檔案中，可以使用PHP程式碼新增自定義功能。以下是一些常見的示例：
```
// 新增自定義功能示例

// 1. 建立自定義短程式碼
function custom_shortcode() {
    return '這是我的自定義短程式碼內容';
}
add_shortcode('custom', 'custom_shortcode');

// 2. 自定義小工具
function custom_widget() {
    echo '這是我的自定義小工具內容';
}
register_widget('custom_widget');

// 3. 自定義選單
function custom_menu() {
    register_nav_menu('custom-menu', '自定義選單');
}
add_action('after_setup_theme', 'custom_menu');

// 4. 自定義頁面模板
function custom_page_template() {
    /* Template Name: 自定義模板 */
    // 自定義模板的內容和樣式
}
```
4. 編輯完functions.php檔案後，儲存並上傳到WordPress主題資料夾中。
請注意，修改主題檔案可以在主題更新時丟失，因此建議在進行任何更改之前備份functions.php檔案。此外，為避免不必要的錯誤和衝突，建議在新增自定義功能前先了解WordPress開發文件和最佳實踐，以確保正確、安全地實現所需的自定義功能。
如何進行WordPress資料庫查詢優化？
進行WordPress資料庫查詢優化可以通過以下方式實現：
- 使用WordPress提供的內建查詢函式，例如 WP_Query 、 get_posts 等。
- 使用適當的查詢引數和過濾器，減少查詢次數和資料量。
- 編寫自定義的資料庫查詢語句，使用適當的索引和快取。
- 優化資料庫伺服器配置和效能。
- 定期清理和優化資料庫表。
如何使用do_action來觸發一個鉤子函式？
使用 do_action 函式可以觸發一個鉤子函式。do_action 函式的引數與要觸發的鉤子函式的引數相同。

例如，觸發save_post鉤子函式的程式碼如下：
```
do_action( 'save_post', $post_ID, $post );
```
這裡，$post_ID 和 $post 是傳遞給鉤子函式的引數。

如何使用wp_get_current_user獲取當前登入使用者的資訊？

使用 wp_get_current_user 獲取當前登入使用者的資訊：

$current_user = wp_get_current_user();  
  
// 獲取當前使用者的ID  
$user_id = $current_user->ID;  
  
// 獲取當前使用者的使用者名稱  
$user_login = $current_user->user_login;  
  
// 獲取當前使用者的郵箱  
$user_email = $current_user->user_email;  
  
// 獲取當前使用者的顯示名稱  
$display_name = $current_user->display_name;

檢視更多 >

get_avatar

常見問題

相關文章