helick / related-posts
Helick 相关帖子插件
v1.2.1
2019-08-13 09:14 UTC
Requires
- php: >=7.1
- composer/installers: ^1.6
- helick/contracts: ^1.1
- htmlburger/carbon-fields: ^3.1
- wp-cli/wp-cli: ^2.2
Requires (Dev)
This package is auto-updated.
Last update: 2024-08-29 05:18:29 UTC
README
该插件提供了一种简单的相关帖子功能,具有以下特性
- 手动覆盖相关帖子的能力
- ElasticPress 集成
要求
在继续之前,请确保已安装所有依赖项
安装
通过 Composer
$ composer require helick/related-posts
使用方法
该插件公开了一个函数,返回一系列帖子 ID。
$postIds = Helick\RelatedPosts\get(int $postId, array $args = []);
$postId 是获取相关内容的帖子 ID。
$args 允许您对返回的帖子进行一些控制
- int limit: 默认为
10
- array post_types: 限制结果的帖子类型数组,默认为
['post']
- array taxonomies: 要比较的分类法数组,默认为
['category']
- array terms:
WP_Term
对象数组,结果将匹配这些术语 - array terms_not_in:
WP_Term
对象数组,结果将不匹配这些术语 - bool ep_integrate: 如果为 true,则使用 ElasticPress 获取结果,默认为
defined('EP_VERSION')
自定义帖子类型支持
控制支持的帖子类型
add_filter('helick_related_posts_supported_post_types', function (array $postTypes) { $postTypes[] = 'your-custom-post-type'; return $postTypes; });
控制相关帖子类型
add_filter('helick_related_posts_associated_post_types', function (array $postTypes) { $postTypes[] = 'your-custom-post-type'; return $postTypes; });
贡献
请参阅CONTRIBUTING 和 CODE_OF_CONDUCT 获取详细信息。
安全
如果您发现任何与安全相关的问题,请通过evgenii@helick.io 发送电子邮件,而不是使用问题跟踪器。
鸣谢
许可证
MIT 许可证 (MIT)。请参阅许可证文件获取更多信息。