1. 首页
  2. WordPress 函数手册

get_bloginfo()

get_bloginfo( string $show = , string $filter = ‘raw’ )

检索有关当前站点的信息。
Retrieves information about the current site.

目录锚点:#说明#参数#返回#源码#笔记


说明(Description)

$show的可能值包括:

“name”-站点标题(在“设置>常规”中设置)

“说明”-站点标语(在“设置>常规”中设置)

‘wpurl’–WordPress地址(URL)(在“设置>常规”中设置)

“url”-网站地址(url)(在“设置>常规”中设置)

“管理电子邮件”-管理电子邮件(在“设置>常规”中设置)

“字符集”-“页面和源的编码”(在“设置>读取”中设置)

‘version’–当前的WordPress版本

‘html_type’–内容类型(默认值:“text/html”)。主题和插件可以使用“pre_option_html_type”过滤器覆盖默认值

“文本方向”-由网站语言决定的文本方向。应改用is_rtl()

“语言”-当前网站的语言代码

‘stylesheet_url’–活动主题的样式表的url。活动子主题将优先于此值

‘stylesheet_directory’–活动主题的目录路径。活动子主题将优先于此值

‘模板url’/’模板目录’–活动主题目录的url。活动子主题不会优先于此值

“pingback-url”–pingback XML-RPC文件url(xmlrpc.php文件)

“atom_url”–atom提要url(/feed/atom)

“rdf_url”–rdf/RSS 1.0提要url(/feed/rdf)

“rss_url”–rss 0.92提要url(/feed/rss)

‘rss2_url’–rss2.0提要url(/feed)

“comments_atom_url”–comments atom提要url(/comments/feed)

“comments_rss2_url”–comments rss2.0提要url(/comments/feed)

有些$show值已弃用,将在以后的版本中删除。这些选项将触发不推荐使用的参数函数。

不赞成的参数包括:

“siteurl”-改用“url”

“home”-改用“url”


参数(Parameters)

参数 类型 必填 说明
$show (string) 可选 要检索的网站信息。默认为空(站点名称)。
$filter (string) 可选 如何过滤检索到的内容。

返回(Return)

(string)主要是string值,可能为空。


源码(Source)

/**
 * Retrieve information about the blog.
 *
 * Some show parameter values are deprecated and will be removed in future
 * versions. These options will trigger the {@see _deprecated_argument()}
 * function. The deprecated blog info options are listed in the function
 * contents.
 *
 * The possible values for the 'show' parameter are listed below.
 *
 * 1. url - Blog URI to homepage.
 * 2. wpurl - Blog URI path to WordPress.
 * 3. description - Secondary title
 *
 * The feed URL options can be retrieved from 'rdf_url' (RSS 0.91),
 * 'rss_url' (RSS 1.0), 'rss2_url' (RSS 2.0), or 'atom_url' (Atom feed). The
 * comment feeds can be retrieved from the 'comments_atom_url' (Atom comment
 * feed) or 'comments_rss2_url' (RSS 2.0 comment feed).
 *
 * @since 0.71
 *
 * @global string $wp_version
 *
 * @param string $show   Blog info to retrieve.
 * @param string $filter How to filter what is retrieved.
 * @return string Mostly string values, might be empty.
 */
function get_bloginfo( $show = '', $filter = 'raw' ) {
	switch( $show ) {
		case 'home' : // DEPRECATED
		case 'siteurl' : // DEPRECATED
			_deprecated_argument( __FUNCTION__, '2.2', sprintf(
				/* translators: 1: 'siteurl'/'home' argument, 2: bloginfo() function name, 3: 'url' argument */
				__( 'The %1$s option is deprecated for the family of %2$s functions. Use the %3$s option instead.' ),
				'' . $show . '',
				'bloginfo()',
				'url'
			) );
		case 'url' :
			$output = home_url();
			break;
		case 'wpurl' :
			$output = site_url();
			break;
		case 'description':
			$output = get_option('blogdescription');
			break;
		case 'rdf_url':
			$output = get_feed_link('rdf');
			break;
		case 'rss_url':
			$output = get_feed_link('rss');
			break;
		case 'rss2_url':
			$output = get_feed_link('rss2');
			break;
		case 'atom_url':
			$output = get_feed_link('atom');
			break;
		case 'comments_atom_url':
			$output = get_feed_link('comments_atom');
			break;
		case 'comments_rss2_url':
			$output = get_feed_link('comments_rss2');
			break;
		case 'pingback_url':
			$output = site_url( 'xmlrpc.php' );
			break;
		case 'stylesheet_url':
			$output = get_stylesheet_uri();
			break;
		case 'stylesheet_directory':
			$output = get_stylesheet_directory_uri();
			break;
		case 'template_directory':
		case 'template_url':
			$output = get_template_directory_uri();
			break;
		case 'admin_email':
			$output = get_option('admin_email');
			break;
		case 'charset':
			$output = get_option('blog_charset');
			if ('' == $output) $output = 'UTF-8';
			break;
		case 'html_type' :
			$output = get_option('html_type');
			break;
		case 'version':
			global $wp_version;
			$output = $wp_version;
			break;
		case 'language':
			$output = get_locale();
			$output = str_replace('_', '-', $output);
			break;
		case 'text_direction':
			_deprecated_argument( __FUNCTION__, '2.2', sprintf(
				/* translators: 1: 'text_direction' argument, 2: bloginfo() function name, 3: is_rtl() function name */
				__( 'The %1$s option is deprecated for the family of %2$s functions. Use the %3$s function instead.' ),
				'' . $show . '',
				'bloginfo()',
				'is_rtl()'
			) );
			if ( function_exists( 'is_rtl' ) ) {
				$output = is_rtl() ? 'rtl' : 'ltr';
			} else {
				$output = 'ltr';
			}
			break;
		case 'name':
		default:
			$output = get_option('blogname');
			break;
	}

	$url = true;
	if (strpos($show, 'url') === false &&
		strpos($show, 'directory') === false &&
		strpos($show, 'home') === false)
		$url = false;

	if ( 'display' == $filter ) {
		if ( $url ) {
			/**
			 * Filter the URL returned by get_bloginfo().
			 *
			 * @since 2.0.5
			 *
			 * @param mixed $output The URL returned by bloginfo().
			 * @param mixed $show   Type of information requested.
			 */
			$output = apply_filters( 'bloginfo_url', $output, $show );
		} else {
			/**
			 * Filter the site information returned by get_bloginfo().
			 *
			 * @since 0.71
			 *
			 * @param mixed $output The requested non-URL site information.
			 * @param mixed $show   Type of information requested.
			 */
			$output = apply_filters( 'bloginfo', $output, $show );
		}
	}

	return $output;
}
更新版本 源码位置 使用 被使用
0.71 wp-includes/general-template.php:704 69 14

笔记(Notes)

博客标语
应该可以返回所有可用信息的数组。虽然这可能不是一个良好的做法,在性能方面,这应该有助于人谁需要获取一个网站的所有信息。注意,我省略了一些可能不那么重要的字段:
默认用法

get_bloginfo() 为WP2原创文章,链接:https://www.wp2.cn/functions/get_bloginfo/

发表评论

您的电子邮箱地址不会被公开。