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

如何使用apply_filters来应用一个过滤器函数？
apply_filters 函数用于调用一个钩子上的所有过滤器函数。它的基本用法如下：
```
$value = apply_filters( 'hook_name', $value, $var1, $var2, ... );
```
其中：

'hook_name' 是你要应用过滤器函数的钩子名称。
$value 是你要传递给过滤器函数的值。
$var1, $var2, … 是你要传递给过滤器函数的其他参数。
常量的命名规则和约定是什么？
常量的命名有一些约定和规则。首先，常量的名称应该全部大写，用下划线分隔单词。例如，MY_CONSTANT_NAME。其次，常量的名称应该是有意义的，能够清晰地描述常量的用途或值。最后，避免使用已经被PHP或WordPress定义的常量名称，以避免冲突。

在WordPress中，常量的命名规则和约定如下：
1. 全大写字母：WordPress中的常量通常以全大写字母表示，例如： ABSPATH 。
2. 使用下划线分隔单词：常量的单词之间使用下划线 _ 进行分隔，例如： WP_DEBUG .
3. 常量的前缀：建议为常量添加一个特定的前缀以避免与其他常量或变量发生冲突。例如，WordPress核心常量通常使用前缀 WP_ ，例如： WP_CONTENT_DIR 。
4. 描述性命名：常量的名称应该具有描述性，以便能够清楚地表达其用途和含义。这有助于提高代码的可读性和可维护性。
5. 避免硬编码：常量的作用是提供一个不可更改的值，因此应避免在代码中直接硬编码常量的值。相反，应该通过定义常量并赋予其一个有意义的值来使用它们。
例如，以下是符合WordPress常量命名规则的示例：
```
define( 'WP_DEBUG', true );
define( 'WP_CONTENT_DIR', '/var/www/html/wp-content' );
define( 'MY_CUSTOM_CONSTANT', 'Hello World' );
```
遵循这些命名规则和约定可以帮助保持代码的一致性和可读性，使得WordPress主题或插件更易于理解、维护和扩展。
如何使用WordPress REST API？
要使用WordPress REST API，可以按照以下步骤进行操作：
1. 检查WordPress版本：确保你使用的WordPress版本在4.7或更高，因为REST API是从该版本开始集成到WordPress核心中的。
2. 启用REST API：默认情况下，WordPress REST API已经启用。如果你需要确认是否启用，可以访问WordPress的后台管理页面，转到“设置” > “固定链接” ，然后确保“常规设置”中的“启用REST API”选项被勾选。
3. 授权和身份验证：REST API通常需要进行身份验证。你可以使用OAuth、基本身份验证（用户名和密码）或cookie进行身份验证。根据你的需求选择合适的身份验证方式。
4. 使用REST API终点：WordPress REST API提供了各种终点（endpoints），用于执行不同的操作，如检索帖子、页面、分类目录、评论等。你可以通过GET、POST、PUT、DELETE等请求方法与这些终点进行交互。
  - 例如，要获取帖子列表，可以发出GET请求到`/wp-json/wp/v2/posts`。
  - 要获取特定帖子的详细信息，例如ID为1的帖子，可以发出GET请求到`/wp-json/wp/v2/posts/1`。
  - 要创建新的帖子，可以发出POST请求到`/wp-json/wp/v2/posts`并提供所需的参数。
5. 处理响应数据：REST API通常返回JSON格式的数据。你可以使用编程语言、HTTP客户端或浏览器工具来处理和解析返回的JSON数据。
这些是使用WordPress REST API的基本步骤。你可以根据具体需求进行深入学习和实践，探索更多可用的终点和功能。对于详细的API文档和参考，请查阅WordPress官方文档或REST API官方手册。
钩子函数可以在哪些地方使用？
在WordPress中，钩子函数可以在以下几个地方使用：
1. 插件（Plugins）：WordPress的插件是一种扩展机制，允许开发者在WordPress的核心功能之上添加自定义功能。插件可以使用钩子函数来注册和处理特定的WordPress事件或动作。例如，可以使用`add_action()`函数来注册在特定动作点（action hooks）上执行的钩子函数，或使用` add_filter() `函数注册在特定过滤器（filter hooks）上执行的钩子函数。
2. 主题（Themes）：WordPress的主题是用于控制网站外观和功能的模板系统。开发者可以在主题中使用钩子函数来修改主题输出的内容或行为。例如，可以使用` add_action() `函数在特定的动作点上添加自定义内容，或使用` add_filter() `函数修改主题函数的输出。
3. 自定义功能文件（Custom Functions File）：可以在主题文件夹或子主题文件夹中创建一个名为` functions.php `的文件，用于添加自定义功能和修改WordPress行为。该文件中可以使用钩子函数来注册特定的动作点和过滤器，并添加相应的钩子函数来处理这些事件。
4. WordPress核心文件：尽管不推荐修改WordPress核心文件，但在某些情况下，可以通过修改核心文件的方式使用钩子函数。例如，可以在WordPress核心文件中的特定位置添加自定义的` do_action() `或` apply_filters() `函数调用，然后在需要的地方注册相应的钩子函数。
总结起来，WordPress中的钩子函数可以在插件、主题、自定义功能文件以及WordPress核心文件中使用，用于注册和处理特定的WordPress事件或动作。这允许开发者在这些地方插入自定义逻辑，以实现个性化的功能和修改WordPress的行为。
如何使用wp_insert_post插入新的文章？
wp_insert_post() 函数用于插入新的文章。你需要传递一个关联数组，包含文章的各项参数，如标题、内容、分类等。例如：
```
$post_data = array(  
    'post_title' => '新的文章',  
    'post_content' => '这是一篇新的文章。',  
    'post_status' => 'publish', // 设置为 'publish' 以立即发布文章  
    'post_type' => 'post', // 也可以设置为 'page' 或其他自定义的文章类型  
);  
$post_id = wp_insert_post($post_data);
```
如果你想要插入更复杂的文章，例如包含多个分类或标签，你可以在 $post_data 数组中添加更多的键值对。
如何使用get_template_directory和get_stylesheet_directory获取主题的目录路径？
你可以使用 get_template_directory() 和 get_stylesheet_directory() 函数来获取当前主题的目录路径。 get_template_directory() 返回当前主题模板的目录路径，而 get_stylesheet_directory() 返回当前子主题的目录路径。例如：
```
$theme_dir = get_template_directory();  
$child_theme_dir = get_stylesheet_directory();
```

get_avatar

常见问题

相关文章