malhuda/fictioneer
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 112 Wiki Activity

Chore sort alpabetically & add fictioneer_filter_allowed_chapter_permalinks in filters documentation

Browse Source
This commit is contained in:
iniznet 2024-09-26 08:47:54 +07:00
parent 0d58606498
commit 8a6440235a
1 changed files with 27 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
FILTERS.md
View File

@ -53,6 +53,14 @@ Filters the data to be returned as JSON by the `fictioneer_ajax_get_user_data()`
---
### `apply_filters( 'fictioneer_filter_allowed_chapter_permalinks', $statuses )`
Filters the array of chapter statuses that control whether the chapter permalink is allowed to display in the `function fictioneer_story_chapters( $args )`. By default, the statuses only include `['publish']`.
**Parameters:**
* $statuses (array) – Array of chapter statuses.
---
### `apply_filters( 'fictioneer_filter_allowed_orderby', $defaults )`
Filters the array of allowed orderby arguments for WP_Query.
@ -70,6 +78,17 @@ Filters the array of allowed orderby arguments for WP_Query.
---
### `apply_filters( 'fictioneer_filter_append_chapter_to_story_statuses', $statuses, $post_id, $story_id, $force )`
Filters the array of chapter statuses that can be appended to a story’s `fictioneer_story_chapters` metadata in the `function fictioneer_append_chapter_to_story()`. By default, the statuses are `['publish']`.
**Parameters:**
* $statuses (array) – Array of chapter statuses.
* $post_id (int) – The chapter post ID.
* $story_id (int) – The story post ID.
* $force (boolean) – Whether to skip some guard clauses. Default false.
---
### `apply_filters( 'fictioneer_filter_shortcode_article_card_footer', $footer_items, $posts )`
Filters the intermediate output array in the `_article-cards.php` partial before it is imploded and rendered. Contains statistics with icons such as the author, publishing or modified date, and comments.
@ -301,6 +320,14 @@ Filters the array of support links returned for the current post (or post ID if
---
### `apply_filters( 'fictioneer_filter_get_story_data_indexed_chapter_statuses', $statuses )`
Filters the array of chapter statuses that can be appended to a story’s `indexed_chapter_ids` array data in the `function fictioneer_get_story_data()`. By default, the statuses are `['publish']`.
**Parameters:**
* $statuses (array) – Array of chapter statuses.
---
### `apply_filters( 'fictioneer_filter_chapters_card_args', $card_args, $args )`
Filters the arguments passed to the `partials/_card-chapter` template part in the `fictioneer_chapters_list( $args )` function, normally added via the `fictioneer_chapters_after_content` hook.
@ -703,25 +730,6 @@ Filters the sanitized POST meta box fields before they are saved, see `_setup-me
---
### `apply_filters( 'fictioneer_filter_append_chapter_to_story_statuses', $statuses, $post_id, $story_id, $force )`
Filters the array of chapter statuses that can be appended to a story’s `fictioneer_story_chapters` metadata in the `function fictioneer_append_chapter_to_story()`. By default, the statuses are `['publish']`.
**Parameters:**
* $statuses (array) – Array of chapter statuses.
* $post_id (int) – The chapter post ID.
* $story_id (int) – The story post ID.
* $force (boolean) – Whether to skip some guard clauses. Default false.
---
### `apply_filters( 'fictioneer_filter_get_story_data_indexed_chapter_statuses', $statuses )`
Filters the array of chapter statuses that can be appended to a story’s `indexed_chapter_ids` array data in the `function fictioneer_get_story_data()`. By default, the statuses are `['publish']`.
**Parameters:**
* $statuses (array) – Array of chapter statuses.
---
### `apply_filters( 'fictioneer_filter_mobile_quick_buttons', $buttons )`
Filters the intermediate output array of the `fictioneer_mobile_quick_buttons()` function before it is imploded and rendered via the `fictioneer_mobile_menu_bottom` hook. By default and depending on the page, the output can contain buttons to darken and brighten the site, toggle chapter options, open the formatting modal, or change site settings.