WordPress 自定义文章类型终极教程

如何在 WordPress 中创建和管理自定义文章类型的综合教程。

本文章介绍了如何使用 `register_post_type()` 函数来定义自定义文章类型的各种参数,包括公开性、搜索可见性、菜单和工具条显示、权限控制等。

它还涵盖了自定义文章类型的 URL 结构、支持的功能和标签等设置。 本教程详细解释了每个参数的作用和可选值,并提供了示例代码和说明,帮助读者理解如何根据自己的需求创建自定义文章类型。通过本教程,读者将学会创建自定义文章类型,并在 WordPress 后台轻松管理和发布属于该类型的文章。

无论您是 WordPress 开发人员、网站管理员还是有兴趣扩展 WordPress 功能的用户,本教程都将为您提供全面的指导,让您能够灵活地利用自定义文章类型来满足网站的需求。

<?php
 
# 在 'init' 钩子上注册自定义文章类型.
add_action('init', 'my_register_post_types');
 
/**
 * 注册插件需要的文章类型
 *
 * @since  1.0.0
 * @access public
 * @return void
 */
function my_register_post_types()
{
 
    // 设置文章类型参数
    $args = [
 
        // 文章类型的简介,貌似没有在 WordPress 内核中使用,不过我们可以在主题或插件中使用
        'description'         => __('This is a description for my post type.', 'qkua'),
        // 字符串
 
        // 文章类型是否公开给管理员或者前端用户使用,这个参数的值是后面很多参数的默认值
        'public'              => true,
        // bool (default is FALSE)
 
        // 是否可以在前端作为 parse_request() 的一部分查询该文章类型
        'publicly_queryable'  => true,
        // bool (默认为 'public' 参数的值).
 
        // 是否在前端搜索中隐藏该文章类型
        'exclude_from_search' => false,
        // bool (默认为 'public' 反值)
 
        // 是否可以在导航菜单中选择
        'show_in_nav_menus'   => false,
        // bool (默认为 'public' 参数的值)
 
        // 是否在管理界面生成默认的管理界面,使用后面的参数,可以控制生成的 UI 组件,如果我们要构建自己的管理界面,
        //设置该参数为 False
        'show_ui'             => true,
        // bool (默认为 'public' 的值)
 
        // 是否在管理菜单中显示,'show_ui' 参数必须设置为 True,这个参数才有效,我们页可以设置该参数为一个顶级菜单
        //(如:'tools.php'),这种情况下,该文章类型的管理菜单出现在 Tools 菜单下面
        'show_in_menu'        => true,
        // bool (默认为 'show_ui' 的值)
 
        // 是否在管理工具条中显示该文章类型,如果设置为 true,WordPress 会在管理工具条中添加一个新建该文章类型文章的链接
        'show_in_admin_bar'   => true,
        // bool (默认为 'show_in_menu' 的值)
 
        // 该文章类型在管理菜单中出现的位置,'show_in_menu' 必须设置为 true,该参数才有用
        'menu_position'       => null,
        // int (默认为 25 - 出现在「评论」菜单后面)
 
        // 管理菜单的图标 URI,或者 Dashicon 的类名称. 参见: https://developer.wordpress.org/resource/dashicons/
        'menu_icon'           => null,
        // 字符串 (默认使用文章图标)
 
        // 属于该文章类型的文章是否可以通过 WordPress 导入/导出插件或者类型的插件导出
        'can_export'          => true,
        // bool (默认为 TRUE)
 
        // 是否暴露在 Rest API 中
        'show_in_rest',
        // 布尔值,默认为 false
 
        // 使用 Rest API 访问的基础 URI 别名
        'rest_base',
        // 字符串,默认为文章类型别名
 
        // 使用自定义 Rest API 控制器而不是默认的 WP_REST_Posts_Controller,自定义控制器必须继承 WP_REST_Controller
        'rest_controller_class',
        // 字符串,默认为 WP_REST_Posts_Controller
 
        // 是否在删除用户时,删除他们撰写的文章
        'delete_with_user'    => false,
        // bool (如果文章类型支持 ‘author’ 功能,该参数默认为 TRUE)
 
        // 该文章类型是否支持多级文章(父级文章/子文章/等等.) 
        'hierarchical'        => false,
        // bool (默认为 FALSE)
 
        // 是否为该文章类型开启存档页面 index/archive/root 页面,如果设置为 TRUE, 该文章类型名称将作为存档页面别名使用,
        //当然,我们页可以设置自定义存档别名
        'has_archive'         => 'example',
        // bool|string (默认为 FALSE)
 
        // 为该文章类型设置 query_var 键,如果设置为 TRUE, 将使用文章类型名称,如果需要,也可以设置自定义字符串
        'query_var'           => 'example',
        // bool|string (默认为 TRUE - 文章类型名称)
 
        // 用于构建该文章类型的编辑、删除、阅读权限的字符串,可以设置字符串或者数组,如果单词的负数不是加“s”的形式,我们需要
        //设置一个数组,array( 'box', 'boxes' )
        'capability_type'     => 'example',
        // string|array (默认为 'post')
 
        // 是否让 WordPress 映射权限元数据 (edit_post, read_post, delete_post),如果设置为 FALSE, 我们需要自己通过
        //过滤 “map_meta_cap” 钩子来设置文章类型权限
        'map_meta_cap'        => true,
        // bool (默认为 FALSE)
 
        // 设置更精确的文章类型权限,WordPress 默认使用 'capability_type' 参数来构建权限,多数情况下,我们不需要像文章
        //或页面这么完整的权限,下面是我经常使用的几个权限: 'manage_examples', 'edit_examples', 'create_examples'.
        // 每个文章类型都是独特的,我们可以根据需要调整这些权限
        'capabilities'        => [
 
            // meta caps (don't assign these to roles)
            'edit_post'              => 'edit_example',
            'read_post'              => 'read_example',
            'delete_post'            => 'delete_example',
 
            // primitive/meta caps
            'create_posts'           => 'create_examples',
 
            // primitive caps used outside of map_meta_cap()
            'edit_posts'             => 'edit_examples',
            'edit_others_posts'      => 'manage_examples',
            'publish_posts'          => 'manage_examples',
            'read_private_posts'     => 'read',
 
            // primitive caps used inside of map_meta_cap()
            'read'                   => 'read',
            'delete_posts'           => 'manage_examples',
            'delete_private_posts'   => 'manage_examples',
            'delete_published_posts' => 'manage_examples',
            'delete_others_posts'    => 'manage_examples',
            'edit_private_posts'     => 'edit_examples',
            'edit_published_posts'   => 'edit_examples',
        ],
 
        // 定义该文章类型的 URL 结构,我们可以设置一个具体的参数或一个布尔值,如果设置为 false,该文章类型将不支持
        // URL Rewrite 功能
        'rewrite'             => [
 
            // 文章类型的别名
            'slug'       => 'example', // string (默认为文章类型名称)
 
            // 是否在固定链接中显示 $wp_rewrite->front 文章类型别名
            'with_front' => false, // bool (默认为 TRUE)
 
            // 是否允许文章类型中的文章通过 <!--nextpage--> 快捷标签实现分页
            'pages'      => true, // bool (默认为 TRUE)
 
            // 是否为订阅源创建漂亮的固定链接feeds.
            'feeds'      => true, // bool (默认为 'has_archive' 的值)
 
            // 为固定链接设置设置 endpoint 遮罩
            'ep_mask'    => EP_PERMALINK, // const (默认为 EP_PERMALINK)
        ],
 
        // 文章类型支持的 WordPress 功能,许多参数在文章编辑界面非常有用。这有助于其他主题和插件决定让用户使用什么功能
        //或者提供什么数据,我们可以为该参数设置一个数组,也可以设置为 false,以防止添加任何功能,文章类型创建后,我们
        //可以使用 add_post_type_support() 添加功能,或使用 remove_post_type_support() 删除功能。默认功能是“标题
        //”和“编辑器”。
        'supports'            => [
            'title',// 文章标题 ($post->post_title).
            'editor', // 文章内容 ($post->post_content).
            'excerpt', // 文章摘要 ($post->post_excerpt).
            'author',  // 文章作者 ($post->post_author).
            'thumbnail',// 特色图像 (当前站点使用的主题必须支持 'post-thumbnails').
            'comments', // 显示评论元数据盒子,如果设置了该值, 这个文章类型将支持评论
            'trackbacks', // 在编辑界面显示允许发送链接通知的元数据盒子
            'custom-fields', // 显示自定义字段元数据盒子
            'revisions', // 显示版本元数据盒子,如果设置了该参数,WordPress 将在数据库中保存文章版本
            'page-attributes',  // 显示“页面属性”元数据盒子,包含父级页面或页面排序字段。
            'post-formats',// 显示文章格式元数据盒子,并允许该文章类型使用文章格式
        ],
        // 标签用来在管理界面或前端显示该文章类型的名称,标签参数不会自动改写文章更新、错误等信息中的字段,我们需要过滤
        // 'post_updated_messages' 钩子来自定义这些消息。
        'labels'              => [
            'name'                  => __('Posts', 'qkua'),
            'singular_name'         => __('Post', 'qkua'),
            'menu_name'             => __('Posts', 'qkua'),
            'name_admin_bar'        => __('Posts', 'qkua'),
            'add_new'               => __('Add New', 'qkua'),
            'add_new_item'          => __('Add New Post', 'qkua'),
            'edit_item'             => __('Edit Post', 'qkua'),
            'new_item'              => __('New Post', 'qkua'),
            'view_item'             => __('View Post', 'qkua'),
            'search_items'          => __('Search Posts', 'qkua'),
            'not_found'             => __('No posts found', 'qkua'),
            'not_found_in_trash'    => __('No posts found in trash', 'qkua'),
            'all_items'             => __('All Posts', 'qkua'),
            'featured_image'        => __('Featured Image', 'qkua'),
            'set_featured_image'    => __('Set featured image', 'qkua'),
            'remove_featured_image' => __('Remove featured image', 'qkua'),
            'use_featured_image'    => __('Use as featred image', 'qkua'),
            'insert_into_item'      => __('Insert into post', 'qkua'),
            'uploaded_to_this_item' => __('Uploaded to this post', 'qkua'),
            'views'                 => __('Filter posts list', 'qkua'),
            'pagination'            => __('Posts list navigation', 'qkua'),
            'list'                  => __('Posts list', 'qkua'),
 
            // 只在分级文章类型中使用的标签
            'parent_item'           => __('Parent Post', 'qkua'),
            'parent_item_colon'     => __('Parent Post:', 'qkua'),
        ],
    ];
 
    // 注册文章类型
    register_post_type(
        'example', // 文章类型名称,最多 20 个字符,不支持大写或空格
        $args // 文章类型的参数
    );
 
}
举报

上一篇

WordPress 获取用户文章的几种方法

下一篇

WordPress删除文章后自动删除文章附件图片
相关推荐
WordPress类:如何使用WP_REST_Response类的方法set_headers设置响应头
WordPress 多种方法自动加载页面模板
wordpress实现不同分类设置不同的每页显示文章数量
给网站增加用户切换其他标签网站标题动态提示
WordPress Rest API发布文章并设置postmeta字段信息
WordPress 自定义文章类型终极教程
评论(1)
游客的头像
表情
全部评论 只看作者
最新热门
  1. 丸辣的头像 用户头像徽章

    哔哩_脱单doge

    0 回复