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

Allow fictioneer_get_chapter_list_items to be rendered in other statuses #51

Merged
iniznet merged 2 commits from refactor/fictioneer_get_chapter_list_items into main 2024-09-26 17:55:25 +08:00
Conversation 1 Commits 2 Files Changed 2 +11 -1
2 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
FILTERS.md
View File

@ -215,6 +215,15 @@ Filters the intermediate output array in the `_chapter-header.php` partial befor
--- ---
### `apply_filters( 'fictioneer_filter_chapter_list_statuses', $statuses, $story_id )`
Filters the list of allowed chapter statuses during building chapter lists in the `function fictioneer_get_chapter_list_items()` function. By default, only `['publish']` chapters are shown.
**Parameters:**
* $statuses (array) – Array of chapter statuses.
* $story_id (int) – Post ID of the story.
---
### `apply_filters( 'fictioneer_filter_chapter_list_item', $item, $post, $args )` ### `apply_filters( 'fictioneer_filter_chapter_list_item', $item, $post, $args )`
Filters each list item HTML string used in the chapter index popup and mobile menu section (only visible on chapter pages), build inside the `fictioneer_get_chapter_list_items()` function. Not to be confused with the chapter list shown on story pages. You can either modify the string or build a new one from the given parameters. Filters each list item HTML string used in the chapter index popup and mobile menu section (only visible on chapter pages), build inside the `fictioneer_get_chapter_list_items()` function. Not to be confused with the chapter list shown on story pages. You can either modify the string or build a new one from the given parameters.

3
includes/functions/_helpers-templates.php
View File

@ -1282,12 +1282,13 @@ if ( ! function_exists( 'fictioneer_get_chapter_list_items' ) ) {
$chapters = fictioneer_get_story_chapter_posts( $story_id ); $chapters = fictioneer_get_story_chapter_posts( $story_id );
$hide_icons = get_post_meta( $story_id, 'fictioneer_story_hide_chapter_icons', true ) || get_option( 'fictioneer_hide_chapter_icons' ); $hide_icons = get_post_meta( $story_id, 'fictioneer_story_hide_chapter_icons', true ) || get_option( 'fictioneer_hide_chapter_icons' );
$html = ''; $html = '';
$allowed_statuses = apply_filters( 'fictioneer_filter_chapter_list_statuses', ['publish'], $story_id );
// Loop chapters... // Loop chapters...
foreach ( $chapters as $chapter ) { foreach ( $chapters as $chapter ) {
// Skip unpublished (in case of filtered query params) // Skip unpublished (in case of filtered query params)
if ( if (
$chapter->post_status !== 'publish' || ! in_array( $chapter->post_status, $allowed_statuses ) ||
get_post_meta( $chapter->ID, 'fictioneer_chapter_hidden', true ) get_post_meta( $chapter->ID, 'fictioneer_chapter_hidden', true )
) { ) {
continue; continue;