README

一个用于统计文章阅读次数并列出阅读量最多的内容的开发者友好型插件

插件添加了一个小的JavaScript文件（332字节），该文件为每个单独的文章调用计数器，并引入了两个新的函数以获取阅读量最多的文章。一旦插件被激活，它就开始统计文章被阅读的次数。

默认情况下，只统计所有时间的阅读量最多的文章，登录用户或同一用户在相同文章中每小时阅读超过一次的阅读将被忽略。这些默认设置可以使用过滤器进行更改。

在Digitoimisto Dude Oy精心制作，这是一家位于约维萨基市中心的芬兰精品数字代理机构。

目录

1. 请注意在使用之前
2. 许可证
3. 用法
   1. 参数
4. 过滤器
5. Composer
6. 贡献

请注意在使用之前

这个插件不是为“每个人”设计的，它至少需要一些基本的PHP知识。目前插件处于开发阶段，因此它可能非常频繁地更新，并且事情可能会发生变化。

许可证

Most read posts是在GNU GPL 2或更高版本下发布的。

用法

此插件没有设置页面或在前端提供任何可见的内容。可以通过以下列出的过滤器更改设置。

插件引入了两个新的函数以获取阅读量最多的文章。

get_most_popular_posts( $period, $query_args, $custom_start, $custom_end ) 返回默认的WP_Query对象，包含五篇文章，可以使用与正常的new WP_Query相同的方式使用，除了参数。行为可以通过参数进行更改。

get_most_popular_posts_ids( $period, $only_ids, $custom_start, $custom_end ) 返回包含五篇文章ID的数组，行为可以通过参数进行更改。

参数

两个函数都接受三个基本参数。

$period (字符串) (可选) 要接收阅读量最多的文章的哪个时间段。可能的值是年、月、周和自定义。默认值是null，等同于所有时间。如果时间段是自定义的，提供开始和结束日期到时间段。

$custom_start (字符串) (可选) 如果时间段是自定义的，告诉从哪里开始计数。

$custom_end (字符串) (可选) 如果时间段是自定义的，告诉从哪里结束计数。

$query_args (数组) (可选) 可以作为get_most_popular_posts函数的第二个参数传递。数组与插件设置的参数合并并转发到WP_Query。使用此方法可以设置文章类型或使用post_per_page等设置结果数量。默认值为空数组。

$only_ids (布尔值) (可选) 可作为 get_most_popular_posts_ids 函数的第二个参数传入。用来判断是否需要获取阅读数。如果为真，则帖子ID为值，如果为假，则帖子ID为键，阅读数为值。默认值为真。

过滤器

插件功能可以通过钩子进行更改。

dmrp_dont_count_logged_in_users 当设置为假时，也会统计已登录用户的阅读。建议使用 __return_false。

dmrp_count_for_post_types 默认情况下，只对帖子进行阅读数统计。可以通过传入所需帖子类型的数组来更改。

dmrp_cookie_timeout 默认情况下，同一用户在相同帖子中每小时多次阅读将被忽略。可以通过传入所需的cookie超时时间（毫秒）来更改时间，或者通过传入 0 来禁用此功能。

Composer

要使用composer安装此插件，请在项目目录中运行命令 composer require digitoimistodude/dude-most-read-posts，或将 "digitoimistodude/dude-most-read-posts":"dev-master" 添加到您的 composer.json 文件中的 require 部分。

贡献

如果您对此插件有想法或发现问题，请告诉我们。在贡献想法或报告关于“缺失”功能或与此问题本质相关的问题之前，请阅读请注意部分。非常感谢。