inpsyde/cpt-archives

此软件包已被弃用,不再维护。未建议替代软件包。

允许为文章类型存档提供类似文章的编辑体验。

0.1.1 2020-02-04 10:42 UTC

This package is auto-updated.

Last update: 2024-03-29 10:30:16 UTC


README

一个Composer软件包,为文章类型存档提供类似文章的编辑体验。

未维护

注意:此插件版本不再维护。

功能

  • 文章类型存档的类似文章的编辑体验,支持标题、内容、摘要、自定义字段、文章缩略图、修订。
  • 可扩展:可以像其他文章类型一样,向编辑屏幕添加元框。
  • 自动过滤 post_type_archive_titleget_the_archive_description,分别返回后端分配的 标题摘要(如果有)。
  • 允许将CPT存档链接添加到WordPress导航菜单中,而无需使用自定义链接。

用法

"CPT存档" 不是 插件,而是一个Composer软件包。它可以由主题、插件或在由Composer管理的网站上使用。

通过Composer安装后,需要启用composer自动加载,CPT存档需要像这样启动:

CptArchives\Bootstrap\bootstrap();
  • 这可以在任何插件、MU插件或主题的 functions.php 中完成,无需在任何钩子中包装调用。
  • 不需要检查库是否已经启动,上面的代码片段可以多次调用,而不会有任何负面影响。

将此单行代码放入后,所有"CPT存档"都将完全启动,其API可供使用。

API

有两个API,一个面向对象和一个过程式,用于包装它。

面向对象API由对象 CptArchives\Archive 的方法提供,该对象没有公共构造函数,可以使用其两个命名构造函数之一进行实例化

-CptArchives\Archive::for_type(),它只接受一个参数,即要为其实例化对象的文章类型(作为slug,即字符串,或作为文章类型对象)。 -CptArchives\Archive::for_current_type(),它不接受任何参数,仅在文章类型存档页面上工作(当 is_post_type_archive() 为 true 时)。

一旦获得对象的实例,还有以下方法可用

  • CptArchives\Archive::archive_title( string $before = '', string $after = '' ): string
  • CptArchives\Archive::archive_content( string $more_link_text = null, bool $strip_teaser = false ): string
  • CptArchives\Archive::archive_excerpt(): string
  • CptArchives\Archive::archive_has_thumbnail(): bool
  • CptArchives\Archive::archive_thumbnail_id(): int
  • CptArchives\Archive::archive_thumbnail( string $size = 'post-thumbnail', array $attr = [] ): string
  • CptArchives\Archive::archive_meta( string $key = '', bool $single = false ): mixed

签名类似于文章函数,命名应具有自解释性。

过程式API使用 CptArchives 命名空间中的函数包装面向对象API。API函数的名称与 CptArchives\Archive 对象方法的名称完全相同。

签名相同,但总是预先添加一个参数:从该参数获取信息的文章类型,可以提供为字符串(文章类型slug)或文章类型对象。

例如

  • CptArchives\archive_title( $post_type, string $before = '', string $after = '' ): string

等等...

请注意,也可以将 null 作为API函数的第一个参数传递,这将使用当前文章类型,这仅在查看前端中的文章类型存档时才有效(即当 is_post_type_archive() 为 true 时)。

相关钩子

  • 'cpt-archives.can-edit-archive'。过滤器。允许编辑编辑文章类型存档所需的能力(默认为 $post_type->cap->edit_others_posts)。
  • 'cpt-archives.can-edit-archive'。过滤器。允许编辑库应该注册管理屏幕和API的哪些文章类型。默认情况下,所有公开的、非内置的、支持存档的文章类型。
  • 'cpt-archives.cpt-archive-args' 过滤器。允许编辑用于管理存档的内部CPT注册参数。

要求

  • PHP 7+
  • Composer 安装

安装

通过Composer安装,包名为 inpsyde/cpt-archives

许可证和版权

版权所有(c)自2017年Inpsyde GmbH。

"CPT Archives" 代码受 GPLv2+ 许可 许可。

Inpsyde 团队自2006年以来一直在进行网络工程。Inpsyde