Wordpress

Wordpress主题核心知识点梳理

内容类型和分类方式

  • Debug Bar插件
    • Queries
    • WP Query
    • Object Cache
    • Post Types
  • Post Type 内容类型
  • Taxonomy 分类方式
    • category 分类目录
    • post_tag 标签
    • Debug Bar Taxonomy插件可以查看所有分类方式

最小主题

  • style.css

必填字段: Theme Name、Author、Description、Version、License、License URI、Text Domain

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

/* 
Theme Name: Mini Theme
Theme URI: 主题的详细介绍的网址，仅在官方主题库中才会用到
Author: Hollis
Author URI: http://www.1024plus.com
Description: 最小主题
Version: 1.0.0
License: 主题的版权信息
License URI: 版权详情网址
Text Domain: 国际化相关
Tags: 标签，方便用于在官方主题库中筛选
Domain Paths: 语言包路径
*/
  • index.php

详情页模板层级

文章详情页 

1
2
3
4
5

$custom.php
single-post.php
single.php
singular.php
index.php

附件详情页

wp_posts表中post_mime_type记录了attachment的mimetype

如：image/png，其中mimetype是image，subtype是png

上传附件可能有大小限制，可以修改php.ini中的post_max_size

1
2
3
4
5
6
7

$mimetype-$subtype.php
$subtype.php
$mimetype.php
attachment.php
single.php
singular.php
index.php

自定义内容类型详情页 

1
2
3
4
5
6

$custom.php
single-$posttype-$slug.php
single-$posttype.php
single.php
singular.php
index.php

页面详情页

  • Custom Template 采用了自定义模板
1

$custom.php

如果页面对应的自定义模板被删除了，但是数据中的对应关系还在，则按以下规则加载模板

1
2
3

page.php
singular.php
index.php
  • Default Template 采用了默认模板
1
2
3
4
5

page-$slug.php
page-$id.php
page.php
singular.php
index.php

自定义模板文件

Template Post Type 可以为空，默认只支持page

1
2
3
4
5
6
7

<?php
/* 
Template Name: 自定义模板
Template Post Type: post,page,product
*/
    
?>

分类目录归档页

Category Archice 

1
2
3
4
5

category-$slug.php
category-$id.php
category.php
archive.php
index.php

Tag Archive 

1
2
3
4
5

tag-$slug.php
tag-$id.php
tag.php
archive.php
index.php

Author Archive 

1
2
3
4
5

author-$nicename.php
author-$id.php
author.php
archive.php
index.php

Date Archive (Year Archive、Month Archive、Day Archive)

可以通过小工具，进入到日期归档页

1
2
3

date.php
archive.php
index.php

自定义内容归档页(custom post type) 

1
2
3

archive-$posttype.php
archive.php
index.php

自定义分类方式归档页(custom taxonomy)

如：自定义产品分类product_cat，其中有phone、pc两个分类项目，则$taxonomy为product_cat、$term为phone和pc

1
2
3
4
5

taxonomy-$taxonomy-$term.php
taxonomy-$taxonomy.php
taxonomy.php
archive.php
index.php

站点首页模板层级

  • Posts show on front（默认设置）
1
2
3

front-page.php
home.php
index.php
  • Page show on front（一个静态页面）
1
2

front-page.php
后面的模板层级和页面详情页一致
  • Blog Post Index Page(指定为文章页的页面)
1
2

home.php
index.php

404错误页、搜索结果页、被嵌入内容页

  • 404错误页
1
2

404.php
index.php
  • 搜索结果页
1
2

search.php
index.php

归档页默认查询结果

分类目录归档页

  • queried_object (WP_Term) 分类目录信息 - 日期分类归档页没有queried_object字段
  • queried_object_id 分类目录id
  • posts 归档页的文章信息数组
  • post (WP_Post) 当前文章信息
  • is_archive = 1 归档页
  • is_category = 1 分类目录归档页

详情页默认查询结果

文章详情页

  • queried_object 文章信息
  • queried_object_id 文章id
  • posts 数组里面只有一个文章信息
  • post 当前文章信息
  • is_single = 1 内容详情页
  • is_singular = 1 详情页

首页和其他页面默认查询结果

首页（默认）

  • posts 最新发布的文章信息数组
  • post 当前文章信息
  • is_home = 1

首页（设置了自定义页面）

  • posts 自定义页面的信息，数组只有一个元素
  • post 自定义页面的信息
  • queried_object 自定义页面的信息
  • queried_object_id 自定义页面id
  • is_page = 1
  • is_singular = 1 详情页

Blog文章索引页（就是在阅读设置中，文章页指定了自定义页面）

  • queried_object 自定义页面的信息
  • queried_object_id 自定义页面id
  • posts 最新发布的文章信息数组
  • post 当前文章信息
  • is_home = 1
  • is_posts_page = 1

搜索结果页

  • posts 搜索结果的所有文章信息数组
  • post 当前文章信息
  • is_search = 1

404错误页

  • is_404 = 1

获取文章各种数据的模板标签

  • 获取内容并输出
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

//文章ID
the_ID();
//文章标题
the_title();
//文章内容
the_content();
//文章摘要。如果没有设置摘要，会自动截取一部分内容作为摘要
the_excerpt();
//获取作者信息
the_author();
//获取文章的网址
the_permalink();
//发布时间。
//时间格式可以在设置->常规中设置
//也可以指定格式the_time('Y-m-d H:i:s');
the_time();
  • 获取内容
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

//文章ID
get_the_ID();
//文章标题
get_the_title();
//文章内容
get_the_content();
//文章摘要。如果没有设置摘要，会自动截取一部分内容作为摘要
get_the_excerpt();
//获取作者信息
get_the_author();
//作者归档页超链接。用户名+超链接
get_the_author_link();
//获取文章别名。自带了urlencode。使用的时候需要urldecode
global $post;
$post->post_name;
//获取文章的网址
get_the_permalink();
//发布时间。
//时间格式可以在设置->常规中设置
//也可以指定格式get_the_time('Y-m-d H:i:s');
get_the_time();
//获取文章评论数量
get_comments_number();

获取文章所属的分类目录信息

  • the_category 获取内容并输出
  • get_the_category_list 获取内容
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

/**
 * @param string $separator 默认以⽆序列表输出分类链接，当⽂章指定了多个分类时，提供⼀个字符⽤于分隔这些分类链接。
 * @param string $parents  
    ''：不显示父类信息；
    'multiple'：显示父类信息，分开显示(有各自的超链接)；
    'single'：显示父类信息，与子类合并显示(公用一个超链接)
 * @param int    $post_id   在have_posts() 循环中使用时，不要传值，否则需要传入指定post_id
 * 
 * 例子: 
 * the_category(',', 'multiple');
 * 输出：<a href="#">体育</a>,<a href="#">篮球</a>
 * the_category(',', 'single');
 * 输出：<a href="#">体育,篮球</a>
 * 
 */
function the_category( $separator = '', $parents = '', $post_id = false ) {
	echo get_the_category_list( $separator, $parents, $post_id );
}
  • get_the_category（纯数据，不带html标签）
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

/**
* WP_Term Object
*
* term_id 分类ID
* name 分类名称
* slug 分类别名
* description 分类描述
* taxonomy 分类项目的分类方式 category
* ......
*/

$categorys = get_the_category();
foreach ($categorys as $category) {
	<p>编号：<?php echo $category->term_id; ?></p>
    <p>名称：<?php echo $category->name; ?></p>
    <p>别名：<?php echo $category->slug; ?></p>
    <p>描述：<?php echo $category->description; ?></p>
    <p>⽹址：<?php echo get_category_link($category); ?></p>
}

获取文章所属标签信息

  • the_tags 获取标签并输出
  • get_the_tag_list 获取标签
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

/**
 * @param string $before 标签链接前的内容
 * @param string $sep    多个标签之间的分隔符，默认为',' 
 * @param string $after  标签链接后的内容
 */
function the_tags( $before = null, $sep = ', ', $after = '' ) {
	if ( null === $before ) {
		$before = __( 'Tags: ' );
	}

	$the_tags = get_the_tag_list( $before, $sep, $after );

	if ( ! is_wp_error( $the_tags ) ) {
		echo $the_tags;
	}
}

/**
 * $post_id 文章id
 */
function get_the_tag_list( $before = '', $sep = '', $after = '', $post_id = 0 )
  • get_the_tags（纯数据，不带html标签）
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

/**
* WP_Term Object
*
* term_id 分类ID
* name 分类名称
* slug 分类别名
* description 分类描述
* taxonomy 分类项目的分类方式 post_tag
* ......
*/

$posttags = get_the_tags();
if ($posttags) foreach($posttags as $tag) {
    echo '标签ID：' . $tag->term_id;
    echo '<br />标签名称：' . $tag->name;
    echo '<br />标签描述：' . $tag->description;
    echo '<br />标签网址：' . get_tag_link($tag);
}

分类归档页中调用和显示数据

Category Archive 分类目录归档页 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

//获取分类目录信息
$category = get_queried_object();
<p>编号：<?php echo $category->term_id; ?></p>
<p>名称：<?php echo $category->name; ?></p>
<p>别名：<?php echo $category->slug; ?></p>
<p>描述：<?php echo $category->description; ?></p>
<p>⽹址：<?php echo get_category_link($category); ?></p>
    
//获取分类目录下面的文章信息
<?php if( have_posts() ): ?>
<?php while( have_posts() ): the_post(); ?>
<?php the_author(); //作者名称 ?>
<?php the_title(); //标题 ?>
<?php the_content(); //正文 ?>
<?php echo get_comments_number(); //评论数量 ?>
<?php endwhile; ?>
<?php endif; ?>

Tag Archive 标签归档页 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

//获取标签信息
$tag = get_queried_object();
<p>编号：<?php echo $tag->term_id; ?></p>
<p>名称：<?php echo $tag->name; ?></p>
<p>别名：<?php echo $tag->slug; ?></p>
<p>描述：<?php echo $tag->description; ?></p>
<p>⽹址：<?php echo get_tag_link($tag); ?></p>
    
//获取标签目录下面的文章信息
<?php if( have_posts() ): ?>
<?php while( have_posts() ): the_post(); ?>
<?php the_author(); //作者名称 ?>
<?php the_title(); //标题 ?>
<?php the_content(); //正文 ?>
<?php echo get_comments_number(); //评论数量 ?>
<?php endwhile; ?>
<?php endif; ?>

Author Archive 作者归档页 

1
2
3
4
5
6
7
8
9

//获取作者信息
$author = get_queried_object();
<p>作者用户名：<?php echo $author->user_login; ?></p>
<p>作者ID：<?php echo $author->ID; ?></p>
<p>作者邮箱：<?php echo $author->user_email; ?></p>
<p>作者显示名：<?php echo $author->user_display; ?></p>
<p>作者归档页网址：<?php echo get_the_author_posts_link(); ?></p>
    
//获取文章信息同上

Date Archive 日期归档页 

1
2
3
4
5
6
7

//日期归档页无法获取get_queried_object
//获取日期信息
echo get_the_date();
//可以自定义日期格式
echo get_the_date('Y-d-m');
    
//获取文章信息同上

通用获取分类title 

1
2
3
4

//直接使用
the_archive_title();
//或者
echo get_the_archive_title();

搜索结果归档页 

1
2
3
4
5

//日期归档页无法获取get_queried_object
//获取搜索结果页搜索关键字
$key = get_search_query();
    
//获取文章信息同上

模板标签所在的文件

模板标签所在的文件，都有一个相同的后缀*-template.php，用于区分模板文件和其他文件。

总共有9个模板文件：

1
2
3
4
5
6
7
8
9

wp-includes/general-template.php
wp-includes/author-template.php
wp-includes/bookmark-template.php
wp-includes/category-template.php
wp-includes/comment-template.php
wp-includes/link-template.php
wp-includes/post-template.php
wp-includes/post-thumbnail-template.php
wp-includes/nav-menu-template.php

条件标签使用举例 

1
2
3
4
5
6
7
8
9

<?php
  if (is_year()) {
      echo get_the_date('Y');
  } elseif (is_month()) {
      echo get_the_date('Y-m');
  } elseif (is_day()) {
      echo get_the_date('Y-m-d');
  }
?>

首页相关条件标签

  • is_home
  • is_front_page

如果首页采用了默认页面，则：

1
2

is_home: true
is_front_page: true

如果首页设置了指定页面，则：

1
2

is_home: false
is_front_page: true

获取其他信息

获取站点信息

  • 关键函数
1
2
3
4
5
6
7

/**
 * @see get_bloginfo() For possible `$show` values
 * @param string $show Optional. Site information to display. Default empty.
 */
function bloginfo( $show = '' ) {
	echo get_bloginfo( $show, 'display' );
}
  • 通用信息
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

//站点标题
get_bloginfo('name');
get_bloginfo('blogname');
//站点描述
get_bloginfo('description');
//站点首页网址，等同于site_url()
get_bloginfo('wpurl');
//站点首页网址，等同于home_url()
get_bloginfo('url');
//站点管理员邮箱
get_bloginfo('admin_email');

评论信息 

1
2
3
4
5
6

<?php
if (comments_open() || get_commments_number()) {
    //如果文章允许评论被关闭，则只显示历史评论列表，不显示评论发表框
    comments_template();
}
?>

主题路径及url信息 

1
2
3
4

//获取当前主题所在目录的网址
get_theme_file_uri()
//获取当前主题所在目录的绝对路径
get_theme_file_path()

钩子机制

  • 动作钩子
1

add_action('hook_name', 'your_func');
  • 过滤器钩子
1

add_filter('hook_name', 'your_func');

传统引入css和js文件的方式

  • 内联
1

<div style="width: 65px;height: 20px;border: 1px solid;">测试元素</div>
  • 页联
1
2
3
4
5
6
7
8

<style type="text/css">
div {
    width: 65px;
    height: 20px;
    border: 1px solid;
    background: greenyellow;
}
</style>
  • 外联
1

<link rel="stylesheet" type="text/css" href="*.css" />

推荐的引入css和js文件的方式

引入css文件 

1
2
3
4
5
6
7
8
9

/**
 * 引入css文件
 * @param string           $handle Name of the stylesheet. Should be unique.
 * @param string           $src    
 * @param string[]         $deps   
 * @param string|bool|null $ver    
 * @param string           $media  
 */
function wp_enqueue_style( $handle, $src = '', $deps = array(), $ver = false, $media = 'all' )

引入js文件 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

/**
 * 引入js文件 wp 6.3.0版本之后，$in_footer参数改成了$args
 * @since 6.3.0 The $in_footer parameter of type boolean was overloaded to be an $args parameter of type array.
 * @param string           $handle    Name of the script. Should be unique.
 * @param string           $src       Default empty.
 * @param string[]         $deps      
 * @param string|bool|null $ver       
 * @param array|bool       $args     {
 *     Optional. An array of additional script loading strategies. Default empty array.
 *     Otherwise, it may be a boolean in which case it determines whether the script is printed in the footer. Default false.
 *
 *     @type string    $strategy     Optional. If provided, may be either 'defer' or 'async'.
 *     @type bool      $in_footer    Optional. Whether to print the script in the footer. Default 'false'.
 * }
 */
function wp_enqueue_script( $handle, $src = '', $deps = array(), $ver = false, $args = array() )

使用案例 

1
2
3
4

add_action('wp_enqueue_scripts', function () {
    wp_enqueue_style('common-style', get_theme_file_uri() . '/css/commom.css');
    wp_enqueue_script('commmon-js', get_theme_file_uri() . '/js/common.js', array(), '', true);
})

模板文件拆分和引入

  • 传统的引入方式
1
2
3

include 'template-part.php';
//or
require 'template-part.php';
  • wp推荐方式
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

//加载任意模板文件
get_template_part('template-part');

//加载主题中header.php or header-$name.php

get_header($name = '')

//加载主题中footer.php or footer-$name.php

get_footer($name = '')

//加载主题中sidebar.php or sidebar-$name.php

get_sidebar($name = '')

分页导航

内容分页 

1
2
3

//1.手动插入分页符
//2.通过wp_link_pages()显示页码
wp_link_pages();

关联分页

  • 获取上一篇文章链接
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

/**
 * @see get_previous_post_link()
 *
 * @param string       $format         Optional. Link anchor format. Default '&laquo; %link'.
 * @param string       $link           Optional. Link permalink format. Default '%title'.
 * @param bool         $in_same_term   Optional. Whether link should be in the same taxonomy term.
 *                                     Default false.
 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
 *                                     Default empty.
 * @param string       $taxonomy       Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
 */
function previous_post_link( $format = '&laquo; %link', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )
  • 获取下一篇文章链接
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

/**
 * @see get_next_post_link()
 *
 * @param string       $format         Optional. Link anchor format. Default '&laquo; %link'.
 * @param string       $link           Optional. Link permalink format. Default '%title'.
 * @param bool         $in_same_term   Optional. Whether link should be in the same taxonomy term.
 *                                     Default false.
 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
 *                                     Default empty.
 * @param string       $taxonomy       Optional. Taxonomy, if `$in_same_term` is true. Default 'category'.
 */
function next_post_link( $format = '%link &raquo;', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' )
  • 使用举例
1
2
3
4
5
6
7
8
9

<?php if (have_posts()) :?>
    <?php while (have_posts()) : the_post(); ?>
        <?php the_content(); ?>
        <?php wp_link_pages(); ?>
    <?php endwhile; ?>
<?php endif; ?>

<?php previous_post_link('上⼀篇：%link'); ?>
<?php next_post_link('下⼀篇：%link'); ?>

列表分页

  • 简单分页
 1
 2
 3
 4
 5
 6
 7
 8
 9
10

<div>
<p>分别获取上⼀⻚和下⼀⻚的链接</p>
<?php previous_posts_link(); ?>
<?php next_posts_link(); ?>
</div>
    
<div>
<p>同时获取上下⻚的链接</p>
<?php posts_nav_link(); ?>
</div>
  • 数字分页
1
2
3
4
5
6
7

<div>
<p>推荐的数字分⻚函数执⾏的效果</p>
<?php the_posts_pagination(); ?>
</div>
    
//wp 4.1之前的方式
<?php echo paginate_links(); ?>

开启自动生成页面标题功能 

1
2
3
4
5

add_action('after_setup_theme', function () {
    add_theme_support('title-tag');
});

//通过wp_head();触发显示

导航菜单功能 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

//1.主题的functions.php中注册菜单
add_action('after_setup_theme', function () {
    //注册导航菜单，用于关联后台设置的菜单，这里nav-1相当于一个标识符，和前台wp_nav_menu的theme_location对应
    register_nav_menus([
        'nav-1' => '顶部导航'
    ]);
})
    
//2.前台显示菜单
<?php 
wp_nav_menu([
    'theme_location' => 'nav-1'
]);    
?>

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

$defaults = array(
    'theme_location' => '', //调⽤菜单的名称，名称是你⾃⼰注册菜单的时候⾃定义的
    'menu' => '', //使⽤导航菜单的名称调⽤菜单，可以是 ID、别名和名字（按顺序匹配）
    'container' => 'div', //最外层容器的标签，只⽀持 div 和 nav 标签
    'container_class' => '', //外层容器的class
    'container_id' => '', //外层容器的 ID
    'menu_class' => 'menu', //ul ⽗节点的 class 属性
    'menu_id' => '', //ul ⽗节点的 id 属性
    'echo' => true, //布尔值，是否输出菜单，为false是可以⽤于赋值
    'fallback_cb' => 'wp_page_menu', //当前设置的菜单不存在时，显⽰此处设置的菜单
    'before' => '', //显⽰在每个菜单链接前的⽂本
    'after' => '', //显⽰在每个菜单链接后的⽂本
    'link_before' => '', //显⽰在每个菜单链接⽂本前的⽂本
    'link_after' => '', //显⽰在每个菜单链接⽂本后的⽂本
    'items_wrap' => '<ul class="%1$s" id="%2$s">%3$s </ul>', //菜单的输出结构，
    'depth' => 0, //显⽰菜单深度，0为显⽰所有
    'walker' => '' //菜单的结构对象 通过改参数可以制作任意结构的导航菜单
);
wp_nav_menu( $defaults);

边栏工具功能

开启边栏工具 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

add_action('widgets_init', function () {
    register_sidebar([
        'name' => '边栏1',
        //⼩⼯具的区域名称，默认是 'sidebar' 加 数字 ID,如：sidebar-1
        'id'=> 'footer_area_one',
        //区域的ID，默认是⼀个⾃动递增的数字 ID
        'description'=> '第1个边栏',
        //区域的描述，默认为空
        'before_widget' => '<section id="%1$s" class="%2$s widget">',
        //区域的内容前的HTML代码，默认： ''）
        'after_widget'=> '',
        //区域内容后的HTML代码，默认： "\n"
        'before_title'=> '',
        //区域标题前的HTML代码，默认：
        'after_title'=> '',
        //区域标题后的HTML代码，默认："\n"
    ]);
});

前台显示指定边栏 

1
2
3

<ul class="sidebar">
<?php dynamic_sidebar('sidebar-1'); //通过id获取指定边栏信息 ?>
</ul>

判断边栏内是否包含小工具

  • is_active_sidebar()
1
2
3
4
5

<?php if(is_active_sidebar('left-sidebar')):?>
<ul class="sidebar">
<?php dynamic_sidebar('left-sidebar'); ?>
</ul>
<?php endif;?>

特色图像功能

开启特色图像 

1
2
3

add_action('after_setup_theme', function () {
    add_theme_support('post-thumbnails');
});

获取特色图像 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

/**
 * @see get_the_post_thumbnail()
 *
 * @param string|int[] $size Default 'post-thumbnail'. 
 * 系统内置的$size有 thumbnail：缩略图; meduim：中图; large：大图; full：原图
 * 如果$size的尺寸找不到，则显示full原图.
 * @param string|array $attr Optional. Query string or array of attributes. Default empty.
 */
function the_post_thumbnail( $size = 'post-thumbnail', $attr = '' ) {
	echo get_the_post_thumbnail( null, $size, $attr );
}

定义更多图像尺寸 

1
2
3
4
5
6
7
8
9

add_action('after_setup_theme', function () {
    add_theme_support('post-thumbnails');
    
    //post-thumbnail尺寸默认是不存在的，可以通过代码设置
	set_post_thumbnail_size(100, 100, true);
    
    //新增自定义尺寸
    add_image_size('category-thumbnail', 50, 50);
});

常用函数 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

//获取图片说明信息
the_post_thumbnail_caption();

//判断文章是否包含特色图片
has_post_thumbnail();

//获取特色图像id
get_the_post_thumbnail_id();

//获取特色图像链接
get_the_post_thumbnail_url();

自定义栏目功能

后台设置

获取自定义栏目信息 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

/**
 * @param int    $post_id Post ID.
 * @param string $key     Optional. The meta key to retrieve. By default,
 *                        returns data for all keys. Default empty.
 * @param bool   $single  Optional. Whether to return a single value.
 *                        This parameter has no effect if `$key` is not specified.
 *                        Default false.
 */
function get_post_meta( $post_id, $key = '', $single = false ) {
	return get_metadata( 'post', $post_id, $key, $single );
}
  • 使用示例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

<?php if( have_posts() ): ?>
<?php while( have_posts() ): the_post(); ?>
<div>
<strong>⽂章相册信息（⾃定义的）：get_post_meta</strong>
<?php print_r( get_post_meta( get_the_ID(), 'gallary_img', false ) ); ?>
</div>
<div>
<strong>⽂章价格信息（⾃定义的）：get_post_meta</strong>
<strong>因为价格信息就1个值，通过第3个个参数可以直接获取到值</strong>
<?php print_r( get_post_meta( get_the_ID(), 'price', true ) ); ?>
</div>
<div>
<strong>⽂章价格信息（⾃定义的）：get_post_meta</strong>
<?php print_r( get_post_meta( get_the_ID(), 'price' ) ); ?>
</div>
<?php endwhile; ?>
<?php endif; ?>

通过代码设置

  • 添加add_post_meta
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

/**
 * @param int    $post_id    Post ID.
 * @param string $meta_key   Metadata name.
 * @param mixed  $meta_value Metadata value. Must be serializable if non-scalar.
 * @param bool   $unique     Optional. Whether the same key should not be added.
 *                           Default false.
 * @return int|false Meta ID on success, false on failure.
 */
function add_post_meta( $post_id, $meta_key, $meta_value, $unique = false ) {
	// Make sure meta is added to the post, not a revision.
	$the_post = wp_is_post_revision( $post_id );
	if ( $the_post ) {
		$post_id = $the_post;
	}

	return add_metadata( 'post', $post_id, $meta_key, $meta_value, $unique );
}
  • 更新update_post_meta，不存在则新增
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

/**
 * @param int    $post_id    Post ID.
 * @param string $meta_key   Metadata key.
 * @param mixed  $meta_value Metadata value. Must be serializable if non-scalar.
 * @param mixed  $prev_value Optional. Previous value to check before updating.
 *                           If specified, only update existing metadata entries with
 *                           this value. Otherwise, update all entries. Default empty.
 * @return int|bool Meta ID if the key didn't exist, true on successful update,
 *                  false on failure or if the value passed to the function
 *                  is the same as the one that is already in the database.
 */
function update_post_meta( $post_id, $meta_key, $meta_value, $prev_value = '' ) {
	// Make sure meta is updated for the post, not for a revision.
	$the_post = wp_is_post_revision( $post_id );
	if ( $the_post ) {
		$post_id = $the_post;
	}

	return update_metadata( 'post', $post_id, $meta_key, $meta_value, $prev_value );
}
  • 删除delete_post_meta
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

/**
 * @param int    $post_id    Post ID.
 * @param string $meta_key   Metadata name.
 * @param mixed  $meta_value Optional. Metadata value. If provided,
 *                           rows will only be removed that match the value.
 *                           Must be serializable if non-scalar. Default empty.
 * @return bool True on success, false on failure.
 */
function delete_post_meta( $post_id, $meta_key, $meta_value = '' ) {
	// Make sure meta is deleted from the post, not from a revision.
	$the_post = wp_is_post_revision( $post_id );
	if ( $the_post ) {
		$post_id = $the_post;
	}

	return delete_metadata( 'post', $post_id, $meta_key, $meta_value );
}

隐藏的自定义栏目，后台无法设置 

1
2
3

//下滑线开头的字段，后台不展示，用户无法设置
add_post_meta($post_id, '_myKey', '隐藏的值');
get_post_meta($post_id, '_mykey', true);

常用功能

设置浏览次数

  • 定义函数

通过 隐藏的(下划线开头的key)自定义栏目实现浏览次数。functions.php中定义以下函数：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

/**
 * 设置⽂章/⻚⾯ 浏览次数
 * _wphollis_postviews是⾃定义栏⽬的名字
 * @param int $post_id ⽂章的ID编号
 */
function wphollis_set_postviews($post_id) {
    // 详情⻚才处理
    if ( is_singular() && ! empty( $post_id ) ) {
        $views = get_post_meta($post_id, '_wphollis_postviews', true);
        $views = ! empty( $views ) ? $views : 0;
        $views++;
        update_post_meta($post_id, '_wphollis_postviews', $views);
    }
}

/**
 * 获取⽂章/⻚⾯ 浏览次数
 * @param int ⽂章的ID编号
 * @return int 浏览次数
 */
function wphollis_get_postviews( $post_id ) {
    if ( ! empty( $post_id ) ) {
        $views = get_post_meta($post_id, '_wphollis_postviews', true);
        $views = ! empty( $views ) ? (int)$views : 0;
        return $views;
    }
}
  • 前台使用 （在内容详情页中添加以下代码）
1
2
3
4
5
6
7
8

<?php wphollis_set_postviews(get_queried_object_id());//更新文章浏览次数 ?>

<?php if (have_posts()) :?>
    <?php while (have_posts()) : the_post(); ?>
        <?php the_title(); ?>
        <?php wphollis_get_postviews(get_the_ID());//获取文章浏览次数 ?>
    <?php endwhile; ?>
<?php endif; ?>

获取当前用户访问的网页网址

在当前主题functions.php文件中定义以下函数：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

/**
 * 获取⽤⼾当前访问的⽹址
 */
function wphollis_get_current_url() {
    global $wp, $wp_rewrite;
    // 获取重写规则，朴素模式规则为空
    $rewrite = $wp_rewrite->wp_rewrite_rules();
    // ⾮朴素模式下，返回当前⽹址
    if ( !empty($rewrite) ) {
    return home_url( $wp->request );
    }
    // 在朴素模式下，返回当前⽹址
    return home_url( '?' . $wp->query_string );
}

正文自动截取

在当前主题functions.php文件中定义以下函数：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

/**
 * @params $len 要截取的字符长度
 * @params $suffix 后缀标记
 *
 */
function hollis_strim_post_content($len = 100, $suffix = '...') {
    //获取正文信息，并做必要处理
    $content = get_the_content();
    //这里触发the_content的钩子，执行挂载该钩子的所有方法
    //这里不写这个语句也可以，但是为了兼容wp的扩展性要求加上
    $content = apply_filters('the_content', $content);
    $content = str_replace(']]>', ']]&gt;', $content);
    
    //去除正文中的HTML标签
    $content = strip_tags($content);
    
    if (mb_strlen($content) <= $len) {
        //字符数量少于要截取的长度，则展示全部
        return $content;
    } else {
        return $content = mb_substr($content, 0, $len) . $suffix;
    }
}

给嵌套评论添加回复关系信息

原理就是通过get_comment_author_link钩子，把评论者的link扩展成带回复关系的两个link

在当前主题functions.php文件中定义以下函数：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

/**
 * 增加谁回复谁
 * 所有⽤到的钩⼦信息⸺
 * apply_filters( 'get_comment_author_link', $return, $author, $comment->comment_ID );
 * @param string $out 未修改的评论数据，即wordpress默认提供的数据
 * @param int $comment_id 评论的编号
 * @return string
 */
function wphollis_who_resp_who($out, $author, $comment_id) {
    $comment = get_comment($comment_id);
    // 如果没有⽗级评论，则正常返回，因为没有回复关系
    if ( empty($comment->comment_parent) ) {
   		return $out;
	}
    /**
     * 如果有⽗级评论，则添加回复关系
     */
    // 获取⽗（原）评论
    $parent = get_comment($comment->comment_parent);
    // 获取⽗（原）评论作者
    $pauthor = get_comment_author($parent);
    // 构件回复关系
    $pcid = '#comment-' . $parent->comment_ID;
    $new = $out . ' 回复 '. "<a href='{$pcid}'>{$pauthor}</a>";
    // 返回修改后的评论数据
    return $new;
}
add_filter('get_comment_author_link', 'wphollis_who_resp_who', 10, 3);

解决评论模板notice提示

调用comments_template()方法的时候，wp会优先查找当前主题下有没有comments.php文件，如果没有则采用wp自带的模板wp-includes/theme-compat/comments.php

修改菜单输出结构

    1. 添加并定义⼀个⾃定义函数⽂件（名称随意）：class-my-nav-walker.php
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

class wphollis_Nav_Walker extends Walker_Nav_Menu {
    /**
    * 修改⼆级菜单
    */
    public function end_lvl( &$output, $depth = 0, $args = array() ) {
        if ( isset( $args->item_spacing ) && 'discard' === $args->item_spacing ) {
            $t = '';
            $n = '';
        } else {
            $t = "\t";
            $n = "\n";
        }
        $indent = str_repeat( $t, $depth );
        $suffix = '<span class="fa fa-angle-down"></span>'; // 添加的按钮对应的HTML
        $output .= "$indent</ul>{$suffix}{$n}";
    }
}
    1. 在funcitons.php中加载这个类
1
2
3

add_action('after_setup_theme', function () {
    include get_theme_file_path() . '/inc/class-my-nav-walker.php';
});
    1. 前台页面中调用菜单
1
2
3
4
5
6
7

<?php 
wp_nav_menu([
    'theme_location' => 'nav-1',
    'walker' => new wphollis_Nav_Walker()
]);

?>

实战案例

导入测试数据

下载好 xml的数据⽂件, 在 后台 ⼯具 —-> 导⼊ —-> WordPress导⼊器安装 —-> 选择xml⽂件导⼊数

据

开启所需功能并引入所需的样式文件

functions.php文件中定义：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

add_action('after_setup_theme', function () {
    // 开启⻚⾯标题功能
    add_theme_support('title-tag');
    
    // 开启特色图像
    add_theme_support('post-thumbnails');
    
    // 定义导航菜单
    register_nav_menus([
        'header_menu' => '顶部导航',
        'footer_menu' => '底部导航',
    ]);
});

// 定义边栏
add_action('widgets_init', function () {
    register_sidebar([
        'name' => '边栏1',
        'id' => 'sidebar1',
        'decsription' => '边栏1',
    ]);
});

// 引入所需的样式文件
add_action('wp_enqueue_scripts', function () {
    wp_enqueue_style('main-css', get_theme_file_uri() . '/main.css', [], '1.0');
    wp_enqueue_script('main-js', get_theme_file_uri() . '/main.js', [], '1.0');
});

获取登录和注册的URL

  • 注册地址
1

wp_registration_url();
  • 登录地址
1

wp_login_url(wphollis_get_current_url());

获取文章作者 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

// 获取文章作者归档页。 作者名称+链接
get_the_author_posts_link();

// 获取文章作者归档页url
get_author_posts_url();

// 获取作者id
get_the_author_meta('ID');
    
// 获取用户头像。get_avatar($id_or_email, $size);
get_avatar(get_the_author_meta('ID'), 24);

回复评论，不刷新定位到回复框

在functions.php中添加：

1
2
3
4
5

//（是否是详情页 && ⽂章是否开启评论 && 后台是否开启嵌套评论）
// 调取官⽅原⽣回复评论跳转函数
if(is_singular() && comments_open() && get_option('thread_comments')){
	wp_enqueue_script('comment-reply');
}

设置wp指定的class属性值

  • 在body ⾥⾯设置class属性值
1

<body <?php body_class() ?> >
  • 在article ⾥⾯设置class属性值
1

<article <?php post_class() ?> >

归档页标题调取以及获取文章的缩略图 

1
2
3
4
5
6

<!-- 归档页标题 -->
<header class="list-header">
    <h1>
        <span><?php the_archivce_title(); ?></span>
    </h1>
</header>

1
2
3
4
5
6
7
8

<!-- 获取文章缩略图 -->
<a href="<?php the_permalink() ?>">
	<?php if (has_post_thumbnail()) : ?>
    <?php the_post_thumbnail('thumbnail'); ?>
    <?php else : ?>
    <img src="<?php echo get_theme_file_uri(); ?>/default.png">
    <?php endif; ?>
</a>

首页模板文件开发 

1
2
3
4
5
6
7
8
9

<!-- 判断置顶⽂章显⽰ is_sticky()-->
<?php if(is_sticky()) :?>
<span class="sticky">置顶</span>
<?php endif; ?>

<!--调取分⻚-->
<div class="posts-nav">
<?php echo the_posts_pagination(); ?>
</div>
© 2024 - 2025 Hollis Ho
使用 Hugo 构建
主题 Stack 由 Jimmy 设计