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

Update more doc comments

Browse Source
This commit is contained in:
Tetrakern 2023-08-03 20:41:37 +02:00
parent d681de4fde
commit f0b6c6d42d
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
ACTIONS.md
View File

@ -645,8 +645,8 @@ Fires right after the default modals have been included in the `fictioneer_outpu
Fires within the `#full-navigation` container in the `_navigation.php` partial, right after the main navigation wrapper is rendered.
**$args:**
* $post_id (int) – Current post ID or null.
* $story_id (int) – Current story ID (if chapter) or null.
* $post_id (int|null) – Current post ID. Unsafe.
* $story_id (int|null) – Current story ID (if chapter). Unsafe.
* $header_image_url (string|boolean) – URL of the filtered header image or false.
* $header_args (array) – Arguments passed to the header.php partial.
@ -656,8 +656,8 @@ Fires within the `#full-navigation` container in the `_navigation.php` partial,
Fires within the `#full-navigation` container in the `_navigation.php` partial, right after the header background and before the main navigation wrapper is rendered.
**$args:**
* $post_id (int) – Current post ID or null.
* $story_id (int) – Current story ID (if chapter) or null.
* $post_id (int|null) – Current post ID. Unsafe.
* $story_id (int|null) – Current story ID (if chapter). Unsafe.
* $header_image_url (string|boolean) – URL of the filtered header image or false.
* $header_args (array) – Arguments passed to the header.php partial.

4
footer.php
View File

@ -14,8 +14,8 @@
* @see partials/_consent-banner.php
* @see wp_footer()
*
* @internal $args['post_id'] Current post ID or null.
* @internal $args['post_type'] Current post type or null.
* @internal $args['post_id'] Optional. Current post ID.
* @internal $args['post_type'] Optional. Current post type.
* @internal $args['breadcrumbs'] Array of breadcrumb tuples with label (0) and link (1).
*/
?>

2
includes/functions/hooks/_chapter_hooks.php
View File

@ -310,7 +310,7 @@ if ( ! function_exists( 'fictioneer_chapter_index_popup_menu' ) ) {
*
* @since Fictioneer 5.0
*
* @param WP_Post|null $args['story_post'] The story the chapter belongs to or null.
* @param WP_Post|null $args['story_post'] Optional. The story the chapter belongs to.
*/
function fictioneer_chapter_index_popup_menu( $args ) {