register_post_type( string $post_type, array|string $args = array() )

使用示例

• 示例1

  使用4.3和4.4中引入的新标签注册“book”文章类型

  /**
   * Register a custom post type called "book".
   *
   * @see get_post_type_labels() for label keys.
   */
  function wpdocs_codex_book_init() {
  	$labels = array(
  		'name'                  => _x( 'Books', 'Post type general name', 'textdomain' ),
  		'singular_name'         => _x( 'Book', 'Post type singular name', 'textdomain' ),
  		'menu_name'             => _x( 'Books', 'Admin Menu text', 'textdomain' ),
  		'name_admin_bar'        => _x( 'Book', 'Add New on Toolbar', 'textdomain' ),
  		'add_new'               => __( 'Add New', 'textdomain' ),
  		'add_new_item'          => __( 'Add New Book', 'textdomain' ),
  		'new_item'              => __( 'New Book', 'textdomain' ),
  		'edit_item'             => __( 'Edit Book', 'textdomain' ),
  		'view_item'             => __( 'View Book', 'textdomain' ),
  		'all_items'             => __( 'All Books', 'textdomain' ),
  		'search_items'          => __( 'Search Books', 'textdomain' ),
  		'parent_item_colon'     => __( 'Parent Books:', 'textdomain' ),
  		'not_found'             => __( 'No books found.', 'textdomain' ),
  		'not_found_in_trash'    => __( 'No books found in Trash.', 'textdomain' ),
  		'featured_image'        => _x( 'Book Cover Image', 'Overrides the “Featured Image” phrase for this post type. Added in 4.3', 'textdomain' ),
  		'set_featured_image'    => _x( 'Set cover image', 'Overrides the “Set featured image” phrase for this post type. Added in 4.3', 'textdomain' ),
  		'remove_featured_image' => _x( 'Remove cover image', 'Overrides the “Remove featured image” phrase for this post type. Added in 4.3', 'textdomain' ),
  		'use_featured_image'    => _x( 'Use as cover image', 'Overrides the “Use as featured image” phrase for this post type. Added in 4.3', 'textdomain' ),
  		'archives'              => _x( 'Book archives', 'The post type archive label used in nav menus. Default “Post Archives”. Added in 4.4', 'textdomain' ),
  		'insert_into_item'      => _x( 'Insert into book', 'Overrides the “Insert into post”/”Insert into page” phrase (used when inserting media into a post). Added in 4.4', 'textdomain' ),
  		'uploaded_to_this_item' => _x( 'Uploaded to this book', 'Overrides the “Uploaded to this post”/”Uploaded to this page” phrase (used when viewing media attached to a post). Added in 4.4', 'textdomain' ),
  		'filter_items_list'     => _x( 'Filter books list', 'Screen reader text for the filter links heading on the post type listing screen. Default “Filter posts list”/”Filter pages list”. Added in 4.4', 'textdomain' ),
  		'items_list_navigation' => _x( 'Books list navigation', 'Screen reader text for the pagination heading on the post type listing screen. Default “Posts list navigation”/”Pages list navigation”. Added in 4.4', 'textdomain' ),
  		'items_list'            => _x( 'Books list', 'Screen reader text for the items list heading on the post type listing screen. Default “Posts list”/”Pages list”. Added in 4.4', 'textdomain' ),
  	);
  
  	$args = array(
  		'labels'             => $labels,
  		'public'             => true,
  		'publicly_queryable' => true,
  		'show_ui'            => true,
  		'show_in_menu'       => true,
  		'query_var'          => true,
  		'rewrite'            => array( 'slug' => 'book' ),
  		'capability_type'    => 'post',
  		'has_archive'        => true,
  		'hierarchical'       => false,
  		'menu_position'      => null,
  		'supports'           => array( 'title', 'editor', 'author', 'thumbnail', 'excerpt', 'comments' ),
  	);
  
  	register_post_type( 'book', $args );
  }
  
  add_action( 'init', 'wpdocs_codex_book_init' );
  

• 示例2

  要在自定义文章类型中添加古腾堡兼容，需要两件事。supports中必须包含editor。show_in_rest设置为true

  function wpdocs_kantbtrue_init() {
      $labels = array(
          'name'                  => _x( 'Recipes', 'Post type general name', 'recipe' ),
          'singular_name'         => _x( 'Recipe', 'Post type singular name', 'recipe' ),
          'menu_name'             => _x( 'Recipes', 'Admin Menu text', 'recipe' ),
          'name_admin_bar'        => _x( 'Recipe', 'Add New on Toolbar', 'recipe' ),
          'add_new'               => __( 'Add New', 'recipe' ),
          'add_new_item'          => __( 'Add New recipe', 'recipe' ),
          'new_item'              => __( 'New recipe', 'recipe' ),
          'edit_item'             => __( 'Edit recipe', 'recipe' ),
          'view_item'             => __( 'View recipe', 'recipe' ),
          'all_items'             => __( 'All recipes', 'recipe' ),
          'search_items'          => __( 'Search recipes', 'recipe' ),
          'parent_item_colon'     => __( 'Parent recipes:', 'recipe' ),
          'not_found'             => __( 'No recipes found.', 'recipe' ),
          'not_found_in_trash'    => __( 'No recipes found in Trash.', 'recipe' ),
          'featured_image'        => _x( 'Recipe Cover Image', 'Overrides the “Featured Image” phrase for this post type. Added in 4.3', 'recipe' ),
          'set_featured_image'    => _x( 'Set cover image', 'Overrides the “Set featured image” phrase for this post type. Added in 4.3', 'recipe' ),
          'remove_featured_image' => _x( 'Remove cover image', 'Overrides the “Remove featured image” phrase for this post type. Added in 4.3', 'recipe' ),
          'use_featured_image'    => _x( 'Use as cover image', 'Overrides the “Use as featured image” phrase for this post type. Added in 4.3', 'recipe' ),
          'archives'              => _x( 'Recipe archives', 'The post type archive label used in nav menus. Default “Post Archives”. Added in 4.4', 'recipe' ),
          'insert_into_item'      => _x( 'Insert into recipe', 'Overrides the “Insert into post”/”Insert into page” phrase (used when inserting media into a post). Added in 4.4', 'recipe' ),
          'uploaded_to_this_item' => _x( 'Uploaded to this recipe', 'Overrides the “Uploaded to this post”/”Uploaded to this page” phrase (used when viewing media attached to a post). Added in 4.4', 'recipe' ),
          'filter_items_list'     => _x( 'Filter recipes list', 'Screen reader text for the filter links heading on the post type listing screen. Default “Filter posts list”/”Filter pages list”. Added in 4.4', 'recipe' ),
          'items_list_navigation' => _x( 'Recipes list navigation', 'Screen reader text for the pagination heading on the post type listing screen. Default “Posts list navigation”/”Pages list navigation”. Added in 4.4', 'recipe' ),
          'items_list'            => _x( 'Recipes list', 'Screen reader text for the items list heading on the post type listing screen. Default “Posts list”/”Pages list”. Added in 4.4', 'recipe' ),
      );     
      $args = array(
          'labels'             => $labels,
          'description'        => 'Recipe custom post type.',
          'public'             => true,
          'publicly_queryable' => true,
          'show_ui'            => true,
          'show_in_menu'       => true,
          'query_var'          => true,
          'rewrite'            => array( 'slug' => 'recipe' ),
          'capability_type'    => 'post',
          'has_archive'        => true,
          'hierarchical'       => false,
          'menu_position'      => 20,
          'supports'           => array( 'title', 'editor', 'author', 'thumbnail' ),
          'taxonomies'         => array( 'category', 'post_tag' ),
          'show_in_rest'       => true
      );
       
      register_post_type( 'Recipe', $args );
  }
  add_action( 'init', 'wpdocs_kantbtrue_init' );

• 示例3

  使用'show_in_rest' => true,
  在自定义文章类型中启用区块。

• 示例4

  自定义文章类型“book”的自定义文章更新消息：

  /**
   * Book-specific update messages.
   *
   * @see /wp-admin/edit-form-advanced.php
   *
   * @param array $messages Existing post update messages.
   * @return array Amended post update messages with new CPT update messages.
   */
  function wpdocs_codex_book_updated_messages( $messages ) {
  	$post             = get_post();
  	$post_type        = get_post_type( $post );
  	$post_type_object = get_post_type_object( $post_type );
  
  	$messages['book'] = array(
  		0  => '', // Unused. Messages start at index 1.
  		1  => __( 'Book updated.', 'textdomain' ),
  		2  => __( 'Custom field updated.', 'textdomain' ),
  		3  => __( 'Custom field deleted.', 'textdomain' ),
  		4  => __( 'Book updated.', 'textdomain' ),
  		/* translators: %s: date and time of the revision */
  		5  => isset( $_GET['revision'] ) ? sprintf( __( 'Book restored to revision from %s', 'textdomain' ), wp_post_revision_title( (int) $_GET['revision'], false ) ) : false,
  		6  => __( 'Book published.', 'textdomain' ),
  		7  => __( 'Book saved.', 'textdomain' ),
  		8  => __( 'Book submitted.', 'textdomain' ),
  		9  => sprintf(
  			__( 'Book scheduled for: <strong>%1$s</strong>.', 'textdomain' ),
  			// translators: Publish box date format, see http://php.net/date
  			date_i18n( __( 'M j, Y @ G:i', 'textdomain' ), strtotime( $post->post_date ) )
  		),
  		10 => __( 'Book draft updated.', 'textdomain' ),
  	);
  
  	if ( $post_type_object->publicly_queryable ) {
  		$permalink = get_permalink( $post->ID );
  
  		$view_link = sprintf( ' <a href="%s">%s</a>', esc_url( $permalink ), __( 'View book', 'textdomain' ) );
  		$messages['book'][1] .= $view_link;
  		$messages['book'][6] .= $view_link;
  		$messages['book'][9] .= $view_link;
  
  		$preview_permalink = add_query_arg( 'preview', 'true', $permalink );
  		$preview_link      = sprintf( '<a target="_blank" href="%s">%s</a>', esc_url( $preview_permalink ), __( 'Preview book', 'textdomain' ) );
  		$messages[ $post_type ][8] .= $preview_link;
  		$messages[ $post_type ][10] .= $preview_link;
  	}
  
  	return $messages;
  }
  
  add_filter( 'post_updated_messages', 'wpdocs_codex_book_updated_messages' );
  

• 示例5

  该文档目前缺少我在一些项目中看到的“template”和“template_lock”参数。其目的是自动将某个区块或区块模板加载到古腾堡编辑器中，或锁定区块的使用。

  这些参数的文档可以在Block Editor Handbook > Templates的关于古腾堡区块的文档部分中找到

• 示例6

  从WordPress 4.3和4.4开始，添加了许多新标签。

  在4.3中介绍：
  featured_image–默认为“特色图像”
  set_featured_image–默认为“设置特色图像”
  remove_featured_image–默认为“删除特色图像”
  use_featured_image–默认为“用作特色图像”

  在4.4中介绍：
  archives–默认为“文章存档”或“页面存档”
  insert_into_item–默认为“插入文章”或“插入页面”
  uploaded_to_this_item–默认为“上载到此文章”或“上载到此页面”
  filter_items_list–默认为“过滤文章列表”或“过滤页面列表”
  items_list_navigation–默认为“文章列表导航”或“页面列表导航”
  items_list–默认为“文章列表”或“页面列表”

  详见https://make.wordpress.org/core/2015/12/11/additional-labels-for-custom-post-types-and-custom-taxonomies/。

• 示例7

  使用Dashicons作为自定义菜单图标

  要在菜单中为自定义文章类型使用一个现有的DashIcon（而不是图钉默认值），请转到Developer Resources: Dashicons并单击您最喜欢的图标。类名将显示在顶部-只需复制并使用。例如，对于自定义的文章类型“Book”，可以使用dashicons-book。

  function book_setup_post_type() {
      $args = array(
          'public'    => true,
          'label'     => __( 'Books', 'textdomain' ),
          'menu_icon' => 'dashicons-book',
      );
      register_post_type( 'book', $args );
  }
  add_action( 'init', 'book_setup_post_type' );
  

• 示例8

  要使用颜色始终正确的svg，请将其内嵌，如：

  register_post_type('labs', [
          // ect
          'menu_icon' => 'data:image/svg+xml;base64,' . base64_encode('<svg width="20" height="20" viewBox="0 0 1792 1792" xmlns="http://www.w3.org/2000/svg"><path fill="black" d="M1591 1448q56 89 21.5 152.5t-140.5 63.5h-1152q-106 0-140.5-63.5t21.5-152.5l503-793v-399h-64q-26 0-45-19t-19-45 19-45 45-19h512q26 0 45 19t19 45-19 45-45 19h-64v399zm-779-725l-272 429h712l-272-429-20-31v-436h-128v436z"/></svg>')
       ]);

  fill="black"很重要，来源：https://stackoverflow.com/a/42265057/933065

• 示例9

  切勿创建自定义文章类型“author”

  存档页面和文章页面将与wordpress的内置/author/{username}路由冲突，即使你'rewrite' => ['slug' => 'writer']，也会有一些混乱，你的自定义author帖子将无法访问。

• 示例10

  这是一个向“book”文章类型添加上下文帮助的示例。

  add_action( 'contextual_help', 'wpdocs_codex_add_help_text', 10, 3 );
  /**
   * Display contextual help for the Book post type
   */
  function wpdocs_codex_add_help_text( $contextual_help, $screen_id, $screen ) {
  
  	// $contextual_help .= var_dump( $screen ); // use this to help determine $screen->id
  	if ( 'book' == $screen->id ) {
  		$contextual_help =
  			'<p>' . __('Things to remember when adding or editing a book:', 'your_text_domain') . '</p>' .
  			'<ul>' .
  				'<li>' . __('Specify the correct genre such as Mystery, or Historic.', 'your_text_domain') . '</li>' .
  				'<li>' . __('Specify the correct writer of the book.  Remember that the Author module refers to you, the author of this book review.', 'your_text_domain') . '</li>' .
  			'</ul>' .
  			'<p>' . __('If you want to schedule the book review to be published in the future:', 'your_text_domain') . '</p>' .
  			'<ul>' .
  				'<li>' . __('Under the Publish module, click on the Edit link next to Publish.', 'your_text_domain') . '</li>' .
  				'<li>' . __('Change the date to the date to actual publish this article, then click on Ok.', 'your_text_domain') . '</li>' .
  			'</ul>' .
  			'<p><strong>' . __('For more information:', 'your_text_domain') . '</strong></p>' .
  			'<p>' . __('<a href="https://codex.wordpress.org/Posts_Edit_SubPanel" target="_blank">Edit Posts Documentation</a>', 'your_text_domain') . '</p>' .
  			'<p>' . __('<a href="https://wordpress.org/support/" target="_blank">Support Forums</a>', 'your_text_domain') . '</p>' ;
  	} elseif ( 'edit-book' == $screen->id ) {
  		$contextual_help = '<p>' . __('This is the help screen displaying the table of books blah blah blah.', 'your_text_domain') . '</p>';
  	}
  	
  	return $contextual_help;
  }
  

• 示例11

  本例将WordPress 3.3+帮助选项卡添加到“book”文章类型。

  add_action( 'admin_head', 'wpdocs_codex_custom_help_tab' );
  /**
   * Add Help Tab to Book post type.
   */
  function wpdocs_codex_custom_help_tab() {
  
  	$screen = get_current_screen();
  
  	// Return early if we're not on the book post type.
  	if ( 'book' != $screen->post_type ) {
  		return;
  	}
  
  	// Setup help tab args.
  	$args = array(
  		'id'      => 'your_custom_id', // Unique id for the tab.
  		'title'   => __( 'Custom Help', 'textdomain' ), // Unique visible title for the tab.
  		'content' => '<h3>Help Title</h3><p>Help content</p>', // Actual help text.
  	);
  
  	// Add the help tab.
  	$screen->add_help_tab( $args );
  
  }
  

• 示例12

  将base64编码的SVG用于menu_icon参数时，SVG必须具有fill属性。没有fill属性，WordPress将无法匹配管理界面配色方案。

• 示例13

  以下是内置的文章类型：

  'post',
  'page',
  'attachment',
  'revision',
  'nav_menu_item',
  'custom_css',
  'customize_changeset',
  'oembed_cache',
  'user_request',
  

  如果您想查看所有内置和/或自定义文章类型的信息，可以从$wp_post_types全局变量获取，示例：

  add_action( 'admin_notices', function () {
  	global $wp_post_types;
  	var_dump( $wp_post_types );
  });
  

• 示例14

  这个基本示例注册了一个“book”文章类型。

  /**
   * Register a book post type.
   */
  function wpdocs_codex_custom_init() {
  	$args = array(
  		'public' => true,
  		'label'  => __( 'Books', 'textdomain' ),
  	);
  	register_post_type( 'book', $args );
  }
  add_action( 'init', 'wpdocs_codex_custom_init' );
  

• 示例15

  关于分层文章类型性能问题，请注意：“将此参数设置为true后，WordPress将在您的文章类型的每个管理页面加载上获取该特定文章类型的所有ID。”

  措辞有点混乱。WP将获取此文章类型的特定文章的所有子ID，而不是“文章类型”的“所有ID”，这是一个描述文章类型而不是特定文章的术语。

• 示例16

  这份文件中有一个错误，supports参数还接受布尔值false，当supports设置为false时，文章类型不使用任何内置功能，如编辑器

  只有submit metabox会自动注册。

  因此，如果有人能更新这些信息，让其他开发者也能从我的研究中受益，我将不胜感激。

• 示例17

  文章类型作为子菜单是可能的。
  你可以把一个自定义的文章类型放在另一个CPT的菜单里!
  文档并不是那么明显!
  但是，让一个文章类型成为另一个文章类型的子菜单是完全可能的!
  选项 "show_in_menu" 是实现这一目的的关键。(除了建议的menu_position参数外)

  你只需要给 "show_in_menu" 这个参数："edit.php?post_type=page"
  其中"page"可以是一个内置的文章类型或任何你创建的文章类型

  下面是一个示例代码段

     	$books_args = array(
          'label'     		=> __( 'Books', 'textdomain' ),
          'show_in_menu'    	=> 'edit.php?post_type=page',
      );
      register_post_type( 'book', $books_args );
  

• 示例18

  如果出于某种原因，自定义文章类型的页面前端出现404，则可能需要刷新重写规则。您可以手动执行此操作，方法是转到设置 -> 固定链接并点击“保存更改”或调用 flush_rewrite_rules()。注意，你不应该调用flush_rewrite_rules()，因为它很昂贵。仅在插件激活时运行。

• 示例19

  要在menu_icon中使用自定义SVG，请查找或创建要使用的SVG，然后可以使用https://www.base64-image.de/之类的站点将其转换为base64代码。

  为了使SVG图标与管理界面配色方案匹配，它必须在SVG文件的任何path元素中设置fill属性。

  使用编辑器编辑SVG文件，并在转换为base64之前向任何“path”元素添加fill属性。

  <path d="...

  应该是

  <path fill="#9da3a8" d="...

  你可以使用任何你想要的颜色，包括使用none而不是颜色，因为WordPress会自动更新它以匹配配色方案。

  https://css-tricks.com/almanac/properties/f/fill/

• 示例20

  当你注册一个新的自定义文章类型时，我强烈建议设置with_front => true，因为它在核心中默认为false。如果用户/客户将其固定链接更改为/blog/%category%/%postname%/，那么对您的CPT注册的更改将很有帮助，因为您所有注册的CPT都将具有/blog/your-cpt