hScheduleHourly

Called every hour to allow plugins to perform timed actions.

You should not rely on this hook being called only once each hour, or that it’ll be called at any specific minutes past the hour.

If possible, use one of the hSecheduleDaily* hooks, to avoid unnecessary calls to your plugin.

To perform a task at a specific time, on a specific date, or only on some days of the week, test the year, month, dayOfMonth, hour, and dayOfWeek arguments before performing the task.

Arguments

Name Type Description
year number Year, four digits
month number Month, 0 – 11
dayOfMonth number Day of the month, 1 – 31
hour number Hour of the day, 0 – 23
dayOfWeek number Day of the week, 0 (Sunday) – 6 (Saturday)

Response

No data is returned in the response object.

JavaScript template


P.hook('hScheduleHourly', function(response, year, month, dayOfMonth, hour, dayOfWeek) {
    // Respond to hook
});