Download the PHP package marcbelletre/acf-rrule without Composer
On this page you can find all versions of the php package marcbelletre/acf-rrule. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download marcbelletre/acf-rrule
More information about marcbelletre/acf-rrule
Files in marcbelletre/acf-rrule
Package acf-rrule
Short Description RRule field for Advanced Custom Fields
License MIT
Informations about the package acf-rrule
ACF RRule Field
Create recurring rules within a single ACF field and retrieve all the dates using the simshaun/recurr package.
Usage
The RRule field returns an array with the following attributes:
Attribute | Type | Description |
---|---|---|
rrule | string | The RRule string describing the recurring rule |
start_date | string | The start date of the recurrence (Ymd) |
start_time | string | The start time of the recurrence (H:i:s) |
frequency | string | The selected frequency (DAILY|WEEKLY|MONTHLY|YEARLY) |
interval | int | The interval set for the frequency |
weekdays | array\<string> | An array of days for the weekly frequency |
monthdays | array\<string> | An array of days for the monthly frequency |
months | array\<int> | An array of months for the yearly frequency |
monthly_by | string | The selected option for the monthly frequency (monthdays|setpos) |
bysetpos | array\<int> | The starting numbers for the monthly "setpos" option |
byweekday | array\<string> | The selected days for the monthly "setpos" option |
end_type | string | The end of the recurrence (date|count) |
end_date | string | The end date in YYYYMMDD format for the recurrence when end_type is set to "date" |
occurence_count | int | The number of occurences for the recurrence when end_type is set to "count" |
dates_collection | array\<DateTime> | An array containing all the DateTime objects generated by your recurring rule |
text | string | A text representation for your recurring rule |
first_date | DateTime | The first occurrence of the recurrence (since v1.4.0) |
last_date | DateTime | The last occurrence of the recurrence (since v1.4.0) |
Advanced usage
A common use case for this plugin is creating an agenda-style display for your events. Here is how I usually do it.
In the following example we will assume you have an event
custom post type with an ACF RRule field named rrule
.
The first step is to use the acf/save_post
hook to save the first and last dates in database. This is necessary for querying our events later.
You will then be able to use the start_date
and end_date
meta values in a custom WP_Query
to filter events that may have occurrences between the specified dates.
The next and last step is to create an associative array of dates. Each date will be an array of events that occurs at the given date.
Of course this is a very basic example that you will have to adapt to your use case.