WordPress主题制作中自定义头部的相关PHP函数解析

这篇文章主要介绍了WordPress主题制作中自定义头部的相关PHP函数解析,包括header_image()函数和get_custom_header()函数的用法讲解,需要的朋友可以参考下

header_image()

header_image() 函数是 WordPress 自定顶部图像的标准接口函数，该函数可以自动判断后台设置，并返回字符串形式的用户自定义顶部图像地址。本文主要涉及该函数的详解及使用。

【Display header image path.】 即，显示顶部图像地址。

使用代码如下:

1. <img src="<?php header_image(); ?>" width="<?php echo $header_image_width; ?>" height="<?php echo $header_image_height; ?>" alt="" /> 

函数声明源代码：

1. function header_textcolor() { 
2.  echo get_header_textcolor(); 
3. } 
4. function get_header_image() { 
5.  $url = get_theme_mod( 'header_image', get_theme_support( 'custom-header', 'default-image' ) ); 
6.  
7.  if ( 'remove-header' == $url ) 
8.  return false; 
9.  
10.  if ( is_random_header_image() ) 
11.  $url = get_random_header_image(); 
12.  
13.  if ( is_ssl() ) 
14.  $url = str_replace( 'http://', 'https://', $url ); 
15.  else 
16.  $url = str_replace( 'https://', 'http://', $url ); 
17.  
18.  return esc_url_raw( $url ); 
19. } 

get_custom_header 自定义顶部

get_custom_header 函数是 WordPress 3.4 送给我们的新礼物，该函数的出现是为了更好的集成和封装顶部的使用，本文主要对 get_custom_header 这个函数进行详解、以及如何在 WordPress 3.4 版本的主题中集成顶部功能。

请注意，根据本文折腾你的主题时，请确保你的 WordPress 已经升级到 3.4版本。

get_custom_header 意义详解

自定义顶部目前大部分主题主要用到的还只是两个功能 1.自定义顶部图像 2.自定义顶部样式

具体的效果你可以看一下 默认主题 twenty eleven ，或者我的另一个博客 悠悠我心

本函数是 WP 3.4 版本后才出现的一个内置函数，主要用于将用户设置的顶部的各项参数以对象（object）的形式返回。

单单说这么句屁话，也许你还不明白，想要明白的话，请往下看。

请注意本函数与get_header()有着本质的区别。

函数使用实例

下面的例子来自于 默认主题 twenty eleven 中 header.php 文件

PHP 代码：

1. //判断是否存在该函数，以便兼容老版本 
2. if ( function_exists( 'get_custom_header' ) ) { 
3. //get_custom_header()->width 调用带向 width 属性 
4. $header_image_width = get_custom_header()->width; 
5. //get_custom_header()->height 调用带向 height 属性 
6. $header_image_height = get_custom_header()->height; 
7. } else {//兼容老版本的代码 
8. $header_image_width = HEADER_IMAGE_WIDTH; 
9. $header_image_height = HEADER_IMAGE_HEIGHT; 
10. } 

综合使用详解

以下主要援引官方文档解释 自定义顶部

1. //打开主题自定义顶部支持 
2. add_theme_support( 'custom-header' ); 
3.  
4. $headarg = array(//将设置打包成数组 
5.  'default-image'     => '', 
6.  'random-default'     => false, 
7.  'width'         => 0, 
8.  'height'         => 0, 
9.  'flex-height'      => false, 
10.  'flex-width'       => false, 
11.  'default-text-color'   => '', 
12.  'header-text'      => true, 
13.  'uploads'        => true, 
14.  'wp-head-callback'    => '', 
15.  'admin-head-callback'  => '', 
16.  'admin-preview-callback' => '', 
17. ); 
18. //将数组中的设置添加到自定义顶部上 
19. add_theme_support( 'custom-header', $headarg ); 
20. 自定义顶部图像 
21. //打开主题自定义顶部支持 
22. add_theme_support( 'custom-header' ); 
23.  
24. $headarg = array(//将设置打包成数组 
25.  'default-image'     => '', 
26.  'random-default'     => false, 
27.  'width'         => 0, 
28.  'height'         => 0, 
29.  'flex-height'      => false, 
30.  'flex-width'       => false, 
31.  'default-text-color'   => '', 
32.  'header-text'      => true, 
33.  'uploads'        => true, 
34.  'wp-head-callback'    => '', 
35.  'admin-head-callback'  => '', 
36.  'admin-preview-callback' => '', 
37. ); 
38. //将数组中的设置添加到自定义顶部上 
39. add_theme_support( 'custom-header', $headarg ); 
40. 自适应顶部图像设置 
41. $args = array( 
42.  'flex-width'  => true,//自适应高度 
43.  'width'     => 980, 
44.  'flex-width'  => true,//自适应宽度 
45.  'height'    => 200, 
46.  'default-image' => get_template_directory_uri() . '/images/header.jpg', 
47. ); 
48. add_theme_support( 'custom-header', $args ); 

自定义顶部图像的调用

1. <img  
2.   src="<?php header_image(); ?>"  
3.   height="<?php echo get_custom_header()->height; ?>"  
4.   width="<?php echo get_custom_header()->width; ?>"  
5.   alt=""  
6. />