diff --git a/404.php b/404.php index 7fd56492..ad156273 100644 --- a/404.php +++ b/404.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.7 + * @since 4.7.0 */ ?> diff --git a/author.php b/author.php index 5931f88e..aa2a0db9 100644 --- a/author.php +++ b/author.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.6 + * @since 4.6.0 * @see fictioneer_clause_sticky_stories() */ ?> diff --git a/collections.php b/collections.php index 0354ab9b..0ee5827a 100644 --- a/collections.php +++ b/collections.php @@ -8,7 +8,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 */ ?> diff --git a/comments.php b/comments.php index 453ae884..effb7fc7 100644 --- a/comments.php +++ b/comments.php @@ -6,7 +6,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.7 + * @since 4.7.0 */ ?> diff --git a/includes/functions/_admin.php b/includes/functions/_admin.php index e9472c26..05c80e8a 100644 --- a/includes/functions/_admin.php +++ b/includes/functions/_admin.php @@ -51,7 +51,7 @@ add_action( 'admin_enqueue_scripts', 'fictioneer_admin_styles' ); /** * Enqueue scripts and styles for admin panel * - * @since 4.0 + * @since 4.0.0 * * @param string $hook_suffix The current admin page. */ @@ -126,8 +126,8 @@ if ( ! function_exists( 'fictioneer_check_for_updates' ) ) { * 'fictioneer_latest_version' option. Only one request is made every 12 hours * unless you are on the updates page. * - * @since Fictioneer 5.0 - * @since Fictioneer 5.7.5 - Refactored. + * @since 5.0.0 + * @since 5.7.5 - Refactored. * * @return boolean True if there is a newer version, false if not. */ @@ -178,7 +178,7 @@ if ( ! function_exists( 'fictioneer_check_for_updates' ) ) { /** * Show notice when a newer version is available * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_admin_update_notice() { @@ -222,7 +222,7 @@ if ( current_user_can( 'install_themes' ) ) { /** * Modifies the list of removable query arguments (admin panel only) * - * @since Fictioneer 5.2.5 + * @since 5.2.5 * * @param array $args The list of removable query arguments. * @@ -253,7 +253,7 @@ add_filter( 'removable_query_args', 'fictioneer_removable_args' ); * converter heavily depend on _expected_ input or may break. There are certainly * more possible but the initial selection has been chosen carefully. * - * @since 4.0 + * @since 4.0.0 */ function fictioneer_allowed_block_types() { @@ -351,7 +351,7 @@ if ( ! function_exists( 'fictioneer_add_or_update_term' ) ) { /** * Add or update term * - * @since Fictioneer 4.6 + * @since 4.6.0 * * @param string $name Name of the term to add or update. * @param string $taxonomy Taxonomy type of the term. @@ -427,7 +427,7 @@ if ( ! function_exists( 'fictioneer_convert_taxonomies' ) ) { /** * Convert taxonomies of post type from one type to another * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param string $post_type Post type the taxonomy is attached to. * @param string $target Taxonomy to be converted to. @@ -479,7 +479,7 @@ if ( ! function_exists( 'fictioneer_convert_taxonomies' ) ) { /** * AJAX: Get chapter group options for story * - * @since Fictioneer 5.7.4 + * @since 5.7.4 */ function fictioneer_ajax_get_chapter_groups() { diff --git a/includes/functions/_api.php b/includes/functions/_api.php index dd4eee4b..624c4f9d 100644 --- a/includes/functions/_api.php +++ b/includes/functions/_api.php @@ -8,7 +8,7 @@ if ( ! function_exists( 'fictioneer_api_get_story_node' ) ) { /** * Returns array with story data * - * @since Fictioneer 5.1 + * @since 5.1.0 * * @param int $story_id ID of the story. * @param boolean $with_chapters Whether to include chapters. Default true. @@ -265,7 +265,7 @@ if ( ! function_exists( 'fictioneer_api_get_story_node' ) ) { /** * Add GET route for single story by ID * - * @since Fictioneer 5.1 + * @since 5.1.0 */ if ( get_option( 'fictioneer_enable_storygraph_api' ) ) { @@ -289,7 +289,7 @@ if ( ! function_exists( 'fictioneer_api_request_story' ) ) { /** * Returns JSON for a single story * - * @since Fictioneer 5.1 + * @since 5.1.0 * @link https://developer.wordpress.org/rest-api/extending-the-rest-api/adding-custom-endpoints/ * * @param WP_REST_Request $WP_REST_Request Request object. @@ -344,7 +344,7 @@ if ( ! function_exists( 'fictioneer_api_request_story' ) ) { /** * Add GET route for all stories * - * @since Fictioneer 5.1 + * @since 5.1.0 */ if ( get_option( 'fictioneer_enable_storygraph_api' ) ) { @@ -368,7 +368,7 @@ if ( ! function_exists( 'fictioneer_api_request_stories' ) ) { /** * Returns JSON with all stories plus meta data * - * @since Fictioneer 5.1 + * @since 5.1.0 * @link https://developer.wordpress.org/rest-api/extending-the-rest-api/adding-custom-endpoints/ * * @param WP_REST_Request $WP_REST_Request Request object. diff --git a/includes/functions/_caching_and_transients.php b/includes/functions/_caching_and_transients.php index de8bbdd1..6a717c95 100644 --- a/includes/functions/_caching_and_transients.php +++ b/includes/functions/_caching_and_transients.php @@ -31,7 +31,7 @@ if ( ! function_exists( 'fictioneer_caching_active' ) ) { * Checks for a number of known caching plugins or the cache * compatibility option for anything not covered. * - * @since 4.0 + * @since 4.0.0 * * @return boolean Either true (active) or false (inactive or not installed). */ @@ -59,7 +59,7 @@ if ( ! function_exists( 'fictioneer_private_caching_active' ) ) { * compatibility mode is enabled. Public and private caching * contradict each other, with public caching given priority. * - * @since 5.0 + * @since 5.0.0 * * @return boolean Either true or false. */ @@ -102,7 +102,7 @@ if ( ! function_exists( 'fictioneer_purge_all_caches' ) ) { /** * Trigger the "purge all" functions of known cache plugins * - * @since 4.0 + * @since 4.0.0 * @link https://docs.litespeedtech.com/lscache/lscwp/api/#purge * @link https://docs.wp-rocket.me/article/494-how-to-clear-cache-via-cron-job#clear-cache * @link https://wp-kama.com/plugin/wp-super-cache/function/wp_cache_clean_cache @@ -179,7 +179,7 @@ if ( ! function_exists( 'fictioneer_purge_post_cache' ) ) { /** * Trigger the "purge post" functions of known cache plugins * - * @since 4.7 + * @since 4.7.0 * @link https://docs.litespeedtech.com/lscache/lscwp/api/#purge * @link https://docs.wp-rocket.me/article/494-how-to-clear-cache-via-cron-job#clear-cache * @link https://wp-kama.com/plugin/wp-super-cache/function/wpsc_delete_post_cache @@ -267,7 +267,7 @@ if ( ! function_exists( 'fictioneer_litespeed_running' ) ) { /** * Checks whether LiteSpeed Cache plugin is active * - * @since 4.0 + * @since 4.0.0 * * @return boolean Either true (active) or false (inactive or not installed) */ @@ -288,7 +288,7 @@ if ( ! function_exists( 'fictioneer_purge_template_caches' ) ) { /** * Purges all posts with the given template template * - * @since Fictioneer 5.5.2 + * @since 5.5.2 * * @param string $template The page template (without `.php`) */ @@ -324,7 +324,7 @@ if ( ! function_exists( 'fictioneer_refresh_post_caches' ) ) { * "There are only two hard things in Computer Science: cache invalidation and * naming things" -- Phil Karlton. * - * @since Fictioneer 5.0.0 + * @since 5.0.0 * * @param int $post_id Updated post ID. */ @@ -484,7 +484,7 @@ if ( ! function_exists( 'fictioneer_refresh_post_caches' ) ) { /** * Add or remove actions for `fictioneer_refresh_post_caches` * - * @since Fictioneer 5.5.2 + * @since 5.5.2 * * @param boolean $add Optional. Whether to add or remove the action. Default true. */ @@ -522,7 +522,7 @@ if ( FICTIONEER_CACHE_PURGE_ASSIST && fictioneer_caching_active() ) { /** * Returns relationship registry from options table * - * @since 5.0 + * @since 5.0.0 * * @return array The balanced array. */ @@ -552,7 +552,7 @@ function fictioneer_get_relationship_registry() { /** * Saves relationship registry to options table * - * @since 5.0 + * @since 5.0.0 * * @param array $registry Current registry to override the stored option. * @@ -566,7 +566,7 @@ function fictioneer_save_relationship_registry( $registry ) { /** * Remove relationships on delete * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $post_id The deleted post ID. */ @@ -610,7 +610,7 @@ if ( ! function_exists( 'fictioneer_track_chapter_and_story_updates' ) ) { * storage options to reflect the current state of content. This is mainly * used for caching purposes and there is no harm if these values vanish. * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param int $post_id Updated post ID. */ @@ -655,7 +655,7 @@ if ( ! function_exists( 'fictioneer_track_chapter_and_story_updates' ) ) { /** * Add or remove actions for `fictioneer_toggle_update_tracker_hooks` * - * @since Fictioneer 5.5.2 + * @since 5.5.2 * * @param boolean $add Optional. Whether to add or remove the action. Default true. */ @@ -683,7 +683,7 @@ fictioneer_toggle_update_tracker_hooks(); /** * Purge Transients used for caching when posts are updated * - * @since Fictioneer 5.4.9 + * @since 5.4.9 * * @param int $post_id Updated post ID. */ @@ -716,7 +716,7 @@ function fictioneer_purge_transients( $post_id ) { /** * Add or remove actions for `fictioneer_purge_transients` * - * @since Fictioneer 5.5.2 + * @since 5.5.2 * * @param boolean $add Optional. Whether to add or remove the action. Default true. */ @@ -740,7 +740,7 @@ fictioneer_toggle_transient_purge_hooks(); /** * Purge nav menu Transients on menu updates * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_purge_nav_menu_transients() { diff --git a/includes/functions/_cleanup.php b/includes/functions/_cleanup.php index 7ec80982..411e2c99 100644 --- a/includes/functions/_cleanup.php +++ b/includes/functions/_cleanup.php @@ -10,7 +10,7 @@ * This only runs on hardcoded cutoff dates, once. It will only run again if the * date in this function is changed on an update. * - * @since Fictioneer 5.8.7 + * @since 5.8.7 */ function fictioneer_legacy_cleanup() { @@ -49,8 +49,8 @@ add_action( 'init', 'fictioneer_legacy_cleanup', 99 ); * delete all settings and theme mods is activated, these will be removed as * well but otherwise preserved. * - * @since Fictioneer 4.7 - * @since Fictioneer 5.7.4 - Updated to use SQL queries. + * @since 4.7.0 + * @since 5.7.4 - Updated to use SQL queries. * * @global wpdb $wpdb WordPress database object. */ diff --git a/includes/functions/_content_helpers.php b/includes/functions/_content_helpers.php index 2228355e..81ec306c 100644 --- a/includes/functions/_content_helpers.php +++ b/includes/functions/_content_helpers.php @@ -8,7 +8,7 @@ if ( ! function_exists( 'fictioneer_get_excerpt' ) ) { /** * Returns the excerpt with theme adjustments * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @return string The customized excerpt. */ @@ -25,7 +25,7 @@ if ( ! function_exists( 'fictioneer_get_excerpt' ) ) { /** * Replace excerpt ellipsis * - * @since Fictioneer 5.2.5 + * @since 5.2.5 * * @return string The ellipsis (…). */ @@ -43,7 +43,7 @@ if ( ! function_exists( 'fictioneer_get_limited_excerpt' ) ) { /** * Returns excerpt with maximum length in characters * - * @since Fictioneer 3.0 + * @since 3.0 * * @param int $limit The character limit. * @param string $source Either the 'content' or 'excerpt'. Default 'excerpt'. @@ -72,7 +72,7 @@ if ( ! function_exists( 'fictioneer_first_paragraph_as_excerpt' ) ) { /** * Returns the first paragraph of the content as excerpt * - * @since Fictioneer 3.0 + * @since 3.0 * * @param string $content The content as HTML. * @@ -94,7 +94,7 @@ if ( ! function_exists( 'fictioneer_get_forced_excerpt' ) ) { /** * Returns the excerpt even if the post is protected * - * @since Fictioneer 4.5 + * @since 4.5.0 * * @param int $post_id Post ID. * @param int $limit Maximum number of characters. @@ -131,7 +131,7 @@ if ( ! function_exists( 'fictioneer_get_author_node' ) ) { /** * Returns an author's display name as link to public profile * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $author_id The author's user ID. Defaults to current post author. * @param string $classes Optional. String of CSS classes. @@ -156,7 +156,7 @@ if ( ! function_exists( 'fictioneer_the_author_node' ) ) { /** * Outputs the author node * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $author_id The author's user ID. Defaults to current post author. * @param string $classes Optional. String of CSS classes. @@ -196,7 +196,7 @@ if ( ! function_exists( 'fictioneer_get_icon' ) ) { * via the tag. The version is added as query variable for cache * busting purposes. * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param string $icon Name of the icon that matches the svg. * @param string $classes Optional. String of CSS classes. @@ -226,7 +226,7 @@ if ( ! function_exists( 'fictioneer_get_safe_title' ) ) { /** * Returns the sanitized title and accounts for empty strings * - * @since Fictioneer 4.7 + * @since 4.7.0 * @link https://developer.wordpress.org/reference/functions/wp_strip_all_tags/ * * @param int|WP_Post $post The post or post ID to get the title for. @@ -263,7 +263,7 @@ if ( ! function_exists( 'fictioneer_get_safe_title' ) ) { /** * Prepends icon to sanitized titles of sticky blog posts * - * @since Fictioneer 5.7.1 + * @since 5.7.1 * * @param string $title The sanitized title of the post. * @param int $id The ID of the post. @@ -285,7 +285,7 @@ add_filter( 'fictioneer_filter_safe_title', 'fictioneer_prefix_sticky_safe_title /** * Prepends icon to sanitized titles of protected blog posts * - * @since Fictioneer 5.7.3 + * @since 5.7.3 * * @param string $title The sanitized title of the post. * @param int $id The ID of the post. @@ -307,7 +307,7 @@ add_filter( 'fictioneer_filter_safe_title', 'fictioneer_prefix_protected_safe_ti /** * Prepends "Draft:" to sanitized titles of drafts * - * @since Fictioneer 5.7.1 + * @since 5.7.1 * * @param string $title The sanitized title of the post. * @param int $id The ID of the post. @@ -337,7 +337,7 @@ if ( ! function_exists( 'fictioneer_get_reading_time_nodes' ) ) { * Returns the estimated reading time for a given amount of words in two nodes, * a long one for desktop and a short one for mobile. * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param int $word_count The number of words. * @@ -401,7 +401,7 @@ if ( ! function_exists( 'fictioneer_get_footer_copyright_note' ) ) { /** * Returns the HTML for the footer copyright note * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $args['breadcrumbs'] Breadcrumb tuples with label (0) and link (1). * @param string $args['post_type'] Optional. Post type of the current page. @@ -432,7 +432,7 @@ if ( ! function_exists( 'fictioneer_get_footer_copyright_note' ) ) { * Only the major version number should be displayed to avoid telling potential * attackers which specific version (and weak points) to target. * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @return string The version. */ @@ -454,7 +454,7 @@ if ( ! function_exists( 'fictioneer_get_breadcrumbs' ) ) { * * Renders a breadcrumbs trail supporting RDFa to be readable by search engines. * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $args['breadcrumbs'] Breadcrumb tuples with label (0) and link (1). * @param string $args['post_type'] Optional. Post type of the current page. @@ -517,7 +517,7 @@ if ( ! function_exists( 'fictioneer_get_multi_author_nodes' ) ) { /** * Returns the HTML for the authors * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $authors Array of authors to process. * @@ -554,7 +554,7 @@ if ( ! function_exists( 'fictioneer_get_story_author_nodes' ) ) { /** * Returns the HTML for the authors on story pages * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $story_id The story ID. * @@ -579,7 +579,7 @@ if ( ! function_exists( 'fictioneer_get_story_page_cover' ) ) { /** * Returns the HTML for thumbnail on story pages * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $story Collection of story data. * @@ -618,7 +618,7 @@ if ( ! function_exists( 'fictioneer_get_subscribe_options' ) ) { /** * Returns the HTML for the subscribe buttons * - * @since 5.0 + * @since 5.0.0 * * @param int|null $post_id The post ID the buttons are for. Defaults to current. * @param int|null $author_id The author ID the buttons are for. Defaults to current. @@ -736,7 +736,7 @@ if ( ! function_exists( 'fictioneer_get_story_buttons' ) ) { /** * Returns the HTML for the story buttons * - * @since 5.0 + * @since 5.0.0 * * @param array $args['story_data'] Collection of story data. * @param int $args['story_id'] The story post ID. @@ -840,7 +840,7 @@ if ( ! function_exists( 'fictioneer_get_chapter_author_nodes' ) ) { /** * Returns the HTML for the authors on chapter pages * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $chapter_id The chapter ID. * @@ -866,7 +866,7 @@ if ( ! function_exists( 'fictioneer_get_chapter_micro_menu' ) ) { /** * Returns the HTML for the chapter warning section * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_Post|null $args['story_post'] Optional. Post object of the story. * @param int $args['chapter_id'] The chapter ID. @@ -977,7 +977,7 @@ if ( ! function_exists( 'fictioneer_get_chapter_list_items' ) ) { /** * Returns the HTML for chapter list items with icon and link * - * @since Fictioneer 5.0.0 + * @since 5.0.0 * * @return string List of chapter. */ @@ -1044,7 +1044,7 @@ if ( ! function_exists( 'fictioneer_get_recommendation_page_cover' ) ) { /** * Returns the HTML for thumbnail on recommendation pages * - * @since Fictioneer 5.0.0 + * @since 5.0.0 * * @param WP_Post $recommendation The post object. * @@ -1080,7 +1080,7 @@ if ( ! function_exists( 'fictioneer_get_taxonomy_pills' ) ) { /** * Returns the HTML for taxonomy tags * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/reference/classes/wp_term/ * * @param array $taxonomy_groups Arrays of WP_Term objects. @@ -1128,7 +1128,7 @@ if ( ! function_exists( 'fictioneer_get_rss_link' ) ) { /** * Returns the escaped RSS link * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string|null $post_type The post type. Defaults to current post type. * @param int|null $post_id The post ID. Defaults to current post ID. @@ -1179,7 +1179,7 @@ if ( ! function_exists( 'fictioneer_user_menu_items' ) ) { /** * Returns the HTML for the user submenu in the navigation bar * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @return string The HTML for the user submenu. */ @@ -1275,7 +1275,7 @@ if ( ! function_exists( 'fictioneer_get_post_meta_items' ) ) { /** * Returns the HTML for the post meta row * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $args Optional arguments. * @@ -1357,7 +1357,7 @@ if ( ! function_exists( 'fictioneer_get_card_controls' ) ) { /** * Returns the HTML for the card controls * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $story_id The story ID. * @param int $chapter_id Optional. The chapter ID (use only for chapters). @@ -1516,7 +1516,7 @@ if ( ! function_exists( 'fictioneer_echo_card' ) ) { /** * Echo large card for post in loop * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $args Optional. Card arguments. */ @@ -1653,7 +1653,7 @@ if ( ! function_exists( 'fictioneer_get_list_chapter_meta_row' ) ) { /** * Returns HTML for list chapter meta row * - * @since Fictioneer 5.1.2 + * @since 5.1.2 * * @param array $data Chapter data for the meta row. * @param array $args Optional arguments. diff --git a/includes/functions/_cpt_and_taxonomies.php b/includes/functions/_cpt_and_taxonomies.php index 4da13b53..9e3fb44c 100644 --- a/includes/functions/_cpt_and_taxonomies.php +++ b/includes/functions/_cpt_and_taxonomies.php @@ -106,7 +106,7 @@ define( /** * Register custom post type fcn_story * - * @since Fictioneer 1.0 + * @since 1.0 */ function fictioneer_fcn_story_post_type() { @@ -175,7 +175,7 @@ add_action( 'init', 'fictioneer_fcn_story_post_type', 0 ); /** * Register custom post type fcn_chapter * - * @since Fictioneer 1.0 + * @since 1.0 */ function fictioneer_fcn_chapter_post_type() { @@ -244,7 +244,7 @@ add_action( 'init', 'fictioneer_fcn_chapter_post_type', 0 ); /** * Register custom post type fcn_collection * - * @since Fictioneer 4.0 + * @since 4.0.0 */ function fictioneer_fcn_collection_post_type() { @@ -313,7 +313,7 @@ add_action( 'init', 'fictioneer_fcn_collection_post_type', 0 ); /** * Register custom post type fcn_recommendation * - * @since Fictioneer 3.0 + * @since 3.0 */ function fictioneer_fcn_recommendation_post_type() { @@ -382,7 +382,7 @@ add_action( 'init', 'fictioneer_fcn_recommendation_post_type', 0 ); /** * Register custom taxonomy fcn_genre * - * @since Fictioneer 4.3 + * @since 4.3.0 */ function fictioneer_add_genre_taxonomy() { @@ -427,7 +427,7 @@ add_action( 'init', 'fictioneer_add_genre_taxonomy', 0 ); /** * Register custom taxonomy fcn_fandom * - * @since Fictioneer 4.0 + * @since 4.0.0 */ function fictioneer_add_fandom_taxonomy() { @@ -472,7 +472,7 @@ add_action( 'init', 'fictioneer_add_fandom_taxonomy', 0 ); /** * Register custom taxonomy fcn_character * - * @since Fictioneer 4.3 + * @since 4.3.0 */ function fictioneer_add_character_taxonomy() { @@ -517,7 +517,7 @@ add_action( 'init', 'fictioneer_add_character_taxonomy', 0 ); /** * Register custom taxonomy fcn_content_warning * - * @since Fictioneer 4.7 + * @since 4.7.0 */ function fictioneer_add_content_warning_taxonomy() { @@ -562,7 +562,7 @@ add_action( 'init', 'fictioneer_add_content_warning_taxonomy', 0 ); /** * Overrides the default taxonomy capability check for categories and post tags * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param array $caps Primitive capabilities required of the user. * @param string $cap Capability being checked. @@ -593,7 +593,7 @@ add_filter( 'map_meta_cap', 'fictioneer_override_default_taxonomy_capability_che /** * Restricts tag creation for the 'post_tag' taxonomy * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param mixed $term The term to be added. * @param string $taxonomy The taxonomy type of the term. @@ -620,7 +620,7 @@ if ( ! current_user_can( 'edit_post_tags' ) && ! current_user_can( 'manage_optio /** * Removes undesired sub-menu items for taxonomies * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_remove_sub_menus() { @@ -655,7 +655,7 @@ add_action( 'admin_menu', 'fictioneer_remove_sub_menus' ); /** * Adds a filter dropdown to the chapters list table * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param string $post_type The current post type being viewed. */ diff --git a/includes/functions/_customizer-settings.php b/includes/functions/_customizer-settings.php index b1d7e88d..b379bceb 100644 --- a/includes/functions/_customizer-settings.php +++ b/includes/functions/_customizer-settings.php @@ -24,7 +24,7 @@ if ( class_exists( 'WP_Customize_Control' ) ) { /** * Add light mode customizer settings * - * @since 4.7 + * @since 4.7.0 * * @param WP_Customize_Manager $manager The customizer instance. */ @@ -1073,7 +1073,7 @@ function fictioneer_add_light_mode_customizer_settings( $manager ) { /** * Add dark mode customizer settings * - * @since 4.7 + * @since 4.7.0 * * @param WP_Customize_Manager $manager The customizer instance. */ @@ -2101,7 +2101,7 @@ function fictioneer_add_dark_mode_customizer_settings( $manager ) { /** * Add layout customizer settings * - * @since 4.7 + * @since 4.7.0 * * @param WP_Customize_Manager $manager The customizer instance. */ diff --git a/includes/functions/_customizer.php b/includes/functions/_customizer.php index 989879ce..01a85d3c 100644 --- a/includes/functions/_customizer.php +++ b/includes/functions/_customizer.php @@ -11,7 +11,7 @@ if ( ! function_exists( 'fictioneer_hex_to_rgb' ) ) { * @license MIT * @author Simon Waldherr https://github.com/SimonWaldherr * - * @since Fictioneer 4.7 + * @since 4.7.0 * @link https://github.com/SimonWaldherr/ColorConverter.php * * @param string $input The to be converted hex (six digits). @@ -61,7 +61,7 @@ if ( ! function_exists( 'fictioneer_rgb_to_hsl' ) ) { * @license MIT * @author Simon Waldherr https://github.com/SimonWaldherr * - * @since Fictioneer 4.7 + * @since 4.7.0 * @link https://github.com/SimonWaldherr/ColorConverter.php * * @param array $input The to be converted RGB. @@ -108,7 +108,7 @@ if ( ! function_exists( 'fictioneer_minify_css' ) ) { * @author Qtax https://stackoverflow.com/users/107152/qtax * @author lots0logs https://stackoverflow.com/users/2639936/lots0logs * - * @since Fictioneer 4.7 + * @since 4.7.0 * @link https://stackoverflow.com/a/15195752/17140970 * @link https://stackoverflow.com/a/44350195/17140970 * @@ -172,7 +172,7 @@ if ( ! function_exists( 'fictioneer_get_css_clamp' ) ) { /** * Generate a high-precision CSS clamp * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param int $min The minimum value. * @param int $max The maximum value. @@ -202,7 +202,7 @@ if ( ! function_exists( 'fictioneer_hsl_code' ) ) { * Example: #fcfcfd => * hsl(calc(240deg + var(--hue-rotate)) calc(20% * var(--saturation)) clamp(49.5%, 99% * var(--darken), 99.5%)) * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param string $hex The color as hex. * @param string $output Switch output style. Default 'default'. @@ -241,7 +241,7 @@ if ( ! function_exists( 'fictioneer_hsl_font_code' ) ) { * * This is a reduced variant of the regular HSL font code. * - * @since Fictioneer 4.7 + * @since 4.7.0 * @see fictioneer_hsl_code( $hex, $output ) * * @param string $hex The color as hex. @@ -267,7 +267,7 @@ if ( ! function_exists( 'fictioneer_hsl_font_code' ) ) { /** * Watches for customizer updates to delete Transients * - * @since Fictioneer 4.7 + * @since 4.7.0 */ function fictioneer_watch_for_customer_updates() { @@ -285,7 +285,7 @@ if ( ! function_exists( 'fictioneer_add_customized_light_mode_css' ) ) { /** * Add customized light mode CSS * - * @since Fictioneer 4.7 + * @since 4.7.0 */ function fictioneer_add_customized_light_mode_css() { @@ -382,7 +382,7 @@ if ( ! function_exists( 'fictioneer_add_customized_dark_mode_css' ) ) { /** * Add customized dark mode CSS * - * @since Fictioneer 4.7 + * @since 4.7.0 */ function fictioneer_add_customized_dark_mode_css() { @@ -480,7 +480,7 @@ if ( ! function_exists( 'fictioneer_add_customized_layout_css' ) ) { /** * Add customized layout CSS * - * @since Fictioneer 4.7 + * @since 4.7.0 */ function fictioneer_add_customized_layout_css() { diff --git a/includes/functions/_discord.php b/includes/functions/_discord.php index d3337960..923ed700 100644 --- a/includes/functions/_discord.php +++ b/includes/functions/_discord.php @@ -8,7 +8,7 @@ if ( ! function_exists( 'fictioneer_discord_send_message' ) ) { /** * Sends a message to a Discord channel * - * @since 4.0 + * @since 4.0.0 * @since 5.6.0 Refactored with wp_remote_post() * * @param string $webhook The webhook for the Discord channel. @@ -39,7 +39,7 @@ if ( ! function_exists( 'fictioneer_discord_send_message' ) ) { /** * Sends a comment as message to a Discord channel * - * @since 4.0 + * @since 4.0.0 * @see fictioneer_discord_send_message() * * @param int $comment_id The comment ID. diff --git a/includes/functions/_epub.php b/includes/functions/_epub.php index 74ede130..57ad85ea 100644 --- a/includes/functions/_epub.php +++ b/includes/functions/_epub.php @@ -7,7 +7,7 @@ /** * Add route to ePUB script * - * @since Fictioneer 4.0 + * @since 4.0.0 */ function fictioneer_add_epub_download_endpoint() { @@ -23,7 +23,7 @@ if ( ! function_exists( 'fictioneer_download_epub' ) ) { /** * Start and count ePUB download * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param string $file_name File name of the ePUB to download. * @param WP_Post|null $story_id Optional. The story post. @@ -94,7 +94,7 @@ if ( ! function_exists( 'fictioneer_epub_return_and_exit' ) ) { /** * Abort, redirect home, and terminate script * - * @since Fictioneer 4.0 + * @since 4.0.0 */ function fictioneer_epub_return_and_exit() { @@ -107,7 +107,7 @@ if ( ! function_exists( 'fictioneer_nav_point' ) ) { /** * Create an return navPoint node * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param DOMDocument $doc The document to add the node to. * @param int $index Current numerical index. @@ -141,7 +141,7 @@ if ( ! function_exists( 'fictioneer_fix_html_entities' ) ) { /** * Replace invalid HTML entities with XML entities * - * @since Fictioneer 5.0.6 + * @since 5.0.6 * * @param string $text The string with invalid HTML entities. * @@ -173,7 +173,7 @@ if ( ! function_exists( 'fictioneer_fix_tags' ) ) { /** * Replace tags not valid in ePUB * - * @since Fictioneer 5.8.2 + * @since 5.8.2 * * @param string $xml The XML string. * @@ -208,7 +208,7 @@ if ( ! function_exists( 'fictioneer_prepare_build_directory' ) ) { /** * Prepare clean directory and base files for build process * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $dir The build template directory in the theme folder. * @param string $epub_dir The target ePUB directory in the uploads folder. @@ -280,7 +280,7 @@ if ( ! function_exists( 'fictioneer_add_epub_cover' ) ) { /** * Copy cover image and HTML file to the ePUB directory * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://www.php.net/manual/en/class.domelement.php * * @param string $dir The build template directory in the theme folder. @@ -328,7 +328,7 @@ if ( ! function_exists( 'fictioneer_add_epub_chapters' ) ) { /** * Process and add chapters to ePUB directory and lists * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $dir The build template directory in the theme folder. * @param string $epub_dir The target ePUB directory in the uploads folder. @@ -598,7 +598,7 @@ if ( ! function_exists( 'fictioneer_generate_epub_opf' ) ) { /** * Generate and add OPF file to ePUB directory * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $story_id The story ID the ePUB is based on. * @param array $args Collection of ePUB data. @@ -738,7 +738,7 @@ if ( ! function_exists( 'fictioneer_generate_epub_ncx' ) ) { /** * Generate and add NCX file to ePUB directory * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://www.php.net/manual/en/class.domelement.php * * @param int $story_id The story ID the ePUB is based on. @@ -804,7 +804,7 @@ if ( ! function_exists( 'fictioneer_generate_epub_toc' ) ) { /** * Generate and add table of content file to ePUB directory * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $args Collection of ePUB data. */ @@ -849,7 +849,7 @@ if ( ! function_exists( 'fictioneer_generate_epub_front_matter' ) ) { /** * Generate and add front matter file to ePUB directory * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $story_id The story ID the ePUB is based on. * @param array $args Collection of ePUB data. @@ -946,7 +946,7 @@ if ( ! function_exists( 'fictioneer_generate_epub_afterword' ) ) { /** * Generate and add afterword file to ePUB directory * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $story_id The story ID the ePUB is based on. * @param array $args Collection of ePUB data. @@ -1008,7 +1008,7 @@ if ( ! function_exists( 'fictioneer_generate_epub_afterword' ) ) { /** * Generate ePUB and save it to the uploads directory * - * @since Fictioneer 4.0 + * @since 4.0.0 */ function fictioneer_generate_epub() { @@ -1200,7 +1200,7 @@ add_action( 'template_redirect', 'fictioneer_generate_epub', 10 ); /** * Start ePUB download if ready * - * @since Fictioneer 5.7.2 + * @since 5.7.2 */ function fictioneer_ajax_download_epub() { diff --git a/includes/functions/_forms.php b/includes/functions/_forms.php index 1a47bee1..5674540c 100644 --- a/includes/functions/_forms.php +++ b/includes/functions/_forms.php @@ -7,7 +7,7 @@ /** * Submit comment form via AJAX * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ */ diff --git a/includes/functions/_meta_fields.php b/includes/functions/_meta_fields.php index 29544925..f3f9919c 100644 --- a/includes/functions/_meta_fields.php +++ b/includes/functions/_meta_fields.php @@ -1636,7 +1636,7 @@ function fictioneer_ajax_get_relationship_featured( $post_id, $meta_key ) { /** * Append classes to the metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param array $classes An array of postbox classes. * @@ -1680,7 +1680,7 @@ foreach ( ['post', 'fcn_story', 'fcn_chapter'] as $type ) { /** * Adds story meta metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 */ function fictioneer_add_story_meta_metabox() { @@ -1698,7 +1698,7 @@ add_action( 'add_meta_boxes', 'fictioneer_add_story_meta_metabox' ); /** * Render story meta metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param WP_Post $post The current post object. */ @@ -1863,7 +1863,7 @@ function fictioneer_render_story_meta_metabox( $post ) { /** * Adds story data metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 */ function fictioneer_add_story_data_metabox() { @@ -1881,7 +1881,7 @@ add_action( 'add_meta_boxes', 'fictioneer_add_story_data_metabox' ); /** * Render story data metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param WP_Post $post The current post object. */ @@ -1994,7 +1994,7 @@ function fictioneer_render_story_data_metabox( $post ) { /** * Adds story epub metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 */ function fictioneer_add_story_epub_metabox() { @@ -2015,7 +2015,7 @@ if ( get_option( 'fictioneer_enable_epubs' ) ) { /** * Render story epub metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param WP_Post $post The current post object. */ @@ -2090,7 +2090,7 @@ function fictioneer_render_story_epub_metabox( $post ) { /** * Save story metaboxes * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param int $post_id The post ID. */ @@ -2370,7 +2370,7 @@ add_action( 'save_post', 'fictioneer_save_story_metaboxes' ); /** * Adds chapter meta metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 */ function fictioneer_add_chapter_meta_metabox() { @@ -2388,7 +2388,7 @@ add_action( 'add_meta_boxes', 'fictioneer_add_chapter_meta_metabox' ); /** * Render chapter meta metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param WP_Post $post The current post object. */ @@ -2538,7 +2538,7 @@ function fictioneer_render_chapter_meta_metabox( $post ) { /** * Adds chapter data metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 */ function fictioneer_add_chapter_data_metabox() { @@ -2556,7 +2556,7 @@ add_action( 'add_meta_boxes', 'fictioneer_add_chapter_data_metabox' ); /** * Render chapter data metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param WP_Post $post The current post object. */ @@ -2728,7 +2728,7 @@ function fictioneer_render_chapter_data_metabox( $post ) { /** * Save chapter metaboxes * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param int $post_id The post ID. */ @@ -2909,7 +2909,7 @@ add_action( 'save_post', 'fictioneer_save_chapter_metaboxes' ); /** * Adds advanced metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 */ function fictioneer_add_advanced_metabox() { @@ -2927,7 +2927,7 @@ add_action( 'add_meta_boxes', 'fictioneer_add_advanced_metabox' ); /** * Render advanced metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param WP_Post $post The current post object. */ @@ -3060,7 +3060,7 @@ function fictioneer_render_advanced_metabox( $post ) { /** * Save advanced metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param int $post_id The post ID. */ @@ -3189,7 +3189,7 @@ add_action( 'save_post', 'fictioneer_save_advanced_metabox' ); /** * Adds support links metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 */ function fictioneer_add_support_links_metabox() { @@ -3207,7 +3207,7 @@ add_action( 'add_meta_boxes', 'fictioneer_add_support_links_metabox' ); /** * Render support links metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param WP_Post $post The current post object. */ @@ -3276,7 +3276,7 @@ function fictioneer_render_support_links_metabox( $post ) { /** * Save support links metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param int $post_id The post ID. */ @@ -3377,7 +3377,7 @@ add_action( 'save_post', 'fictioneer_save_support_links_metabox' ); /** * Adds featured content side metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 */ function fictioneer_add_featured_content_metabox() { @@ -3395,7 +3395,7 @@ add_action( 'add_meta_boxes', 'fictioneer_add_featured_content_metabox' ); /** * Render featured content metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param WP_Post $post The current post object. */ @@ -3453,7 +3453,7 @@ function fictioneer_render_featured_content_metabox( $post ) { /** * Save post metaboxes * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param int $post_id The post ID. */ @@ -3534,7 +3534,7 @@ add_action( 'save_post', 'fictioneer_save_post_metaboxes' ); /** * Update relationship registry for 'post' post types * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $post_id The post ID. */ @@ -3588,7 +3588,7 @@ function fictioneer_update_post_relationship_registry( $post_id ) { /** * Adds collection data metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 */ function fictioneer_add_collection_data_metabox() { @@ -3606,7 +3606,7 @@ add_action( 'add_meta_boxes', 'fictioneer_add_collection_data_metabox' ); /** * Render collection data metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param WP_Post $post The current post object. */ @@ -3688,7 +3688,7 @@ function fictioneer_render_collection_data_metabox( $post ) { /** * Save collection metaboxes * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param int $post_id The post ID. */ @@ -3797,7 +3797,7 @@ add_action( 'save_post', 'fictioneer_save_collection_metaboxes' ); /** * Adds recommendation data metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 */ function fictioneer_add_recommendation_data_metabox() { @@ -3815,7 +3815,7 @@ add_action( 'add_meta_boxes', 'fictioneer_add_recommendation_data_metabox' ); /** * Render recommendation data metabox * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param WP_Post $post The current post object. */ @@ -3897,7 +3897,7 @@ function fictioneer_render_recommendation_data_metabox( $post ) { /** * Save recommendation metaboxes * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param int $post_id The post ID. */ diff --git a/includes/functions/_oauth.php b/includes/functions/_oauth.php index 1044b52f..cd59c992 100644 --- a/includes/functions/_oauth.php +++ b/includes/functions/_oauth.php @@ -45,7 +45,7 @@ define( /** * Add route to OAuth script * - * @since Fictioneer 4.0 + * @since 4.0.0 */ function fictioneer_add_oauth2_endpoint() { @@ -69,7 +69,7 @@ if ( ! function_exists( 'fictioneer_get_oauth_login_link' ) ) { * If the OAuth for the channel is not properly set up or the feature disabled, * an empty string will be returned instead. * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param string $channel The channel (discord, google, twitch, or patreon). * @param string $content Content of the link. @@ -107,7 +107,7 @@ if ( ! function_exists( 'fictioneer_get_oauth_links' ) ) { /** * Returns OAuth links for all channels * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param boolean|string $label Optional. Whether to show the channel as * label and the text before that (if any). @@ -169,8 +169,8 @@ if ( ! function_exists( 'fictioneer_get_oauth_links' ) ) { * for a token, which is then used to make yet another request for the user data * to authenticate the user. The connection is severed after that. * - * @since Fictioneer 4.0 - * @since Fictioneer 5.7.5 - Refactored. + * @since 4.0.0 + * @since 5.7.5 - Refactored. * @link https://developer.wordpress.org/reference/hooks/template_redirect/ * @link https://dev.twitch.tv/docs/authentication * @link https://discord.com/developers/docs/topics/oauth2 @@ -314,7 +314,7 @@ if ( ! function_exists( 'fictioneer_process_oauth_discord' ) ) { /** * Retrieve user from Discord * - * @since Fictioneer 4.0 + * @since 4.0.0 * @see fictioneer_make_oauth_user() * * @param string $url The request URL. @@ -386,7 +386,7 @@ if ( ! function_exists( 'fictioneer_process_oauth_twitch' ) ) { /** * Retrieve user from Twitch * - * @since Fictioneer 4.0 + * @since 4.0.0 * @see fictioneer_make_oauth_user() * * @param string $url The request URL. @@ -453,7 +453,7 @@ if ( ! function_exists( 'fictioneer_process_oauth_google' ) ) { /** * Retrieve user from Google * - * @since Fictioneer 4.0 + * @since 4.0.0 * @see fictioneer_make_oauth_user() * * @param string $url The request URL. @@ -522,7 +522,7 @@ if ( ! function_exists( 'fictioneer_process_oauth_patreon' ) ) { /** * Retrieve user from Patreon * - * @since Fictioneer 4.0 + * @since 4.0.0 * @see fictioneer_make_oauth_user() * * @param string $url The request URL. @@ -610,7 +610,7 @@ if ( ! function_exists( 'fictioneer_make_oauth_user' ) ) { /** * Log in or register user * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param array $args Array of user data. * @@ -765,8 +765,8 @@ if ( ! function_exists( 'fictioneer_oauth_die' ) ) { /** * Outputs a formatted error message and stops script execution * - * @since Fictioneer 5.5.2 - * @since Fictioneer 5.7.5 - Refactored.. + * @since 5.5.2 + * @since 5.7.5 - Refactored.. * * @param string $message The error message. * @param string $title Optional. Title of the error page. Default 'Error'. @@ -806,8 +806,8 @@ if ( ! function_exists( 'fictioneer_set_oauth_constants' ) ) { /** * Set up all constants * - * @since Fictioneer 4.0 - * @since Fictioneer 5.7.5 - Refactored.. + * @since 4.0.0 + * @since 5.7.5 - Refactored.. */ function fictioneer_set_oauth_constants() { @@ -866,8 +866,8 @@ if ( ! function_exists( 'fictioneer_oauth2_exit_and_return' ) ) { /** * Terminate the script and redirect back * - * @since Fictioneer 4.0 - * @since Fictioneer 5.7.5 - Refactored.. + * @since 4.0.0 + * @since 5.7.5 - Refactored.. * * @param string $return_url Optional. URL to return to. * @param string $state Optional. The state hash. @@ -909,8 +909,8 @@ if ( ! function_exists( 'fictioneer_get_oauth_client_credentials' ) ) { /** * Return credentials for the given channel * - * @since Fictioneer 4.0 - * @since Fictioneer 5.7.5 - Refactored.. + * @since 4.0.0 + * @since 5.7.5 - Refactored.. * * @param string $channel The channel to retrieve the credential for. * @param string $type Optional. The type of credential to retrieve, @@ -928,8 +928,8 @@ if ( ! function_exists( 'fictioneer_get_oauth_token' ) ) { /** * Get the OAuth2 access token * - * @since Fictioneer 4.0 - * @since Fictioneer 5.7.5 - Refactored.. + * @since 4.0.0 + * @since 5.7.5 - Refactored.. * * @param string $url URL to make the API request to. * @param array $post Post body. @@ -970,8 +970,8 @@ if ( ! function_exists( 'fictioneer_revoke_oauth_token' ) ) { /** * Revoke an OAuth2 access token * - * @since Fictioneer 4.0 - * @since Fictioneer 5.7.5 - Refactored.. + * @since 4.0.0 + * @since 5.7.5 - Refactored.. * * @param string $url URL to make the API request to. * @param array $post Post body. @@ -1003,8 +1003,8 @@ if ( ! function_exists( 'fictioneer_get_oauth_code' ) ) { /** * Redirect to OAuth provider to retrieve permissions and the code * - * @since Fictioneer 4.0 - * @since Fictioneer 5.7.5 - Refactored.. + * @since 4.0.0 + * @since 5.7.5 - Refactored.. */ function fictioneer_get_oauth_code() { @@ -1059,7 +1059,7 @@ if ( ! function_exists( 'fictioneer_delete_expired_oauth_transients' ) ) { /** * Deletes expires OAuth Transients * - * @since Fictioneer 5.7.5 + * @since 5.7.5 */ function fictioneer_delete_expired_oauth_transients() { diff --git a/includes/functions/_post_updates.php b/includes/functions/_post_updates.php index 2f997e4f..b20900c3 100644 --- a/includes/functions/_post_updates.php +++ b/includes/functions/_post_updates.php @@ -81,7 +81,7 @@ add_action( 'save_post', 'fictioneer_save_word_count' ); /** * Stores the original publish date of a post in post meta * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param int $post_id The ID of the post being saved. * @param WP_Post $post The post object being saved. @@ -113,7 +113,7 @@ add_action( 'save_post', 'fictioneer_store_original_publish_date', 10, 2 ); /** * Returns story changelog * - * @since Fictioneer 5.7.5 + * @since 5.7.5 * * @param int $story_id The story post ID. * @@ -148,7 +148,7 @@ function fictioneer_get_story_changelog( $story_id ) { /** * Logs changes to story chapters * - * @since Fictioneer 5.7.5 + * @since 5.7.5 * * @param int $story_id The story post ID. * @param array $current Current chapters. @@ -202,7 +202,7 @@ function fictioneer_log_story_chapter_changes( $story_id, $current, $previous, $ /** * Logs status changes of story chapters * - * @since Fictioneer 5.7.5 + * @since 5.7.5 * * @param string $new_status The old status. * @param string $old_status The new status. @@ -276,7 +276,7 @@ if ( FICTIONEER_ENABLE_STORY_CHANGELOG ) { /** * Removes chapter from story * - * @since Fictioneer 5.7.5 + * @since 5.7.5 * * @param int $chapter_id The chapter post ID. */ @@ -322,7 +322,7 @@ add_action( 'trashed_post', 'fictioneer_remove_chapter_from_story' ); /** * Wrapper for actions when a chapter is set to draft * - * @since Fictioneer 5.7.5 + * @since 5.7.5 * * @param WP_Post $post The post object. */ diff --git a/includes/functions/_query_helpers.php b/includes/functions/_query_helpers.php index 009eb096..8d27eba8 100644 --- a/includes/functions/_query_helpers.php +++ b/includes/functions/_query_helpers.php @@ -7,7 +7,7 @@ /** * Returns list of allowed orderby parameters for WP_Query * - * @since Fictioneer 5.7.0 + * @since 5.7.0 * * @return array List of allowed orderby parameters. */ @@ -26,7 +26,7 @@ if ( ! function_exists( 'fictioneer_get_card_list' ) ) { /** * Returns the query and HTML list items for a post type * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $type Either story, chapter, collection, recommendation, or post. * @param array $query_args Optional. Query arguments merged with the defaults. diff --git a/includes/functions/_roles.php b/includes/functions/_roles.php index 9269c7e8..672e7df7 100644 --- a/includes/functions/_roles.php +++ b/includes/functions/_roles.php @@ -71,7 +71,7 @@ define( /** * Initialize user roles if not already done * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param boolean $force Optional. Whether to force initialization. */ @@ -113,7 +113,7 @@ add_action( 'admin_init', 'fictioneer_initialize_roles' ); /** * Build user roles with custom capabilities * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_setup_roles() { @@ -325,7 +325,7 @@ function fictioneer_setup_roles() { /** * Add custom moderator role * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_add_moderator_role() { @@ -443,7 +443,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Prevent access to the admin panel * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_restrict_admin_panel() { @@ -466,7 +466,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Remove admin dashboard widgets * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_remove_dashboard_widgets() { @@ -483,7 +483,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Remove the dashboard menu page * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_remove_dashboard_menu() { @@ -494,7 +494,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Redirect from dashboard to user profile * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_skip_dashboard() { @@ -514,7 +514,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Remove dashboard from admin bar dropdown * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_remove_dashboard_from_admin_bar() { @@ -552,7 +552,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Filters the page template selection * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param array $templates Array of templates ('name' => 'Display Name'). * @@ -573,7 +573,7 @@ if ( ! current_user_can( 'manage_options' ) ) { * If the user lacks permission and the page template is not listed * as allowed for everyone, the meta update is stopped. * - * @since Fictioneer 5.6.2 + * @since 5.6.2 * * @param null|mixed $check Whether to allow updating metadata for the given type. * @param int $object_id ID of the object metadata is for. @@ -613,7 +613,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Remove comment item from admin bar * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_remove_comments_from_admin_bar() { @@ -625,7 +625,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Remove comments menu * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_remove_comments_menu_page() { @@ -635,7 +635,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Restrict menu access for non-administrators * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_restrict_comment_edit() { @@ -650,7 +650,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Remove comments column * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param array $columns The table columns. * @@ -676,7 +676,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Only allow editing of comments * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param array $all_caps An array of all the user's capabilities. * @param array $cap Primitive capabilities that are being checked. @@ -710,7 +710,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Restrict comment editing * - * @since Fictioneer 5.7.3 + * @since 5.7.3 * * @param array $caps Primitive capabilities required of the user. * @param string $cap Capability being checked. @@ -746,7 +746,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Reduce admin panel * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_reduce_admin_panel() { @@ -759,7 +759,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Restrict menu access for non-administrators * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_restrict_admin_only_pages() { @@ -787,7 +787,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Remove update notice * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_remove_update_notice(){ @@ -807,7 +807,7 @@ if ( ! current_user_can( 'manage_options' ) ) { * This is not ideal, but an edge case. Someone who cannot use shortcodes * usually also cannot edit others posts. * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param array $data An array of slashed, sanitized, and processed post data. * @@ -878,7 +878,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Prevent users from seeing uploaded files of others * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param WP_Query $query The queried attachments. */ @@ -901,7 +901,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Prevent users from seeing uploaded files of others in the list view * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param WP_Query $wp_query The current WP_Query. */ @@ -935,7 +935,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * User cannot edit the files of others * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param array $caps Primitive capabilities required of the user. * @param string $cap Capability being checked. @@ -977,7 +977,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * User cannot delete the files of others * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param array $caps Primitive capabilities required of the user. * @param string $cap Capability being checked. @@ -1019,7 +1019,7 @@ if ( ! current_user_can( 'manage_options' ) ) { /** * Remove email and name columns from user table * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param array $column_headers Columns to show in the user table. * @@ -1039,7 +1039,7 @@ if ( ! current_user_can( 'manage_options' ) ) { * The quick edit form for comments shows unfortunately private data that * we want to hide if that setting is enabled. * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param array $actions Actions per row in the comments table. * @@ -1058,7 +1058,7 @@ if ( ! current_user_can( 'manage_options' ) ) { * Since these are not normally accessible, we need to quickly hide them * with JavaScript. This is not a great solution but better than nothing. * - * @since Fictioneer 4.7 + * @since 4.7.0 */ function fictioneer_hide_private_data() { diff --git a/includes/functions/_schemas.php b/includes/functions/_schemas.php index a0bf17d4..046fb809 100644 --- a/includes/functions/_schemas.php +++ b/includes/functions/_schemas.php @@ -21,7 +21,7 @@ if ( ! function_exists( 'fictioneer_get_schema_node_root' ) ) { /** * Return schema graph root node * - * @since Fictioneer 4.0 + * @since 4.0.0 */ function fictioneer_get_schema_node_root() { @@ -40,7 +40,7 @@ if ( ! function_exists( 'fictioneer_get_schema_primary_image' ) ) { /** * Returns primary image for schema graph * - * @since Fictioneer 4.0 + * @since 4.0.0 * @link https://developer.wordpress.org/reference/functions/wp_get_attachment_image_src/ * * @param int|null $post_id The post ID the primary image is from. @@ -78,7 +78,7 @@ if ( ! function_exists( 'fictioneer_get_schema_node_website' ) ) { /** * Returns the website node for the schema graph * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param string|null $description The website description. * @@ -106,7 +106,7 @@ if ( ! function_exists( 'fictioneer_get_schema_node_image' ) ) { /** * Returns the primary image node for the schema graph * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param array|boolean|null $image_data The image data with URL (0), width (1), and height (2). * @@ -138,7 +138,7 @@ if ( ! function_exists( 'fictioneer_get_schema_node_webpage' ) ) { /** * Returns the webpage node for the schema graph * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param string|array $type The type(s) of the page, which can be an array. * @param string $name Title of the page. @@ -184,7 +184,7 @@ if ( ! function_exists( 'fictioneer_get_schema_node_article' ) ) { /** * Returns the article node for the schema graph * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param string|array $type The type(s) of the article, which can be an array. * @param string $description Description of the article. @@ -257,7 +257,7 @@ if ( ! function_exists( 'fictioneer_get_schema_node_list' ) ) { /** * Returns the list node for the schema graph * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param array $list List of WP_Post objects. * @param string $name Name of the list. @@ -311,7 +311,7 @@ if ( ! function_exists( 'fictioneer_get_schema_node_list' ) ) { /** * Output schema graph on selected pages * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int|null $post_id Optional. The current post ID. */ diff --git a/includes/functions/_search.php b/includes/functions/_search.php index 477c7935..67d1e5c1 100644 --- a/includes/functions/_search.php +++ b/includes/functions/_search.php @@ -8,7 +8,7 @@ if ( ! function_exists( 'fcn_keyword_search_taxonomies_input' ) ) { /** * Output keyword taxonomies input field for search form * - * @since 5.0 + * @since 5.0.0 * * @param array $taxonomies Array of WP_Term objects. * @param string $query_var Name of the submitted collection field. @@ -104,7 +104,7 @@ if ( ! function_exists( 'fcn_keyword_search_authors_input' ) ) { /** * Output keyword authors input field for search form * - * @since 5.0 + * @since 5.0.0 * * @param array $authors Array of WP_User objects. * @param string $query_var Name of the submitted collection field. @@ -179,7 +179,7 @@ if ( ! function_exists( 'fcn_keyword_search_authors_input' ) ) { /** * Extend search query with custom input * - * @since 5.0 + * @since 5.0.0 * * @param WP_Query $query The query. */ diff --git a/includes/functions/_seo.php b/includes/functions/_seo.php index ecf39f2d..8c3935b7 100644 --- a/includes/functions/_seo.php +++ b/includes/functions/_seo.php @@ -7,7 +7,7 @@ /** * Adds a SEO metabox to selected post types * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param string $post_type Post type. * @param WP_Post $post Post object. @@ -47,7 +47,7 @@ if ( ! function_exists( 'fictioneer_seo_fields' ) ) { /** * Output HTML for SEO metabox * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param object $post The post object. */ @@ -152,7 +152,7 @@ if ( ! function_exists( 'fictioneer_seo_fields' ) ) { /** * Save SEO metabox data * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The post ID. */ @@ -207,7 +207,7 @@ if ( ! function_exists( 'fictioneer_get_seo_title' ) ) { /** * Get SEO title * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id Optional. The post ID. * @param array $args Optional. Array of arguments. @@ -362,7 +362,7 @@ if ( ! function_exists( 'fictioneer_get_seo_description' ) ) { /** * Get SEO description * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id Optional. The post ID. * @param array $args Optional. Array of arguments. @@ -527,7 +527,7 @@ if ( ! function_exists( 'fictioneer_get_seo_image' ) ) { /** * Get SEO image data array * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id Optional. The post ID. * @@ -614,7 +614,7 @@ if ( ! function_exists( 'fictioneer_get_seo_image' ) ) { /** * Output HTML SEO meta * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_output_head_seo() { diff --git a/includes/functions/_shortcodes.php b/includes/functions/_shortcodes.php index bd486a17..97a13b7a 100644 --- a/includes/functions/_shortcodes.php +++ b/includes/functions/_shortcodes.php @@ -50,7 +50,7 @@ if ( ! function_exists( 'fictioneer_shortcode_query' ) ) { /** * Register relationships for posts with certain shortcodes * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_update_shortcode_relationships( $post_id, $post ) { @@ -207,7 +207,7 @@ function fictioneer_get_default_shortcode_args( $attr, $def_count = -1 ) { /** * Extract taxonomies from shortcode attributes * - * @since Fictioneer 5.2.0 + * @since 5.2.0 * * @param array $attr Attributes of the shortcode. * @@ -254,7 +254,7 @@ function fictioneer_get_shortcode_taxonomies( $attr ) { /** * Get shortcode Tax Query * - * @since Fictioneer 5.2.0 + * @since 5.2.0 * * @param array $args Arguments of the shortcode partial. * @@ -329,7 +329,7 @@ function fictioneer_get_shortcode_tax_query( $args ) { /** * Shortcode to display showcase * - * @since 5.0 + * @since 5.0.0 * * @param string $attr['for'] What the showcase is for. Allowed are chapters, * collections, recommendations, and stories. @@ -575,7 +575,7 @@ add_shortcode( 'fictioneer_story_cards', 'fictioneer_shortcode_latest_stories' ) /** * Shortcode to show latest story updates * - * @since 4.3 + * @since 4.3.0 * * @param string|null $attr['count'] Optional. Maximum number of items. Default 4. * @param string|null $attr['author'] Optional. Limit posts to a specific author. @@ -647,7 +647,7 @@ add_shortcode( 'fictioneer_update_cards', 'fictioneer_shortcode_latest_story_upd /** * Shortcode to show latest recommendations * - * @since 4.0 + * @since 4.0.0 * * @param string|null $attr['count'] Optional. Maximum number of items. Default 4. * @param string|null $attr['author'] Optional. Limit posts to a specific author. @@ -720,7 +720,7 @@ add_shortcode( 'fictioneer_recommendation_cards', 'fictioneer_shortcode_latest_r /** * Shortcode to show the latest post * - * @since 4.0 + * @since 4.0.0 * * @param string|null $attr['count'] Optional. Maximum number of items. Default 1. * @param string|null $attr['author'] Optional. Limit posts to a specific author. @@ -777,7 +777,7 @@ add_shortcode( 'fictioneer_latest_post', 'fictioneer_shortcode_latest_posts' ); /** * Shortcode to show bookmarks * - * @since 4.0 + * @since 4.0.0 * * @param string|null $attr['count'] Optional. Maximum number of items. Default -1 (all). * @param string|null $attr['show_empty'] Optional. Whether to show the "no bookmarks" message. Default false. @@ -815,7 +815,7 @@ add_shortcode( 'fictioneer_bookmarks', 'fictioneer_shortcode_bookmarks' ); * * Renders buttons to handle your consent and stored cookies. * - * @since 4.7 + * @since 4.7.0 * * @return string The rendered shortcode HTML. */ @@ -834,7 +834,7 @@ add_shortcode( 'fictioneer_cookie_buttons', 'fictioneer_shortcode_cookie_buttons /** * Shortcode to show chapter list outside of story pages * - * @since 5.0 + * @since 5.0.0 * @see fictioneer_validate_id() * @see fictioneer_get_story_data() * @@ -1082,7 +1082,7 @@ add_shortcode( 'fictioneer_chapter_list', 'fictioneer_shortcode_chapter_list' ); /** * Shortcode to show a contact form * - * @since 5.0 + * @since 5.0.0 * * @param string|null $attr['title'] Optional. Title of the form. * @param string|null $attr['submit'] Optional. Submit button caption. @@ -1192,7 +1192,7 @@ add_shortcode( 'fictioneer_contact_form', 'fictioneer_shortcode_contact_form' ); /** * Shortcode to show the latest post * - * @since 5.0 + * @since 5.0.0 * * @param string|null $attr['simple'] Optional. Hide the advanced options. * @param string|null $attr['placeholder'] Optional. Placeholder text. diff --git a/includes/functions/_sitemap.php b/includes/functions/_sitemap.php index 71aad4d7..99219398 100644 --- a/includes/functions/_sitemap.php +++ b/includes/functions/_sitemap.php @@ -7,7 +7,7 @@ /** * Add rewrite rule for custom theme sitemap * - * @since Fictioneer 5.8.7 + * @since 5.8.7 */ function fictioneer_add_sitemap_rewrite_rule() { @@ -21,7 +21,7 @@ if ( get_option( 'fictioneer_enable_sitemap' ) && ! fictioneer_seo_plugin_active /** * Serve the custom theme sitemap.xml * - * @since Fictioneer 5.8.7 + * @since 5.8.7 */ function fictioneer_serve_sitemap() { @@ -52,7 +52,7 @@ add_action( 'template_redirect', 'fictioneer_serve_sitemap' ); /** * Get tag helper * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param string $content Content for the tag. * @@ -66,7 +66,7 @@ function fictioneer_loc_node( $content ) { /** * Get tag helper * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param string $content Content for the tag. * @@ -80,7 +80,7 @@ function fictioneer_lastmod_node( $content ) { /** * Get tag helper * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param string $content Content for the tag. * @@ -94,7 +94,7 @@ function fictioneer_frequency_node( $content ) { /** * Get node helper * - * @since Fictioneer 4.0 + * @since 4.0.0 * @see fictioneer_loc_node() * @see fictioneer_lastmod_node() * @see fictioneer_frequency_node() @@ -118,8 +118,8 @@ function fictioneer_url_node( $loc, $lastmod = null, $freq = null ) { /** * Generate theme sitemap * - * @since Fictioneer 4.0 - * @since Fictioneer 5.8.7 - Create on demand, not on post save. + * @since 4.0.0 + * @since 5.8.7 - Create on demand, not on post save. */ function fictioneer_create_sitemap() { diff --git a/includes/functions/_theme_setup.php b/includes/functions/_theme_setup.php index 54f5ac37..12545010 100644 --- a/includes/functions/_theme_setup.php +++ b/includes/functions/_theme_setup.php @@ -207,7 +207,7 @@ add_filter( 'wp_unique_post_slug', 'fictioneer_protect_reserved_post_slugs' ); /** * Fictioneer version of _custom_background_cb() for custom backgrounds * - * @since 4.7 + * @since 4.7.0 * @link https://developer.wordpress.org/reference/functions/_custom_background_cb/ */ @@ -279,7 +279,7 @@ function fictioneer_custom_background() { /** * Update list of allowed tags * - * @since 4.7 + * @since 4.7.0 * * @global array $allowedtags Array of allowed tags. */ @@ -304,7 +304,7 @@ add_action( 'init', 'fictioneer_modify_allowed_tags', 20 ); /** * Injects attributes and classes into the root * - * @since 4.7 + * @since 4.7.0 */ function fictioneer_root_attributes() { @@ -375,7 +375,7 @@ function fictioneer_root_attributes() { /** * Add additional classes to the frontend * - * @since Fictioneer 5.0.0 + * @since 5.0.0 * * @param array $classes Current body classes. * @@ -430,7 +430,7 @@ if ( ! is_admin() ) { /** * Add additional classes to the admin * - * @since Fictioneer 5.0.0 + * @since 5.0.0 * * @param string $classes Current body classes separated by whitespace. * @@ -585,7 +585,7 @@ add_action( 'wp_enqueue_scripts', 'fictioneer_style_queue' ); /** * Enqueues customizer stylesheets * - * @since 5.0 + * @since 5.0.0 */ function fictioneer_customizer_queue() { @@ -938,7 +938,7 @@ add_action( 'wp_enqueue_scripts', 'fictioneer_load_script_translations', 99 ); /** * Removed the jQuery migrate script * - * @since 5.0 + * @since 5.0.0 * * @param object $scripts The loaded scripts. */ @@ -969,7 +969,7 @@ if ( ! is_admin() && ! get_option( 'fictioneer_enable_jquery_migrate' ) ) { /** * Change replace tag for Autoptimize (if installed) * - * @since 4.0 + * @since 4.0.0 * @link https://github.com/wp-plugins/autoptimize * * @param string $replacetag The original replace tag. @@ -983,7 +983,7 @@ add_filter( 'autoptimize_filter_js_replacetag', 'fictioneer_replace_ao_insert_po /** * Exclude scripts from Autoptimize (if installed) * - * @since 4.0 + * @since 4.0.0 * @link https://github.com/wp-plugins/autoptimize * * @param string $exclude List of default excludes. @@ -997,7 +997,7 @@ add_filter( 'autoptimize_filter_js_exclude', 'fictioneer_ao_exclude_scripts', 10 /** * Exclude stylesheets from Autoptimize (if installed) * - * @since 4.0 + * @since 4.0.0 * @link https://github.com/wp-plugins/autoptimize * * @param string $exclude List of default excludes. @@ -1019,7 +1019,7 @@ if ( ! function_exists( 'fictioneer_output_head_fonts' ) ) { * Critical fonts that need to be loaded as fast as possible and are * therefore inlined in the . * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_output_head_fonts() { @@ -1040,7 +1040,7 @@ if ( ! function_exists( 'fictioneer_output_head_meta' ) ) { /** * Output HTML meta * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_output_head_meta() { @@ -1071,7 +1071,7 @@ if ( ! function_exists( 'fictioneer_output_head_meta' ) ) { * * This is called in the header.php template. * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_add_noindex_to_robots( $robots ) { @@ -1093,7 +1093,7 @@ if ( ! function_exists( 'fictioneer_output_head_critical_scripts' ) ) { * by adding configuration classes directly into the root node, which * is the only one available at this point. * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_output_head_critical_scripts() { @@ -1116,7 +1116,7 @@ add_post_type_support( 'page', 'excerpt' ); /** * Modifies the pagination links output for the theme * - * @since Fictioneer 5.4.0 + * @since 5.4.0 * @link https://developer.wordpress.org/reference/functions/paginate_links/ * * @param array $args Optional. Array of arguments for generating the pagination links. diff --git a/includes/functions/_utility.php b/includes/functions/_utility.php index d6b04c42..ee770de8 100644 --- a/includes/functions/_utility.php +++ b/includes/functions/_utility.php @@ -8,7 +8,7 @@ if ( ! function_exists( 'fictioneer_url_exists' ) ) { /** * Checks whether an URL exists * - * @since Fictioneer 4.0 + * @since 4.0.0 * @link https://www.geeksforgeeks.org/how-to-check-the-existence-of-url-in-php/ * * @param string $url The URL to check. @@ -42,7 +42,7 @@ if ( ! function_exists( 'fictioneer_is_valid_json' ) ) { /** * Check whether a JSON is valid * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param string $data JSON string hopeful. * @@ -68,7 +68,7 @@ if ( ! function_exists( 'fictioneer_is_plugin_active' ) ) { /** * Checks whether a plugin is active * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param string $path Relative path to the plugin. * @@ -89,7 +89,7 @@ if ( ! function_exists( 'fictioneer_seo_plugin_active' ) ) { * At all. Regardless, if the user want to use a SEO plugin, it's better to turn * off the theme's own SEO features. This function detects some of them. * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @return boolean True if a known SEO is active, otherwise false. */ @@ -111,7 +111,7 @@ if ( ! function_exists( 'fictioneer_get_user_by_id_or_email' ) ) { /** * Get user by ID or email * - * @since Fictioneer 4.6 + * @since 4.6.0 * * @param int|string $id_or_email User ID or email address. * @@ -145,7 +145,7 @@ if ( ! function_exists( 'fictioneer_get_last_story_or_chapter_update' ) ) { /** * Get Unix timestamp for last story or chapter update * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @return int The timestamp in milliseconds. */ @@ -169,7 +169,7 @@ if ( ! function_exists( 'fictioneer_get_last_story_or_chapter_update' ) ) { /** * Returns array of chapter posts for a story * - * @since Fictioneer 5.9.2 + * @since 5.9.2 * * @param int $story_id ID of the story. * @@ -243,7 +243,7 @@ if ( ! function_exists( 'fictioneer_get_story_data' ) ) { /** * Get collection of a story's data * - * @since Fictioneer 4.3 + * @since 4.3.0 * * @param int $story_id ID of the story. * @param boolean $show_comments Optional. Whether the comment count is needed. @@ -408,7 +408,7 @@ if ( ! function_exists( 'fictioneer_get_author_statistics' ) ) { /** * Returns an author's statistics * - * @since Fictioneer 4.6.0 + * @since 4.6.0 * * @param int $author_id User ID of the author. * @@ -524,7 +524,7 @@ if ( ! function_exists( 'fictioneer_get_collection_statistics' ) ) { /** * Returns a collection's statistics * - * @since Fictioneer 5.9.2 + * @since 5.9.2 * * @param int $collection_id ID of the collection. * @@ -621,7 +621,7 @@ if ( ! function_exists( 'fictioneer_shorten_number' ) ) { /** * Shortens a number to a fractional with a letter * - * @since Fictioneer 4.5 + * @since 4.5.0 * * @param int $number The number to be shortened. * @param int $precision Precision of the fraction. Default 1. @@ -654,7 +654,7 @@ if ( ! function_exists( 'fictioneer_validate_id' ) ) { * Ensures an ID is a valid integer and positive; optionally checks whether the * associated post is of a certain types (or among an array of types) * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param int $id The ID to validate. * @param string|array $for_type Optional. The expected post type(s). @@ -686,7 +686,7 @@ if ( ! function_exists( 'fictioneer_get_validated_ajax_user' ) ) { /** * Get the current user after performing AJAX validations * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $nonce_name Optional. The name of the nonce. Default 'nonce'. * @param string $nonce_value Optional. The value of the nonce. Default 'fictioneer_nonce'. @@ -717,7 +717,7 @@ if ( ! function_exists( 'fictioneer_get_validated_ajax_user' ) ) { /** * Checks rate limit globally or for an action via the session * - * @since Fictioneer 5.7.1 + * @since 5.7.1 * * @param string $action The action to check for rate-limiting. * Defaults to 'fictioneer_global'. @@ -772,7 +772,7 @@ if ( ! function_exists( 'fictioneer_replace_key_value' ) ) { /** * Replaces key/value pairs in a string * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $text Text that has key/value pairs to be replaced. * @param array $args The key/value pairs. @@ -807,7 +807,7 @@ if ( ! function_exists( 'fictioneer_is_admin' ) ) { /** * Checks if an user is an administrator * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $user_id The user ID to check. * @@ -835,7 +835,7 @@ if ( ! function_exists( 'fictioneer_is_author' ) ) { /** * Checks if an user is an author * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $user_id The user ID to check. * @@ -863,7 +863,7 @@ if ( ! function_exists( 'fictioneer_is_moderator' ) ) { /** * Checks if an user is a moderator * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $user_id The user ID to check. * @@ -891,7 +891,7 @@ if ( ! function_exists( 'fictioneer_is_editor' ) ) { /** * Checks if an user is an editor * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $user_id The user ID to check. * @@ -923,7 +923,7 @@ if ( ! function_exists( 'fictioneer_get_story_chapter_ids' ) ) { /** * Wrapper for get_post_meta() to get story chapter IDs * - * @since Fictioneer 5.8.2 + * @since 5.8.2 * * @param int $post_id Optional. The ID of the post the field belongs to. * Defaults to current post ID. @@ -944,7 +944,7 @@ if ( ! function_exists( 'fictioneer_get_word_count' ) ) { /** * Wrapper for get_post_meta() to get word count * - * @since Fictioneer 5.8.2 + * @since 5.8.2 * * @param int $post_id Optional. The ID of the post the field belongs to. * Defaults to current post ID. @@ -966,7 +966,7 @@ if ( ! function_exists( 'fictioneer_get_content_field' ) ) { /** * Wrapper for get_post_meta() with content filers applied * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $field Name of the meta field to retrieve. * @param int $post_id Optional. The ID of the post the field belongs to. @@ -995,7 +995,7 @@ if ( ! function_exists( 'fictioneer_get_icon_field' ) ) { /** * Wrapper for get_post_meta() to get Font Awesome icon class * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $field Name of the meta field to retrieve. * @param int $post_id Optional. The ID of the post the field belongs to. @@ -1141,9 +1141,9 @@ function fictioneer_get_falsy_meta_allow_list() { /** * Appends new chapters to story list * - * @since Fictioneer 5.4.9 - * @since Fictioneer 5.7.4 - Updated - * @since Fictioneer 5.8.6 - Added $force param and moved function. + * @since 5.4.9 + * @since 5.7.4 - Updated + * @since 5.8.6 - Added $force param and moved function. * * @param int $post_id The chapter post ID. * @param int $story_id The story post ID. @@ -1217,7 +1217,7 @@ if ( ! function_exists( 'fictioneer_get_consent' ) && get_option( 'fictioneer_co * Checks the current user’s consent cookie for their preferences, either 'full' * or 'necessary' by default. Returns false if no consent cookie is set. * - * @since 4.7 + * @since 4.7.0 * * @return boolean|string Either false or a string describing the level of consent. */ @@ -1238,7 +1238,7 @@ if ( ! function_exists( 'fictioneer_get_consent' ) && get_option( 'fictioneer_co /** * Sanitizes an integer with options for default, minimum, and maximum. * - * @since 4.0 + * @since 4.0.0 * * @param mixed $value The value to be sanitized. * @param int $default Default value if an invalid integer is provided. Default 0. @@ -1277,7 +1277,7 @@ function fictioneer_sanitize_integer( $value, $default = 0, $min = null, $max = /** * Sanitizes a checkbox value into true or false * - * @since 4.7 + * @since 4.7.0 * @link https://www.php.net/manual/en/function.filter-var.php * * @param string|boolean $value The checkbox value to be sanitized. @@ -1388,7 +1388,7 @@ function fictioneer_sanitize_css( $css ) { * users, such as the profile link. They are hidden via CSS, which works as * long as the 'logged-in' class is still set on the . * - * @since 5.0 + * @since 5.0.0 * * @return boolean True or false. */ @@ -1453,7 +1453,7 @@ if ( get_option( 'fictioneer_enable_ajax_authentication' ) ) { * so this is done with a function that can be filtered as needed. For * giving your site a personal touch. * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $key Key for requested translation. * @param boolean $escape Optional. Escape the string for safe use in @@ -1560,7 +1560,7 @@ function fcntr( $key, $escape = false ) { * current page number, replacing anything above the keep threshold with ellipses. * E.g. 1 … 7, 8, [9], 10, 11 … 20. * - * @since 5.0 + * @since 5.0.0 * * @param array|int $pages Array of pages to balance. If an integer is provided, * it is converted to a number array. @@ -1621,7 +1621,7 @@ if ( ! function_exists( 'fictioneer_is_commenting_disabled' ) ) { * Differs from comments_open() in the regard that it does not hide the whole * comment section but does not allow new comments to be posted. * - * @since 5.0 + * @since 5.0.0 * * @param int|null $post_id Post ID the comments are for. Defaults to current post ID. * @@ -1662,7 +1662,7 @@ if ( ! function_exists( 'fictioneer_check_comment_disallowed_list' ) ) { * Checks whether a comment contains disallowed characters or words and * returns the offenders within the comment content * - * @since 5.0 + * @since 5.0.0 * @see wp_check_comment_disallowed_list() * * @param string $author The author of the comment. @@ -1726,7 +1726,7 @@ if ( ! function_exists( 'fictioneer_bbcodes' ) ) { * * Note: Spoilers do not work properly if wrapping multiple lines or other codes. * - * @since Fictioneer 4.0 + * @since 4.0.0 * @link https://stackoverflow.com/a/17508056/17140970 * * @param string $content The content. @@ -2204,7 +2204,7 @@ if ( ! function_exists( 'fictioneer_get_stories_total_word_count' ) ) { /** * Return the total word count of all published stories * - * @since 4.0 + * @since 4.0.0 * @see fictioneer_get_story_data() */ @@ -2253,7 +2253,7 @@ if ( ! function_exists( 'fictioneer_get_stories_total_word_count' ) ) { /** * Deletes the current user's account and anonymized their comments * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @return bool True if the user was successfully deleted, false otherwise. */ @@ -2316,7 +2316,7 @@ function fictioneer_delete_my_account() { * Prevents an array from being empty, which is useful for 'post__in' query * arguments that cannot deal with empty arrays. * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param array $array The input array to check. * @@ -2335,7 +2335,7 @@ if ( ! function_exists( 'fictioneer_redirect_to_404' ) ) { /** * Redirects the current request to the WordPress 404 page * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @global WP_Query $wp_query The main WP_Query instance. */ @@ -2370,7 +2370,7 @@ if ( ! function_exists( 'fictioneer_verify_unpublish_access' ) ) { /** * Verifies access to unpublished posts (not drafts) * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @return boolean True if access granted, false otherwise. */ @@ -2430,7 +2430,7 @@ if ( ! function_exists( 'fictioneer_verify_unpublish_access' ) ) { * This helper saves some time/space adding a callback action to all four * default post operations. But only with the first argument: post_id. * - * @since Fictioneer 5.6.3 + * @since 5.6.3 * * @param callable $function The callback function to be added. * @param int $priority Optional. Used to specify the order in which the @@ -2460,7 +2460,7 @@ function fictioneer_add_stud_post_actions( $function, $priority = 10 ) { /** * Turn line-break separated list into array of links * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param string $list The list of links * @@ -2504,7 +2504,7 @@ function fictioneer_url_list_to_array( $list ) { /** * Unset array element by value * - * @since Fictioneer 5.7.5 + * @since 5.7.5 * * @param mixed $value The value to look for. * @param array $array The array to be modified. @@ -2527,7 +2527,7 @@ function fictioneer_unset_by_value( $value, $array ) { /** * Returns an unformatted replacement string * - * @since Fictioneer 5.7.5 + * @since 5.7.5 * * @return string Just a simple '%s'. */ @@ -2543,7 +2543,7 @@ function fictioneer__return_no_format() { /** * Returns a truncated string without tags * - * @since Fictioneer 5.9.0 + * @since 5.9.0 * * @param string $string The string to truncate. * @param int $length Maximum length in characters. diff --git a/includes/functions/_wordpress_mods.php b/includes/functions/_wordpress_mods.php index ae808a22..5e5cd673 100644 --- a/includes/functions/_wordpress_mods.php +++ b/includes/functions/_wordpress_mods.php @@ -7,7 +7,7 @@ /** * Toggle maintenance mode from settings with message * - * @since 5.0 + * @since 5.0.0 */ function fictioneer_maintenance_mode() { @@ -75,7 +75,7 @@ add_filter( 'excerpt_length', 'fictioneer_custom_excerpt_length' ); /** * Reduce admin bar based on setting * - * @since 5.0 + * @since 5.0.0 */ function fictioneer_remove_admin_bar_links() { @@ -103,7 +103,7 @@ if ( get_option( 'fictioneer_reduce_admin_bar' ) ) { /** * Change redirect after logout * - * @since 4.0 + * @since 4.0.0 * * @param string $logout_url The HTML-encoded logout URL. * @param string $redirect Path to redirect to on logout. @@ -146,7 +146,7 @@ if ( get_option( 'fictioneer_logout_redirects_home' ) ) { /** * Add route to logout script * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_add_logout_endpoint() { @@ -160,7 +160,7 @@ if ( FICTIONEER_LOGOUT_ENDPOINT && ! get_option( 'fictioneer_disable_theme_logou /** * Logout without _wpnonce and no login screen * - * @since 5.0 + * @since 5.0.0 */ function fictioneer_logout() { @@ -205,7 +205,7 @@ if ( ! function_exists( 'fictioneer_get_logout_url' ) ) { /** * Fictioneer logout URL with optional redirect * - * @since 5.0 + * @since 5.0.0 * * @param string $redirect URL to redirect to after logout. */ @@ -239,7 +239,7 @@ if ( ! function_exists( 'fictioneer_get_logout_url' ) ) { /** * Show custom post types in tag and category archives * - * @since 4.0 + * @since 4.0.0 * @link https://wordpress.stackexchange.com/a/28147/223620 * * @param WP_Query $query The query. @@ -292,7 +292,7 @@ add_action( 'template_redirect', 'fictioneer_disable_date_archives' ); /** * Get template for story feed (chapters) * - * @since 4.0 + * @since 4.0.0 */ function fictioneer_story_rss_template() { @@ -302,7 +302,7 @@ function fictioneer_story_rss_template() { /** * Add feed for story (chapters) * - * @since 4.0 + * @since 4.0.0 */ function fictioneer_story_rss() { @@ -312,7 +312,7 @@ function fictioneer_story_rss() { /** * Add custom main feed * - * @since 4.0 + * @since 4.0.0 */ function fictioneer_main_rss_template() { @@ -344,7 +344,7 @@ if ( get_option( 'fictioneer_enable_theme_rss' ) ) { /** * Output RSS feed * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int|null $post_id Optional. The current post ID. */ @@ -423,7 +423,7 @@ add_filter( 'protected_title_format', 'fictioneer_remove_protected_text' ); /** * Add wrapper to download block * - * @since 4.0 + * @since 4.0.0 * * @param string $block_content The block content. * @param array $block The full block, including name and attributes. @@ -447,7 +447,7 @@ add_filter( 'render_block', 'fictioneer_download_block_wrapper', 10, 2 ); /** * Changes password form and fixes redirect error * - * @since 4.0 + * @since 4.0.0 * @license CC BY-SA 4.0 * @link https://stackoverflow.com/a/67527400/17140970 * @@ -669,7 +669,7 @@ if ( get_option( 'fictioneer_remove_wp_svg_filters' ) ) { /** * Wraps embeds into a consent box that must be clicked to load the embed. * - * @since Fictioneer 3.0.0 + * @since 3.0.0 * * @param string $content The content. * @@ -960,7 +960,7 @@ add_filter( 'nav_menu_link_attributes', 'fictioneer_add_menu_link_attributes', 1 /** * Disable all widgets and boost performance slightly * - * @since Fictioneer 5.5.3 + * @since 5.5.3 */ function fictioneer_disable_widgets() { @@ -980,7 +980,7 @@ if ( get_option( 'fictioneer_disable_all_widgets' ) ) { /** * Extend the list of allowed types for file uploads * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param array $mimes Key-value pairs of file extensions and their MIME types. * @@ -1006,7 +1006,7 @@ add_filter( 'upload_mimes', 'fictioneer_extend_allowed_upload_types' ); * Note: This function only identifies attempts and does not block content submission. * Posts are sanitized by WordPress before being saved to the database. * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param array $data An array of slashed post data. * @param array $postarr An array of sanitized, but otherwise unmodified post data. @@ -1121,7 +1121,7 @@ if ( get_option( 'fictioneer_see_some_evil' ) ) { /** * Gates access to unpublished posts * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * @global WP_Post $post The current WordPress post object. */ @@ -1169,7 +1169,7 @@ add_action( 'template_redirect', 'fictioneer_gate_unpublished_content' ); /** * Prevents trackback/pingback from being updated * - * @since Fictioneer 5.7.0 + * @since 5.7.0 * * @param array $data An array of slashed, sanitized, and processed post data. * diff --git a/includes/functions/comments/_comments_ajax.php b/includes/functions/comments/_comments_ajax.php index 776e337a..3677e6b8 100644 --- a/includes/functions/comments/_comments_ajax.php +++ b/includes/functions/comments/_comments_ajax.php @@ -7,7 +7,7 @@ /** * Sends the comment form HTML via AJAX * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ */ @@ -65,7 +65,7 @@ if ( get_option( 'fictioneer_enable_ajax_comment_form' ) ) { /** * Sends the comment section HTML via AJAX * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ */ @@ -216,7 +216,7 @@ if ( get_option( 'fictioneer_enable_ajax_comments' ) ) { /** * Creates and sends a new comment via AJAX * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ */ @@ -432,7 +432,7 @@ if ( get_option( 'fictioneer_enable_ajax_comment_submit' ) ) { /** * Edit comment via AJAX * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ */ @@ -569,7 +569,7 @@ if ( get_option( 'fictioneer_enable_user_comment_editing' ) ) { /** * Delete a user's comment on AJAX request * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ */ diff --git a/includes/functions/comments/_comments_controller.php b/includes/functions/comments/_comments_controller.php index ab4ae30a..78333387 100644 --- a/includes/functions/comments/_comments_controller.php +++ b/includes/functions/comments/_comments_controller.php @@ -13,7 +13,7 @@ * email and cookies to preview their comment for a limited time as set in * fictioneer_theme_comment(). * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param string $location Default redirect URI. * @param object $commentdata Comment data. @@ -58,7 +58,7 @@ if ( ! get_option( 'fictioneer_disable_comment_query' ) ) { /** * Prevents the commenter’s IP address from being stored in the database * - * @since Fictioneer 4.7 + * @since 4.7.0 */ if ( get_option( 'fictioneer_do_not_save_comment_ip' ) ) { @@ -72,7 +72,7 @@ if ( get_option( 'fictioneer_do_not_save_comment_ip' ) ) { /** * Applies anti-spam measures, checks for flags, filters the content, etc. * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param array $commentdata Comment data. * @@ -151,7 +151,7 @@ add_filter( 'preprocess_comment', 'fictioneer_preprocess_comment', 30, 1 ); /** * Validate comment form submission * - * @since Fictioneer 4.7 + * @since 4.7.0 * @link https://developer.wordpress.org/reference/hooks/preprocess_comment/ * * @param array $commentdata Comment data. @@ -255,7 +255,7 @@ if ( ! get_option( 'fictioneer_disable_comment_form' ) ) { /** * Fires after the comment has been inserted into the database * - * @since Fictioneer 4.7 + * @since 4.7.0 * @link https://developer.wordpress.org/reference/hooks/comment_post/ * @link https://github.com/WordPress/WordPress/blob/master/wp-includes/comment.php * @see add_comment_meta() @@ -333,7 +333,7 @@ if ( ! function_exists( 'fictioneer_comment_notification' ) ) { /** * Send notification email about replies to commenter * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_Comment $parent Comment that was replied to. * @param int $comment_id ID of the reply comment. @@ -431,7 +431,7 @@ if ( ! function_exists( 'fictioneer_comment_notification' ) ) { /** * Add GET route to unsubscribe * - * @since Fictioneer 5.0 + * @since 5.0.0 */ if ( get_option( 'fictioneer_enable_comment_notifications' ) ) { @@ -455,7 +455,7 @@ if ( ! function_exists( 'fictioneer_unsubscribe_from_comment' ) ) { /** * Unsubscribe from comment reply notifications * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/rest-api/extending-the-rest-api/adding-custom-endpoints/ * * @param WP_REST_Request $WP_REST_Request Request object. @@ -520,7 +520,7 @@ if ( ! function_exists( 'fictioneer_unsubscribe_from_comment' ) ) { /** * Fires immediately after an edited comment is updated in the database * - * @since Fictioneer 4.7 + * @since 4.7.0 * @link https://developer.wordpress.org/reference/hooks/edit_comment/ * * @param int $comment_ID The comment ID. diff --git a/includes/functions/comments/_comments_form.php b/includes/functions/comments/_comments_form.php index 63429ba9..a3a1ac37 100644 --- a/includes/functions/comments/_comments_form.php +++ b/includes/functions/comments/_comments_form.php @@ -8,7 +8,7 @@ if ( ! function_exists( 'fictioneer_get_comment_toolbar' ) ) { /** * Returns the HTML for the comment toolbar * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @return string Comment toolbar or empty string if it is disabled. */ @@ -46,7 +46,7 @@ if ( ! function_exists( 'fictioneer_get_comment_toolbar' ) ) { /** * Change default fields of comment form * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param array $fields Array of the default comment fields. * @@ -120,7 +120,7 @@ if ( ! get_option( 'fictioneer_disable_comment_form' ) ) { /** * Change the submit field and add the Cancel Reply link * - * @since Fictioneer 4.7 + * @since 4.7.0 * @link https://github.com/WordPress/WordPress/blob/master/wp-includes/comment-template.php * @link https://stackoverflow.com/a/57080105/17140970 * @@ -214,7 +214,7 @@ if ( ! get_option( 'fictioneer_disable_comment_form' ) ) { /** * Returns themed comment form arguments * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/reference/functions/comment_form/ * * @param array $defaults Default form arguments. Defaults to empty array. diff --git a/includes/functions/comments/_comments_moderation.php b/includes/functions/comments/_comments_moderation.php index b922daac..c3596ad8 100644 --- a/includes/functions/comments/_comments_moderation.php +++ b/includes/functions/comments/_comments_moderation.php @@ -7,7 +7,7 @@ /** * Checks whether an user can moderate a comment * - * @since Fictioneer 5.7.3 + * @since 5.7.3 * * @param WP_Comment $comment Comment object. * @param int|null $user_id The user ID to check permission for. Defaults to @@ -53,7 +53,7 @@ function fictioneer_user_can_moderate( $comment, $user_id = null ) { /** * Add private comments to dropdown filter menu * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_add_private_to_comment_filter( $comment_types ) { @@ -71,7 +71,7 @@ add_filter( 'admin_comment_types_dropdown', 'fictioneer_add_private_to_comment_f /** * Adds Fictioneer comment meta box to the wp-admin comment edit screen * - * @since Fictioneer 4.7 + * @since 4.7.0 */ function fictioneer_add_comment_meta_box() { @@ -88,7 +88,7 @@ function fictioneer_add_comment_meta_box() { /** * HTML for the Fictioneer comment meta box * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param object $comment The comment object. */ @@ -259,7 +259,7 @@ function fictioneer_comment_meta_box ( $comment ) { /** * Save data in the wp-admin comment edit screen * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param int $comment_id Comment ID. */ @@ -314,7 +314,7 @@ if ( ! get_option( 'fictioneer_disable_comment_form' ) ) { /** * Tracks comment edits and stores a history of changes * - * @since Fictioneer 5.5.3 + * @since 5.5.3 * * @param array|WP_Error $data The comment data to be saved. * @param array $comment The old comment data. @@ -367,7 +367,7 @@ if ( ! function_exists( 'fictioneer_get_comment_action_link' ) ) { /** * Returns a link to an admin comment moderation action or false * - * @since Fictioneer 4.7 + * @since 4.7.0 * @link https://github.com/WordPress/WordPress/blob/master/wp-admin/comment.php * * @param int $comment_id The ID of the comment. @@ -430,7 +430,7 @@ if ( ! function_exists( 'fictioneer_comment_mod_menu' ) ) { /** * Renders HTML for the moderation menu * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param WP_Comment $comment Comment object. */ @@ -519,7 +519,7 @@ if ( ! function_exists( 'fictioneer_comment_mod_menu' ) ) { /** * Performs comment moderation action via AJAX * - * @since Fictioneer 4.7 + * @since 4.7.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ */ @@ -629,7 +629,7 @@ if ( get_option( 'fictioneer_enable_ajax_comment_moderation' ) ) { /** * Adds user to a comment's reports list via AJAX * - * @since Fictioneer 4.7 + * @since 4.7.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ */ @@ -730,7 +730,7 @@ function fictioneer_ajax_report_comment() { /** * Add comments reports column * - * @since Fictioneer 4.7 + * @since 4.7.0 * @link https://rudrastyh.com/wordpress/comments-table-columns.html * * @param array $cols Default columns. @@ -747,7 +747,7 @@ function fictioneer_add_comments_report_column( $cols ) { /** * Echo content for comments reports column * - * @since Fictioneer 4.7 + * @since 4.7.0 * @link https://rudrastyh.com/wordpress/comments-table-columns.html * @link https://developer.wordpress.org/reference/hooks/manage_comments_custom_column/ * diff --git a/includes/functions/comments/_comments_threads.php b/includes/functions/comments/_comments_threads.php index beba0d7b..e676fad1 100644 --- a/includes/functions/comments/_comments_threads.php +++ b/includes/functions/comments/_comments_threads.php @@ -7,7 +7,7 @@ /** * Change default comment reply login link to login modal toggle * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $link The HTML markup for the comment reply link. * @param array $args An array of arguments overriding the defaults. @@ -39,7 +39,7 @@ add_filter( 'comment_reply_link', 'fictioneer_comment_login_to_reply', 10, 4 ); /** * Prepend sticky comments * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $comments Queried comments. * @param int $post_id The post ID. @@ -86,7 +86,7 @@ if ( ! function_exists( 'fictioneer_comment_header' ) ) { /** * Output Fictioneer themed comment header * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $comment_count Total number of comments. */ @@ -122,7 +122,7 @@ if ( ! function_exists( 'fictioneer_comments_ajax_skeleton' ) ) { /** * Output skeleton placeholder while comments are loaded via AJAX * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $comments_count Total number of comments. */ @@ -160,7 +160,7 @@ if ( ! function_exists( 'fictioneer_comments_ajax_form_skeleton' ) ) { /** * Output skeleton placeholder while the form is loaded via AJAX * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_comments_ajax_form_skeleton() { @@ -183,7 +183,7 @@ if ( ! function_exists( 'fictioneer_ajax_list_comments' ) ) { /** * Output Fictioneer themed paginated comment threads via AJAX * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $comments Collection of comments to display. * @param int $page Current page number of the comments. @@ -230,7 +230,7 @@ if ( ! function_exists( 'fictioneer_ajax_list_comments' ) ) { /** * Returns themed comment list arguments * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $parsed_args Default list arguments. * @@ -288,8 +288,8 @@ if ( ! get_option( 'fictioneer_disable_comment_bbcodes' ) && ! get_option( 'fict /** * Properly wrap empty lines into paragraphs * - * @since Fictioneer 4.0 - * @since Fictioneer 5.2.6 Updated and changed to not mess up some languages. + * @since 4.0.0 + * @since 5.2.6 Updated and changed to not mess up some languages. * * @param string $comment_content The comment content. * @@ -322,7 +322,7 @@ if ( ! function_exists( 'fictioneer_theme_comment' ) ) { /** * Callback function for basic theme comment markup * - * @since Fictioneer 4.7 + * @since 4.7.0 * @global WP_Post|null $post The post object. May not be available. * * @param WP_Comment $comment The comment object. @@ -780,7 +780,7 @@ if ( ! function_exists( 'fictioneer_theme_comment' ) ) { /** * Change comment pagination markup * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param string $template The default comment pagination template. * diff --git a/includes/functions/comments/_story_comments.php b/includes/functions/comments/_story_comments.php index c102557c..deebe975 100644 --- a/includes/functions/comments/_story_comments.php +++ b/includes/functions/comments/_story_comments.php @@ -17,7 +17,7 @@ if ( ! function_exists( 'fictioneer_build_story_comment' ) ) { /** * Outputs a single comment for the story comments list * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param object $comment The comment. * @param array $chapter_data Array of [post_id] tuples with title [0] and @@ -101,7 +101,7 @@ if ( ! function_exists( 'fictioneer_build_story_comment' ) ) { * - post_id (required): The ID of the story post. * - page (optional): The page number for pagination. Default 1. * - * @since Fictioneer 5.6.3 + * @since 5.6.3 */ function fictioneer_register_endpoint_get_story_comments() { @@ -136,8 +136,8 @@ add_action( 'rest_api_init', 'fictioneer_register_endpoint_get_story_comments' ) /** * Sends HTML of paginated comments for a given story * - * @since Fictioneer 4.0 - * @since Fictioneer 5.6.3 Refactored for REST API. + * @since 4.0.0 + * @since 5.6.3 Refactored for REST API. * * @param WP_REST_Request $WP_REST_Request Request object. * diff --git a/includes/functions/hooks/_chapter_hooks.php b/includes/functions/hooks/_chapter_hooks.php index 9ed2e6e9..cd6f9199 100644 --- a/includes/functions/hooks/_chapter_hooks.php +++ b/includes/functions/hooks/_chapter_hooks.php @@ -7,7 +7,7 @@ /** * Outputs the paginated card list for all chapters * - * @since 5.0 + * @since 5.0.0 * @see chapters.php * * @param int $args['current_page'] Current page number of pagination or 1. @@ -90,7 +90,7 @@ add_action( 'fictioneer_chapters_after_content', 'fictioneer_chapters_list', 30 /** * Outputs the HTML for the chapter foreword section * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $args['chapter_id'] The chapter ID. */ @@ -117,7 +117,7 @@ add_action( 'fictioneer_chapter_before_header', 'fictioneer_chapter_foreword', 1 /** * Outputs the HTML for the chapter warnings section * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $args['chapter_id'] The chapter ID. */ @@ -163,7 +163,7 @@ add_action( 'fictioneer_chapter_before_header', 'fictioneer_chapter_warnings', 2 /** * Outputs the HTML for the chapter resize buttons * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_chapter_resize_buttons() { @@ -192,7 +192,7 @@ add_action( 'fictioneer_chapter_actions_top_left', 'fictioneer_chapter_resize_bu /** * Outputs the HTML for the chapter navigation buttons * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $args['chapter_ids'] IDs of visible chapters in the same story or empty array. * @param int|boolean $args['prev_index'] Index of previous chapter or false if outside bounds. @@ -232,7 +232,7 @@ add_action( 'fictioneer_chapter_actions_bottom_right', 'fictioneer_chapter_nav_b /** * Outputs the HTML for the chapter formatting button * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_chapter_formatting_button() { @@ -252,7 +252,7 @@ add_action( 'fictioneer_chapter_actions_top_center', 'fictioneer_chapter_formatt /** * Outputs the HTML for the chapter subscribe button with popup menu * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_chapter_subscribe_button() { @@ -282,7 +282,7 @@ add_action( 'fictioneer_chapter_actions_bottom_center', 'fictioneer_chapter_subs /** * Outputs the HTML for the chapter fullscreen button * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_chapter_fullscreen_buttons() { @@ -308,7 +308,7 @@ add_action( 'fictioneer_chapter_actions_top_center', 'fictioneer_chapter_fullscr /** * Outputs the HTML for the index popup menu * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_Post|null $args['story_post'] Optional. The story the chapter belongs to. */ @@ -348,7 +348,7 @@ add_action( 'fictioneer_chapter_actions_bottom_center', 'fictioneer_chapter_inde /** * Outputs the HTML for the chapter bookmark jump button * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_chapter_bookmark_jump_button() { @@ -374,7 +374,7 @@ add_action( 'fictioneer_chapter_actions_bottom_center', 'fictioneer_chapter_book /** * Outputs the HTML for the chapter media buttons * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_chapter_media_buttons() { @@ -396,7 +396,7 @@ add_action( 'fictioneer_chapter_actions_bottom_left', 'fictioneer_chapter_media_ /** * Outputs the HTML for the chapter afterword * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $args['chapter_id'] The chapter ID. */ @@ -423,7 +423,7 @@ add_action( 'fictioneer_chapter_after_content', 'fictioneer_chapter_afterword', /** * Outputs the HTML for the chapter support links * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $args['author'] Author of the post. * @param WP_Post|null $args['story_post'] Optional. Post object of the story. @@ -533,7 +533,7 @@ add_action( 'fictioneer_chapter_after_content', 'fictioneer_chapter_support_link /** * Outputs the HTML for the chapter micro menu * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_Post|null $args['story_post'] Optional. Post object of the story. * @param int $args['chapter_id'] The chapter ID. @@ -554,7 +554,7 @@ add_action( 'fictioneer_chapter_after_main', 'fictioneer_chapter_micro_menu', 10 /** * Outputs the HTML for the chapter paragraph tools * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_chapter_paragraph_tools() { @@ -614,7 +614,7 @@ add_action( 'fictioneer_chapter_after_main', 'fictioneer_chapter_paragraph_tools /** * Outputs the HTML for the chapter suggestion tools * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_chapter_suggestion_tools() { diff --git a/includes/functions/hooks/_collection_hooks.php b/includes/functions/hooks/_collection_hooks.php index bf249f2e..14342064 100644 --- a/includes/functions/hooks/_collection_hooks.php +++ b/includes/functions/hooks/_collection_hooks.php @@ -7,7 +7,7 @@ /** * Outputs the paginated card list for all collections * - * @since 5.0 + * @since 5.0.0 * @see collections.php * * @param int $args['current_page'] Current page number of pagination or 1. @@ -87,7 +87,7 @@ add_action( 'fictioneer_collections_after_content', 'fictioneer_collections_list /** * Outputs the HTML for the collection page tags and warnings * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_Post $args['collection'] Collection post object. * @param int $args['collection_id'] The collection post ID. @@ -138,7 +138,7 @@ add_action( 'fictioneer_collection_after_content', 'fictioneer_collection_tags_a /** * Outputs the HTML for the collection page statistics * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_Post $args['collection'] Collection post object. * @param int $args['collection_id'] The collection post ID. @@ -167,7 +167,7 @@ add_action( 'fictioneer_collection_after_content', 'fictioneer_collection_statis /** * Outputs the HTML for the collection page featured list * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_Post $args['collection'] Collection post object. * @param int $args['collection_id'] The collection post ID. diff --git a/includes/functions/hooks/_general_hooks.php b/includes/functions/hooks/_general_hooks.php index 83327b87..7f4e8405 100644 --- a/includes/functions/hooks/_general_hooks.php +++ b/includes/functions/hooks/_general_hooks.php @@ -7,7 +7,7 @@ /** * Outputs custom CSS for stories/chapters * - * @since Fictioneer 5.4.7 + * @since 5.4.7 */ function fictioneer_add_fiction_css() { @@ -48,7 +48,7 @@ add_action( 'wp_head', 'fictioneer_add_fiction_css', 10 ); /** * Outputs the HTML for the breadcrumbs * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int|null $args['post_id'] Optional. Post ID of the current page. * @param string|null $args['post_type'] Optional. Post type of the current page. @@ -67,7 +67,7 @@ add_action( 'fictioneer_site_footer', 'fictioneer_breadcrumbs', 10 ); /** * Outputs the HTML for the footer menu and theme copyright notice * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int|null $args['post_id'] Optional. Post ID of the current page. * @param string|null $args['post_type'] Optional. Post type of the current page. @@ -124,7 +124,7 @@ add_action( 'fictioneer_site_footer', 'fictioneer_footer_menu_row', 20 ); /** * Outputs the HTML for the modals * - * @since Fictioneer 5.0.0 + * @since 5.0.0 * * @param int|null $args['post_id'] Optional. Current post ID. * @param string|null $args['post_type'] Optional. Current post type. @@ -214,7 +214,7 @@ add_action( 'fictioneer_footer', 'fictioneer_output_modals' ); /** * Outputs the HTML for the browser notes * - * @since Fictioneer 5.9.1 + * @since 5.9.1 */ function fictioneer_browser_notes() { @@ -267,7 +267,7 @@ if ( FICTIONEER_ENABLE_BROWSER_NOTES ) { /** * Outputs the HTML for the navigation bar * - * @since Fictioneer 5.0.0 + * @since 5.0.0 * * @param int|null $args['post_id'] Optional. Current post ID. * @param int|null $args['story_id'] Optional. Current story ID (if chapter). @@ -287,7 +287,7 @@ add_action( 'fictioneer_site', 'fictioneer_navigation_bar', 10 ); /** * Outputs the HTML for the top header * - * @since Fictioneer 5.8.1 + * @since 5.8.1 * * @param int|null $args['post_id'] Optional. Current post ID. * @param int|null $args['story_id'] Optional. Current story ID (if chapter). @@ -312,7 +312,7 @@ add_action( 'fictioneer_site', 'fictioneer_top_header', 9 ); /** * Outputs the HTML for the inner header * - * @since Fictioneer 5.0.0 + * @since 5.0.0 * * @param int|null $args['post_id'] Optional. Current post ID. * @param int|null $args['story_id'] Optional. Current story ID (if chapter). @@ -342,7 +342,7 @@ add_action( 'fictioneer_site', 'fictioneer_inner_header', 20 ); /** * Outputs the HTML for the header background * - * @since Fictioneer 5.0.0 + * @since 5.0.0 * * @param int|null $args['post_id'] Optional. Current post ID. * @param int|null $args['story_id'] Optional. Current story ID (if chapter). @@ -373,7 +373,7 @@ add_action( 'fictioneer_inner_header', 'fictioneer_inner_header_background', 10 /** * Renders interface to sort, order, and filter queries * - * @since Fictioneer 5.4.0 + * @since 5.4.0 * * @param array $args { * Array of arguments. @@ -616,7 +616,7 @@ add_action( 'fictioneer_archive_loop_before', 'fictioneer_sort_order_filter_inte /** * Outputs the HTML for no search params * - * @since Fictioneer 5.5.2 + * @since 5.5.2 */ function fictioneer_no_search_params() { @@ -627,7 +627,7 @@ add_action( 'fictioneer_search_no_params', 'fictioneer_no_search_params' ); /** * Outputs the HTML for no search results * - * @since Fictioneer 5.5.2 + * @since 5.5.2 */ function fictioneer_no_search_results() { diff --git a/includes/functions/hooks/_mobile_menu_hooks.php b/includes/functions/hooks/_mobile_menu_hooks.php index cf38aedd..36e7f219 100644 --- a/includes/functions/hooks/_mobile_menu_hooks.php +++ b/includes/functions/hooks/_mobile_menu_hooks.php @@ -11,7 +11,7 @@ * sections (top|center|bottom) > frames > panels. Only one frame per section * should be displayed at a time, segmenting the menu. * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int|null $args['post_id'] Optional. Current post ID. * @param int|null $args['story_id'] Optional. Current story ID (if chapter). @@ -51,7 +51,7 @@ add_action( 'fictioneer_body', 'fictioneer_output_mobile_menu', 20 ); /** * Adds the _icon-menu.php partial to the mobile menu * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_mobile_user_icon_menu() { @@ -66,7 +66,7 @@ add_action( 'fictioneer_mobile_menu_top', 'fictioneer_mobile_user_icon_menu', 10 /** * Adds quick buttons to the mobile menu * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_mobile_quick_buttons() { @@ -159,7 +159,7 @@ add_action( 'fictioneer_mobile_menu_bottom', 'fictioneer_mobile_quick_buttons', /** * Adds the Follows frame to the mobile menu * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_mobile_follows_frame() { @@ -195,7 +195,7 @@ if ( get_option( 'fictioneer_enable_follows' ) ) { /** * Adds the bookmarks frame to the mobile menu * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_mobile_bookmarks_frame() { @@ -229,7 +229,7 @@ if ( get_option( 'fictioneer_enable_bookmarks' ) ) { /** * Adds the chapters frame to the mobile menu * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_mobile_chapters_frame() { @@ -260,7 +260,7 @@ add_action( 'fictioneer_mobile_menu_center', 'fictioneer_mobile_chapters_frame', /** * Adds the navigation panel to the mobile menu * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_mobile_navigation_panel() { @@ -283,7 +283,7 @@ add_action( 'fictioneer_mobile_menu_main_frame_panels', 'fictioneer_mobile_navig /** * Adds the lists panel to the mobile menu * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_mobile_lists_panel() { @@ -338,7 +338,7 @@ add_action( 'fictioneer_mobile_menu_main_frame_panels', 'fictioneer_mobile_lists /** * Adds the user menu to the mobile menu * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_mobile_user_menu() { diff --git a/includes/functions/hooks/_post_hooks.php b/includes/functions/hooks/_post_hooks.php index f8b060c6..7d380059 100644 --- a/includes/functions/hooks/_post_hooks.php +++ b/includes/functions/hooks/_post_hooks.php @@ -7,7 +7,7 @@ /** * Outputs the HTML for the post tags * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $post_id The post ID. */ @@ -36,7 +36,7 @@ add_action( 'fictioneer_post_after_content', 'fictioneer_post_tags', 10 ); /** * Outputs the HTML for featured items in the post * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $post_id The post ID. */ @@ -115,7 +115,7 @@ add_action( 'fictioneer_post_after_content', 'fictioneer_post_featured_list', 20 /** * Outputs the HTML for the post media buttons * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_post_media_buttons() { @@ -136,7 +136,7 @@ add_action( 'fictioneer_post_footer_left', 'fictioneer_post_media_buttons', 10 ) /** * Outputs the HTML for the post subscribe button with popup menu * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_post_subscribe_button() { diff --git a/includes/functions/hooks/_profile_hooks.php b/includes/functions/hooks/_profile_hooks.php index c94474e3..f3bedc51 100644 --- a/includes/functions/hooks/_profile_hooks.php +++ b/includes/functions/hooks/_profile_hooks.php @@ -7,7 +7,7 @@ /** * Outputs the HTML for the account moderation message section * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $args['user'] Current user. * @param boolean $args['is_admin'] True if the user is an administrator. @@ -42,7 +42,7 @@ add_action( 'fictioneer_account_content', 'fictioneer_account_moderation_message /** * Outputs the HTML for the account profile section * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $args['user'] Current user. * @param boolean $args['is_admin'] True if the user is an administrator. @@ -63,7 +63,7 @@ add_action( 'fictioneer_account_content', 'fictioneer_account_profile', 10 ); /** * Outputs the HTML for the OAuth section * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $args['user'] Current user. * @param boolean $args['is_admin'] True if the user is an administrator. @@ -84,7 +84,7 @@ add_action( 'fictioneer_account_content', 'fictioneer_account_oauth', 20 ); /** * Outputs the HTML for the data section * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $args['user'] Current user. * @param boolean $args['is_admin'] True if the user is an administrator. @@ -105,7 +105,7 @@ add_action( 'fictioneer_account_content', 'fictioneer_account_data', 30 ); /** * Outputs the HTML for the discussions section * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $args['user'] Current user. * @param boolean $args['is_admin'] True if the user is an administrator. @@ -126,7 +126,7 @@ add_action( 'fictioneer_account_content', 'fictioneer_account_discussions', 40 ) /** * Outputs the HTML for the danger zone section * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $args['user'] Current user. * @param boolean $args['is_admin'] True if the user is an administrator. diff --git a/includes/functions/hooks/_recommendation_hooks.php b/includes/functions/hooks/_recommendation_hooks.php index fff69bf2..e90d1161 100644 --- a/includes/functions/hooks/_recommendation_hooks.php +++ b/includes/functions/hooks/_recommendation_hooks.php @@ -7,7 +7,7 @@ /** * Outputs the paginated card list for all recommendations * - * @since 5.0 + * @since 5.0.0 * @see recommendations.php * * @param int $args['current_page'] Current page number of pagination or 1. @@ -85,7 +85,7 @@ add_action( 'fictioneer_recommendations_after_content', 'fictioneer_recommendati /** * Outputs the HTML for the recommendation page tags * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_Post $args['recommendation'] The recommendation object. * @param int $args['recommendation_id'] The recommendation post ID. @@ -134,7 +134,7 @@ add_action( 'fictioneer_recommendation_after_content', 'fictioneer_recommendatio /** * Outputs the HTML for the recommendation page links * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_Post $args['recommendation'] The recommendation object. * @param int $args['recommendation_id'] The recommendation post ID. @@ -174,7 +174,7 @@ add_action( 'fictioneer_recommendation_after_content', 'fictioneer_recommendatio /** * Outputs the HTML for the recommendation page author links * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_Post $args['recommendation'] The recommendation object. * @param int $args['recommendation_id'] The recommendation post ID. diff --git a/includes/functions/hooks/_story_hooks.php b/includes/functions/hooks/_story_hooks.php index 784a72b8..d1e652aa 100644 --- a/includes/functions/hooks/_story_hooks.php +++ b/includes/functions/hooks/_story_hooks.php @@ -11,7 +11,7 @@ * word count, comments, and the estimated reading time for all stories. The * reading time divisor can be changed under Fictioneer > General (default: 200). * - * @since 5.0 + * @since 5.0.0 * @see stories.php * * @param int $args['current_page'] Current page number of pagination or 1. @@ -74,7 +74,7 @@ add_action( 'fictioneer_stories_after_content', 'fictioneer_stories_statistics', /** * Outputs the paginated card list for all stories * - * @since 5.0 + * @since 5.0.0 * @see stories.php * * @param int $args['current_page'] Current page number of pagination or 1. @@ -157,7 +157,7 @@ add_action( 'fictioneer_stories_after_content', 'fictioneer_stories_list', 30 ); /** * Outputs the HTML for the story page copyright notice * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $args['story_data'] Collection of story data. * @param int $args['story_id'] The story post ID. @@ -187,7 +187,7 @@ add_action( 'fictioneer_story_after_content', 'fictioneer_story_copyright_notice /** * Outputs the HTML for the story page tags and warnings * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $args['story_data'] Collection of story data. * @param int $args['story_id'] The story post ID. @@ -230,7 +230,7 @@ add_action( 'fictioneer_story_after_content', 'fictioneer_story_tags_and_warning /** * Outputs the HTML for the story page actions row * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $args['story_data'] Collection of story data. * @param int $args['story_id'] The story post ID. @@ -258,7 +258,7 @@ add_action( 'fictioneer_story_after_content', 'fictioneer_story_actions', 30 ); /** * Outputs the HTML for the story tabs * - * @since Fictioneer 5.9.0 + * @since 5.9.0 * * @param array $args['story_data'] Collection of story data. * @param int $args['story_id'] The story post ID. @@ -351,7 +351,7 @@ add_action( 'fictioneer_story_after_content', 'fictioneer_story_tabs', 40 ); /** * Outputs the HTML for the scheduled chapter * - * @since Fictioneer 5.9.0 + * @since 5.9.0 * * @param array $args['story_data'] Collection of story data. * @param int $args['story_id'] The story post ID. @@ -410,7 +410,7 @@ add_action( 'fictioneer_story_after_content', 'fictioneer_story_scheduled_chapte /** * Outputs the HTML for the story custom pages * - * @since Fictioneer 5.9.0 + * @since 5.9.0 * * @param array $args['story_data'] Collection of story data. * @param int $args['story_id'] The story post ID. @@ -467,7 +467,7 @@ add_action( 'fictioneer_story_after_content', 'fictioneer_story_pages', 42 ); /** * Outputs the HTML for the story chapters * - * @since Fictioneer 5.9.0 + * @since 5.9.0 * * @param array $args['story_data'] Collection of story data. * @param int $args['story_id'] The story post ID. @@ -708,7 +708,7 @@ add_action( 'fictioneer_story_after_content', 'fictioneer_story_chapters', 43 ); /** * Outputs the HTML for the story blog * - * @since Fictioneer 5.9.0 + * @since 5.9.0 * * @param array $args['story_data'] Collection of story data. * @param int $args['story_id'] The story post ID. @@ -758,7 +758,7 @@ add_action( 'fictioneer_story_after_content', 'fictioneer_story_blog', 44 ); /** * Outputs the HTML for the story page comments * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $args['story_data'] Collection of story data. * @param int $args['story_id'] The story post ID. diff --git a/includes/functions/schemas/_chapter_schema.php b/includes/functions/schemas/_chapter_schema.php index f262a339..7f9f338d 100644 --- a/includes/functions/schemas/_chapter_schema.php +++ b/includes/functions/schemas/_chapter_schema.php @@ -10,7 +10,7 @@ * "There are only two hard things in Computer Science: cache invalidation and * naming things" -- Phil Karlton. * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The ID of the saved post. * @param WP_Post $post The saved post object. @@ -48,7 +48,7 @@ if ( ! function_exists( 'fictioneer_build_chapter_schema' ) ) { /** * Refresh single chapter schema * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The ID of the chapter the schema is for. * diff --git a/includes/functions/schemas/_chapters_schema.php b/includes/functions/schemas/_chapters_schema.php index ef433e43..3830f069 100644 --- a/includes/functions/schemas/_chapters_schema.php +++ b/includes/functions/schemas/_chapters_schema.php @@ -10,7 +10,7 @@ * "There are only two hard things in Computer Science: cache invalidation and * naming things" -- Phil Karlton. * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The ID of the saved post. * @param WP_Post $post The saved post object. @@ -58,7 +58,7 @@ if ( ! function_exists( 'fictioneer_build_chapters_schema' ) ) { /** * Refresh chapters summary schema * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The ID of the page the schema is for. * diff --git a/includes/functions/schemas/_collections_schema.php b/includes/functions/schemas/_collections_schema.php index 2d696c9b..fa324045 100644 --- a/includes/functions/schemas/_collections_schema.php +++ b/includes/functions/schemas/_collections_schema.php @@ -10,7 +10,7 @@ * "There are only two hard things in Computer Science: cache invalidation and * naming things" -- Phil Karlton. * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The ID of the saved post. * @param WP_Post $post The saved post object. @@ -58,7 +58,7 @@ if ( ! function_exists( 'fictioneer_build_collections_schema' ) ) { /** * Refresh collections summary schema * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The ID of the page the schema is for. * diff --git a/includes/functions/schemas/_post_schema.php b/includes/functions/schemas/_post_schema.php index 520e8863..8389c8bd 100644 --- a/includes/functions/schemas/_post_schema.php +++ b/includes/functions/schemas/_post_schema.php @@ -10,7 +10,7 @@ * "There are only two hard things in Computer Science: cache invalidation and * naming things" -- Phil Karlton. * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The ID of the saved post. * @param WP_Post $post The saved post object. @@ -40,7 +40,7 @@ if ( ! function_exists( 'fictioneer_build_post_schema' ) ) { /** * Refresh single post schema * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The ID of the recommendation the schema is for. * diff --git a/includes/functions/schemas/_recommendation_schema.php b/includes/functions/schemas/_recommendation_schema.php index 6855966b..2b808599 100644 --- a/includes/functions/schemas/_recommendation_schema.php +++ b/includes/functions/schemas/_recommendation_schema.php @@ -10,7 +10,7 @@ * "There are only two hard things in Computer Science: cache invalidation and * naming things" -- Phil Karlton. * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The ID of the saved post. * @param WP_Post $post The saved post object. @@ -40,7 +40,7 @@ if ( ! function_exists( 'fictioneer_build_recommendation_schema' ) ) { /** * Refresh single recommendation schema * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The ID of the recommendation the schema is for. * diff --git a/includes/functions/schemas/_recommendations_schema.php b/includes/functions/schemas/_recommendations_schema.php index ab0e455a..f88ed625 100644 --- a/includes/functions/schemas/_recommendations_schema.php +++ b/includes/functions/schemas/_recommendations_schema.php @@ -10,7 +10,7 @@ * "There are only two hard things in Computer Science: cache invalidation and * naming things" -- Phil Karlton. * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The ID of the saved post. * @param WP_Post $post The saved post object. @@ -58,7 +58,7 @@ if ( ! function_exists( 'fictioneer_build_recommendations_schema' ) ) { /** * Refresh recommendations summary schema * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The ID of the page the schema is for. * diff --git a/includes/functions/schemas/_stories_schema.php b/includes/functions/schemas/_stories_schema.php index 3ff9013e..533d46c1 100644 --- a/includes/functions/schemas/_stories_schema.php +++ b/includes/functions/schemas/_stories_schema.php @@ -10,7 +10,7 @@ * "There are only two hard things in Computer Science: cache invalidation and * naming things" -- Phil Karlton. * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The ID of the saved post. * @param WP_Post $post The saved post object. @@ -58,7 +58,7 @@ if ( ! function_exists( 'fictioneer_build_stories_schema' ) ) { /** * Refresh stories summary schema * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The ID of the page the schema is for. * diff --git a/includes/functions/schemas/_story_schema.php b/includes/functions/schemas/_story_schema.php index 58915989..59d19519 100644 --- a/includes/functions/schemas/_story_schema.php +++ b/includes/functions/schemas/_story_schema.php @@ -10,7 +10,7 @@ * "There are only two hard things in Computer Science: cache invalidation and * naming things" -- Phil Karlton. * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The ID of the saved post. * @param WP_Post $post The saved post object. @@ -50,7 +50,7 @@ if ( ! function_exists( 'fictioneer_build_story_schema' ) ) { /** * Refresh single story schema * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param int $post_id The ID of the story the schema is for. * diff --git a/includes/functions/settings/_register_settings.php b/includes/functions/settings/_register_settings.php index f2e64f71..586fdb26 100644 --- a/includes/functions/settings/_register_settings.php +++ b/includes/functions/settings/_register_settings.php @@ -977,7 +977,7 @@ define( 'FICTIONEER_OPTIONS', array( /** * Registers settings for the Fictioneer theme * - * @since Fictioneer 4.0 + * @since 4.0.0 */ function fictioneer_register_settings() { @@ -1037,7 +1037,7 @@ function fictioneer_register_settings() { /** * Validates the 'words per minute' setting with fallback * - * @since Fictioneer 4.0 + * @since 4.0.0 * @see fictioneer_sanitize_integer() * * @param int $input The input value to sanitize. @@ -1052,7 +1052,7 @@ function fictioneer_validate_words_per_minute( $input ) { /** * Validates integer to be 1 or more * - * @since Fictioneer 4.6 + * @since 4.6.0 * @see fictioneer_sanitize_integer() * * @param int $input The input value to sanitize. @@ -1067,7 +1067,7 @@ function fictioneer_validate_integer_one_up( $input ) { /** * Checks whether an ID is a valid page ID * - * @since Fictioneer 4.6 + * @since 4.6.0 * * @param int $input The page ID to be sanitized. * @@ -1081,7 +1081,7 @@ function fictioneer_validate_page_id( $input ) { /** * Validates an email address * - * @since Fictioneer 4.6 + * @since 4.6.0 * @see sanitize_email() * * @param int $input The email address to be sanitized. @@ -1101,7 +1101,7 @@ function fictioneer_validate_email_address( $input ) { * otherwise a default is returned. The content is also cleaned of any * problematic HTML. * - * @since Fictioneer 4.6 + * @since 4.6.0 * @see wp_kses_post() * * @param int $input The content for the cookie consent banner. diff --git a/includes/functions/settings/_settings.php b/includes/functions/settings/_settings.php index d9e370af..0c2161c6 100644 --- a/includes/functions/settings/_settings.php +++ b/includes/functions/settings/_settings.php @@ -16,7 +16,7 @@ require_once( '_settings_actions.php' ); /** * Add Fictioneer settings menu to admin panel * - * @since Fictioneer 4.0 + * @since 4.0.0 */ function fictioneer_add_admin_menu() { @@ -131,7 +131,7 @@ add_action( 'admin_menu', 'fictioneer_add_admin_menu' ); /** * Configure the screen options for the ePUBs page * - * @since Fictioneer 5.7.2 + * @since 5.7.2 */ function fictioneer_settings_epubs_screen_options() { @@ -147,7 +147,7 @@ function fictioneer_settings_epubs_screen_options() { /** * Configure the screen options for the SEO page * - * @since Fictioneer 5.7.2 + * @since 5.7.2 */ function fictioneer_settings_seo_screen_options() { @@ -163,7 +163,7 @@ function fictioneer_settings_seo_screen_options() { /** * Save custom screen options values * - * @since Fictioneer 5.7.2 + * @since 5.7.2 * * @param bool $status The current status of the screen option saving. * @param string $option The name of the screen option being saved. @@ -195,7 +195,7 @@ if ( ! function_exists( 'fictioneer_settings_header' ) ) { /** * Output HTML for the settings page header * - * @since Fictioneer 4.7 + * @since 4.7 * * @param string $tab The current tab to highlight. Defaults to 'general'. */ @@ -276,7 +276,7 @@ if ( ! function_exists( 'fictioneer_settings_header' ) ) { /** * Callback for connections settings page * - * @since Fictioneer 4.7 + * @since 4.7.0 */ function fictioneer_settings_connections() { @@ -286,7 +286,7 @@ function fictioneer_settings_connections() { /** * Callback for general settings page * - * @since Fictioneer 4.7 + * @since 4.7.0 */ function fictioneer_settings_general() { @@ -296,7 +296,7 @@ function fictioneer_settings_general() { /** * Callback for roles settings page * - * @since Fictioneer 4.7 + * @since 4.7.0 */ function fictioneer_settings_roles() { @@ -306,7 +306,7 @@ function fictioneer_settings_roles() { /** * Callback for plugins settings page * - * @since Fictioneer 5.7.1 + * @since 5.7.1 */ function fictioneer_settings_plugins() { @@ -316,7 +316,7 @@ function fictioneer_settings_plugins() { /** * Callback for epubs settings page * - * @since Fictioneer 4.7 + * @since 4.7.0 */ function fictioneer_settings_epubs() { @@ -326,7 +326,7 @@ function fictioneer_settings_epubs() { /** * Callback for SEO settings page * - * @since Fictioneer 4.7 + * @since 4.7.0 */ function fictioneer_settings_seo() { @@ -336,7 +336,7 @@ function fictioneer_settings_seo() { /** * Callback for phrases settings page * - * @since Fictioneer 4.7 + * @since 4.7.0 */ function fictioneer_settings_phrases() { @@ -346,7 +346,7 @@ function fictioneer_settings_phrases() { /** * Callback for tools settings page * - * @since Fictioneer 4.7 + * @since 4.7.0 */ function fictioneer_settings_tools() { @@ -356,7 +356,7 @@ function fictioneer_settings_tools() { /** * Callback for logs settings page * - * @since Fictioneer 4.7 + * @since 4.7.0 */ function fictioneer_settings_logs() { @@ -370,7 +370,7 @@ function fictioneer_settings_logs() { /** * Renders a role settings capability card * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param string $title The title of the card. * @param array $caps An array of capabilities. @@ -413,7 +413,7 @@ function fictioneer_settings_capability_card( $title, $caps, $role ) { /** * Renders a checkbox for a specific capability * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param string $cap The capability slug/string. * @param string $name Human-readable name for the capability. @@ -433,7 +433,7 @@ function fictioneer_settings_capability_checkbox( $cap, $name, $set ) { /** * Renders a label-wrapped setting checkbox * - * @since Fictioneer 5.7.2 + * @since 5.7.2 * * @param string $option The name of the setting option. * @param string $sub_label Optional. The description below the label. @@ -456,7 +456,7 @@ function fictioneer_settings_label_checkbox( $option, $sub_label = null ) { /** * Renders a label-wrapped setting text field * - * @since Fictioneer 5.7.2 + * @since 5.7.2 * * @param string $option The name of the setting option. * @param string $type Optional. The field type, default 'text'. @@ -474,7 +474,7 @@ function fictioneer_settings_text_input( $option, $type = 'text' ) { /** * Renders a setting textarea * - * @since Fictioneer 5.7.2 + * @since 5.7.2 * * @param string $option The name of the setting option. * @param string $height Optional. The height with unit, default 'auto'. @@ -490,7 +490,7 @@ function fictioneer_settings_textarea( $option, $height = 'auto' ) { /** * Renders a setting page assignment select field * - * @since Fictioneer 5.7.2 + * @since 5.7.2 * * @param string $option The name of the setting option. */ diff --git a/includes/functions/settings/_settings_actions.php b/includes/functions/settings/_settings_actions.php index 3e247535..2fb12446 100644 --- a/includes/functions/settings/_settings_actions.php +++ b/includes/functions/settings/_settings_actions.php @@ -7,7 +7,7 @@ /** * Verify a tool action request * - * @since Fictioneer 5.2.5 + * @since 5.2.5 * * @param string $action Name of the tool action. */ @@ -27,7 +27,7 @@ function fictioneer_verify_tool_action( $action ) { /** * Finish a tool action and perform a redirect * - * @since Fictioneer 5.2.5 + * @since 5.2.5 * * @param string $notice Optional. The notice message to include in the redirect URL. * @param string $type Optional. The type of notice. Default 'success'. @@ -48,7 +48,7 @@ if ( ! function_exists( 'fictioneer_get_default_genres' ) ) { /** * Return array of default genre from decoded JSON * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param array Decoded JSON with default genres and meta data. */ @@ -62,7 +62,7 @@ if ( ! function_exists( 'fictioneer_get_default_tags' ) ) { /** * Return array of default tags from decoded JSON * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param array Decoded JSON with default tags and meta data. */ @@ -127,7 +127,7 @@ if ( ! defined( 'FICTIONEER_ADMIN_SETTINGS_NOTICES' ) ) { /** * Output admin settings notices * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_admin_settings_notices() { @@ -172,7 +172,7 @@ add_action( 'admin_notices', 'fictioneer_admin_settings_notices' ); /** * Delete all generated ePUBs in the ./uploads/epubs/ directory * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_delete_all_epubs() { @@ -209,7 +209,7 @@ add_action( 'admin_post_fictioneer_delete_all_epubs', 'fictioneer_delete_all_epu /** * Generate a URL with a nonce for a tool action * - * @since Fictioneer 5.2.5 + * @since 5.2.5 * * @param string $action Action name. * @@ -223,7 +223,7 @@ function fictioneer_tool_action( $action ) { /** * Add a moderator role * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_add_moderator_role() { @@ -248,7 +248,7 @@ add_action( 'admin_post_fictioneer_add_moderator_role', 'fictioneer_tools_add_mo /** * Initialize roles * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_tools_initialize_roles() { @@ -271,7 +271,7 @@ add_action( 'admin_post_fictioneer_initialize_roles', 'fictioneer_tools_initiali /** * Convert story tags to genres * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_move_story_tags_to_genres() { @@ -296,7 +296,7 @@ add_action( 'admin_post_fictioneer_move_story_tags_to_genres', 'fictioneer_tools /** * Duplicate story tags to genres * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_duplicate_story_tags_to_genres() { @@ -317,7 +317,7 @@ add_action( 'admin_post_fictioneer_duplicate_story_tags_to_genres', 'fictioneer_ /** * Purge theme caches * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_purge_theme_caches() { @@ -353,7 +353,7 @@ add_action( 'admin_post_fictioneer_tools_purge_theme_caches', 'fictioneer_tools_ /** * Convert chapter tags to genres * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_move_chapter_tags_to_genres() { @@ -374,7 +374,7 @@ add_action( 'admin_post_fictioneer_move_chapter_tags_to_genres', 'fictioneer_too /** * Duplicate chapter tags to genres * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_duplicate_chapter_tags_to_genres() { @@ -395,7 +395,7 @@ add_action( 'admin_post_fictioneer_duplicate_chapter_tags_to_genres', 'fictionee /** * Append default genres * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_append_default_genres() { @@ -433,7 +433,7 @@ add_action( 'admin_post_fictioneer_append_default_genres', 'fictioneer_tools_app /** * Append default tags * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_append_default_tags() { @@ -465,7 +465,7 @@ add_action( 'admin_post_fictioneer_append_default_tags', 'fictioneer_tools_appen /** * Remove unused tags * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_remove_unused_tags() { @@ -499,7 +499,7 @@ add_action( 'admin_post_fictioneer_remove_unused_tags', 'fictioneer_tools_remove /** * Reset post relationship registry * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_reset_post_relationship_registry() { @@ -520,7 +520,7 @@ add_action( 'admin_post_fictioneer_reset_post_relationship_registry', 'fictionee /** * Fix users * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_fix_users() { @@ -538,7 +538,7 @@ add_action( 'admin_post_fictioneer_fix_users', 'fictioneer_tools_fix_users' ); /** * Fix stories * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_fix_stories() { @@ -556,7 +556,7 @@ add_action( 'admin_post_fictioneer_fix_stories', 'fictioneer_tools_fix_stories' /** * Fix chapters * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_fix_chapters() { @@ -574,7 +574,7 @@ add_action( 'admin_post_fictioneer_fix_chapters', 'fictioneer_tools_fix_chapters /** * Fix collections * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_fix_collections() { @@ -592,7 +592,7 @@ add_action( 'admin_post_fictioneer_fix_collections', 'fictioneer_tools_fix_colle /** * Fix pages * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_fix_pages() { @@ -610,7 +610,7 @@ add_action( 'admin_post_fictioneer_fix_pages', 'fictioneer_tools_fix_pages' ); /** * Fix posts * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_fix_posts() { @@ -628,7 +628,7 @@ add_action( 'admin_post_fictioneer_fix_posts', 'fictioneer_tools_fix_posts' ); /** * Fix recommendations * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_tools_fix_recommendations() { @@ -650,7 +650,7 @@ add_action( 'admin_post_fictioneer_fix_recommendations', 'fictioneer_tools_fix_r /** * Update role * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_update_role() { @@ -722,7 +722,7 @@ add_action( 'admin_post_fictioneer_update_role', 'fictioneer_update_role' ); /** * Add role * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_add_role() { @@ -803,7 +803,7 @@ add_action( 'admin_post_fictioneer_add_role', 'fictioneer_add_role' ); /** * Remove role * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_remove_role() { @@ -862,7 +862,7 @@ add_action( 'admin_post_fictioneer_remove_role', 'fictioneer_remove_role' ); /** * Rename role * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_rename_role() { @@ -951,7 +951,7 @@ add_action( 'admin_post_fictioneer_rename_role', 'fictioneer_rename_role' ); /** * Optimize database * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * @global wpdb $wpdb WordPress database object. */ @@ -1036,7 +1036,7 @@ add_action( 'admin_post_fictioneer_tools_optimize_database', 'fictioneer_tools_o /** * Optimize database preview * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * @global wpdb $wpdb WordPress database object. */ @@ -1109,7 +1109,7 @@ add_action( 'admin_post_fictioneer_tools_optimize_database_preview', 'fictioneer /** * Append missing 'fictioneer_story_hidden' post meta * - * @since Fictioneer 5.7.4 + * @since 5.7.4 */ function fictioneer_tools_add_story_hidden_fields() { @@ -1139,7 +1139,7 @@ add_action( 'admin_post_fictioneer_tools_add_story_hidden_fields', 'fictioneer_t /** * Append missing 'fictioneer_story_sticky' post meta * - * @since Fictioneer 5.7.4 + * @since 5.7.4 */ function fictioneer_tools_add_story_sticky_fields() { @@ -1169,7 +1169,7 @@ add_action( 'admin_post_fictioneer_tools_add_story_sticky_fields', 'fictioneer_t /** * Append missing 'fictioneer_chapter_hidden' post meta * - * @since Fictioneer 5.7.4 + * @since 5.7.4 */ function fictioneer_tools_add_chapter_hidden_fields() { @@ -1199,7 +1199,7 @@ add_action( 'admin_post_fictioneer_tools_add_chapter_hidden_fields', 'fictioneer /** * Append a missing meta field to selected posts * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * @global wpdb $wpdb WordPress database object. * * @param string $post_type The post type to append to. @@ -1248,7 +1248,7 @@ function fictioneer_append_meta_fields( $post_type, $meta_key, $meta_value ) { /** * Append chapters to a story by ID * - * @since Fictioneer 5.8.6 + * @since 5.8.6 * @see fictioneer_append_chapter_to_story() */ diff --git a/includes/functions/settings/_settings_ajax.php b/includes/functions/settings/_settings_ajax.php index 3db99a8b..50c4dbca 100644 --- a/includes/functions/settings/_settings_ajax.php +++ b/includes/functions/settings/_settings_ajax.php @@ -10,7 +10,7 @@ * Checks whether the request comes from the admin panel, the nonce, and the * current user’s capabilities. * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @return boolean True if valid, false if not. */ @@ -30,7 +30,7 @@ function fictioneer_validate_settings_ajax() { /** * AJAX: Delete an ePUB file from the server * - * @since Fictioneer 4.0 + * @since 4.0.0 */ function fictioneer_ajax_delete_epub() { @@ -95,7 +95,7 @@ add_action( 'wp_ajax_fictioneer_ajax_delete_epub', 'fictioneer_ajax_delete_epub' /** * AJAX: Purge schema for a post/page * - * @since Fictioneer 4.0 + * @since 4.0.0 */ function fictioneer_ajax_purge_schema() { @@ -158,7 +158,7 @@ add_action( 'wp_ajax_fictioneer_ajax_purge_schema', 'fictioneer_ajax_purge_schem /** * AJAX: Purge schemas for all posts and pages * - * @since Fictioneer 5.7.2 + * @since 5.7.2 */ function fictioneer_ajax_purge_all_schemas() { diff --git a/includes/functions/settings/_settings_loggers.php b/includes/functions/settings/_settings_loggers.php index 2338c89d..def86dac 100644 --- a/includes/functions/settings/_settings_loggers.php +++ b/includes/functions/settings/_settings_loggers.php @@ -7,7 +7,7 @@ /** * Log a message to the theme log file * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $message What has been updated * @param WP_User|null $user The user who did it. Defaults to current user. @@ -100,7 +100,7 @@ function fictioneer_get_log() { /** * Log post update * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $post_id The post ID. * @param string $action The action performed. @@ -131,7 +131,7 @@ function fictioneer_log_post_update( $post_id, $action ) { /** * Log update of checkbox option * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $option Name of the option. * @param boolean|null $old_value The previous value or null if not set. @@ -158,7 +158,7 @@ function fictioneer_log_checkbox_update( $option, $old_value, $value ) { /** * Helper to log added theme boolean option * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $option Name of the option. * @param boolean $value The new value. @@ -182,7 +182,7 @@ add_action( 'added_option', 'fictioneer_settings_checkbox_added', 10, 2 ); /** * Helper to log updated theme boolean option * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $option Name of the option. * @param boolean $old_value The previous value. @@ -224,7 +224,7 @@ define( /** * Log update of page assignment * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $option Name of the option. * @param int|null $old_value The previous value or null if not set. @@ -256,7 +256,7 @@ function fictioneer_log_page_assignment_update( $option, $old_value, $value ) { /** * Helper to log added page assignment option * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $option Name of the option. * @param int $value The new value. @@ -280,7 +280,7 @@ add_action( 'added_option', 'fictioneer_settings_page_assignment_added', 10, 2 ) /** * Helper to log updated page assignment option * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $option Name of the option. * @param int $old_value The previous value. @@ -319,7 +319,7 @@ define( /** * Log update of phrase option * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $option Name of the option. * @param string|null $old_value The previous value or null if not set. @@ -350,7 +350,7 @@ function fictioneer_log_phrase_update( $option, $old_value, $value ) { /** * Helper to log added phrase option * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $option Name of the option. * @param string $value The new value. @@ -374,7 +374,7 @@ add_action( 'added_option', 'fictioneer_settings_phrase_added', 10, 2 ); /** * Helper to log updated phrase option * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $option Name of the option. * @param string $old_value The previous value. @@ -419,7 +419,7 @@ define( /** * Log update of connection option * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $connection Name of the connection option. * @param int|null $old_value ID of the old page or null if unset. @@ -449,7 +449,7 @@ function fictioneer_log_connection_update( $connection, $old_value, $value ) { /** * Helper to log added connection option * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $option Name of the option. * @param string $value The new value. @@ -473,7 +473,7 @@ add_action( 'added_option', 'fictioneer_settings_connection_added', 10, 2 ); /** * Helper to log updated connection option * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $option Name of the option. * @param string $old_value The previous value. @@ -516,7 +516,7 @@ add_action( 'untrashed_post', function( $post_id ) { /** * Helper to log published posts * - * @since Fictioneer 5.0 + * @since 5.0.0 * @see fictioneer_log_post_update() * * @param int $post_id The post ID. @@ -552,7 +552,7 @@ add_action( 'publish_fcn_recommendation', 'fictioneer_log_published_posts' ); /** * Helper to log pending posts * - * @since Fictioneer 5.0 + * @since 5.0.0 * @see fictioneer_log_post_update() * * @param int $post_id The post ID. @@ -582,7 +582,7 @@ add_action( 'pending_fcn_recommendation', 'fictioneer_log_published_posts' ); /** * Helper to log deleted posts * - * @since Fictioneer 5.0 + * @since 5.0.0 * @see fictioneer_log_post_update() * * @param int $post_id The post ID. diff --git a/includes/functions/settings/_settings_page_connections.php b/includes/functions/settings/_settings_page_connections.php index 6da23936..b5b10cd2 100644 --- a/includes/functions/settings/_settings_page_connections.php +++ b/includes/functions/settings/_settings_page_connections.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.7 + * @since 4.7.0 */ ?> diff --git a/includes/functions/settings/_settings_page_epubs.php b/includes/functions/settings/_settings_page_epubs.php index e6a50242..7a6d8542 100644 --- a/includes/functions/settings/_settings_page_epubs.php +++ b/includes/functions/settings/_settings_page_epubs.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.7 + * @since 4.7.0 */ ?> diff --git a/includes/functions/settings/_settings_page_general.php b/includes/functions/settings/_settings_page_general.php index 11cfdcb4..8481ea03 100644 --- a/includes/functions/settings/_settings_page_general.php +++ b/includes/functions/settings/_settings_page_general.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.7 + * @since 4.7.0 */ ?> diff --git a/includes/functions/settings/_settings_page_logs.php b/includes/functions/settings/_settings_page_logs.php index 65caf4e4..d7064c68 100644 --- a/includes/functions/settings/_settings_page_logs.php +++ b/includes/functions/settings/_settings_page_logs.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 */ ?> diff --git a/includes/functions/settings/_settings_page_phrases.php b/includes/functions/settings/_settings_page_phrases.php index 270b79f8..bd628f30 100644 --- a/includes/functions/settings/_settings_page_phrases.php +++ b/includes/functions/settings/_settings_page_phrases.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.7 + * @since 4.7.0 */ ?> diff --git a/includes/functions/settings/_settings_page_seo.php b/includes/functions/settings/_settings_page_seo.php index 2a7d8c64..218698f9 100644 --- a/includes/functions/settings/_settings_page_seo.php +++ b/includes/functions/settings/_settings_page_seo.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.7 + * @since 4.7.0 */ ?> diff --git a/includes/functions/settings/_settings_page_tools.php b/includes/functions/settings/_settings_page_tools.php index b84e6a54..d08ab69e 100644 --- a/includes/functions/settings/_settings_page_tools.php +++ b/includes/functions/settings/_settings_page_tools.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.7 + * @since 4.7.0 */ ?> diff --git a/includes/functions/users/_admin_profile.php b/includes/functions/users/_admin_profile.php index 50dad04e..e58035fd 100644 --- a/includes/functions/users/_admin_profile.php +++ b/includes/functions/users/_admin_profile.php @@ -7,7 +7,7 @@ /** * Verify an admin profile action request * - * @since Fictioneer 5.2.5 + * @since 5.2.5 * * @param string $action Name of the admin profile action. */ @@ -22,7 +22,7 @@ function fictioneer_verify_admin_profile_action( $action ) { /** * Finish an admin profile action and perform a redirect * - * @since Fictioneer 5.2.5 + * @since 5.2.5 * * @param string $notice Optional. The notice message to include in the redirect URL. * @param string $type Optional. The type of notice. Default 'success'. @@ -46,7 +46,7 @@ function fictioneer_finish_admin_profile_action( $notice = '', $type = 'success' /** * Unset OAuth * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_admin_profile_unset_oauth() { @@ -88,7 +88,7 @@ add_action( 'admin_post_fictioneer_admin_profile_unset_oauth', 'fictioneer_admin /** * Cleat data node * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_admin_profile_clear_data_node() { @@ -152,7 +152,7 @@ add_action( 'admin_post_fictioneer_admin_profile_clear_data_node', 'fictioneer_a /** * Self-delete account * - * @since Fictioneer 5.6.0 + * @since 5.6.0 */ function fictioneer_admin_profile_self_delete() { @@ -217,7 +217,7 @@ if ( ! defined( 'FICTIONEER_ADMIN_PROFILE_NOTICES' ) ) { /** * Output admin settings notices * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_admin_profile_notices() { @@ -244,7 +244,7 @@ add_action( 'admin_notices', 'fictioneer_admin_profile_notices' ); /** * Add custom HTML to the admin user profile page * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param WP_User $profile_user The profile user object. Not necessarily the one * currently editing the profile! @@ -283,7 +283,7 @@ add_action( 'edit_user_profile', 'fictioneer_custom_profile_fields', 20 ); /** * Render user ID in admin profile * - * @since Fictioneer 5.7.4 + * @since 5.7.4 * * @param WP_User $profile_user The profile user object. Not necessarily the one * currently editing the profile! @@ -315,7 +315,7 @@ add_action( 'fictioneer_admin_user_sections', 'fictioneer_admin_profile_fields_u /** * Render fingerprint in admin profile * - * @since Fictioneer 5.2.5 + * @since 5.2.5 * * @param WP_User $profile_user The profile user object. Not necessarily the one * currently editing the profile! @@ -350,7 +350,7 @@ add_action( 'fictioneer_admin_user_sections', 'fictioneer_admin_profile_fields_f /** * Render profile flags in admin profile * - * @since Fictioneer 5.2.5 + * @since 5.2.5 * * @param WP_User $profile_user The profile user object. Not necessarily the one * currently editing the profile! @@ -477,7 +477,7 @@ add_action( 'fictioneer_admin_user_sections', 'fictioneer_admin_profile_fields_f /** * Render OAuth connections in admin profile * - * @since Fictioneer 5.2.5 + * @since 5.2.5 * * @param WP_User $profile_user The profile user object. Not necessarily the one * currently editing the profile! @@ -582,7 +582,7 @@ if ( get_option( 'fictioneer_enable_oauth' ) ) { /** * Render data nodes in admin profile * - * @since Fictioneer 5.2.5 + * @since 5.2.5 * * @param WP_User $profile_user The profile user object. Not necessarily the one * currently editing the profile! @@ -739,7 +739,7 @@ add_action( 'fictioneer_admin_user_sections', 'fictioneer_admin_profile_fields_d /** * Adds HTML for the moderation section to the wp-admin user profile * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $profile_user The profile user object. Not necessarily the one * currently editing the profile! @@ -837,7 +837,7 @@ add_action( 'fictioneer_admin_user_sections', 'fictioneer_admin_profile_moderati /** * Adds HTML for the author section to the wp-admin user profile * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $profile_user The profile user object. Not necessarily the one * currently editing the profile! @@ -932,7 +932,7 @@ add_action( 'fictioneer_admin_user_sections', 'fictioneer_admin_profile_author', /** * Adds HTML for the OAuth section to the wp-admin user profile * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $profile_user The profile user object. Not necessarily the one * currently editing the profile! @@ -980,7 +980,7 @@ if ( FICTIONEER_SHOW_OAUTH_HASHES ) { /** * Adds HTML for the badge section to the wp-admin user profile * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $profile_user The profile user object. Not necessarily the one * currently editing the profile! @@ -1014,7 +1014,7 @@ add_action( 'fictioneer_admin_user_sections', 'fictioneer_admin_profile_badge', /** * Adds HTML for the external avatar section to the wp-admin user profile * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $profile_user The profile user object. Not necessarily the one * currently editing the profile! @@ -1048,7 +1048,7 @@ add_action( 'fictioneer_admin_user_sections', 'fictioneer_admin_profile_external /** * Adds HTML for the danger zone section to the wp-admin user profile * - * @since Fictioneer 5.6.0 + * @since 5.6.0 * * @param WP_User $profile_user The profile user object. Not necessarily the one * currently editing the profile! diff --git a/includes/functions/users/_avatars.php b/includes/functions/users/_avatars.php index d013cc89..72231bdc 100644 --- a/includes/functions/users/_avatars.php +++ b/includes/functions/users/_avatars.php @@ -8,7 +8,7 @@ if ( ! function_exists( 'fictioneer_get_default_avatar_url' ) ) { /** * Returns the default avatar URL * - * @since Fictioneer 5.5.3 + * @since 5.5.3 * * @return string Default avatar URL. */ @@ -48,7 +48,7 @@ if ( ! function_exists( 'fictioneer_get_default_avatar_url' ) ) { /** * Add fallback inline script to avatars * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param string $avatar HTML for the avatar. * @param string $id_or_email ID or email of the user. @@ -71,7 +71,7 @@ if ( ! function_exists( 'fictioneer_get_custom_avatar_url' ) ) { /** * Get custom avatar URL * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param WP_User $user The user to get the avatar for. * @@ -99,7 +99,7 @@ if ( ! function_exists( 'fictioneer_get_custom_avatar_url' ) ) { /** * Filter the avatar URL * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param string $url The default URL by WordPress. * @param int|string $id_or_email User ID or email address. @@ -147,7 +147,7 @@ add_filter( 'get_avatar_url', 'fictioneer_get_avatar_url', 10, 3 ); /** * Get user avatar URL via AJAX * - * @since Fictioneer 4.0 + * @since 4.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_get_validated_ajax_user() diff --git a/includes/functions/users/_bookmarks.php b/includes/functions/users/_bookmarks.php index e5067d4a..270c4673 100644 --- a/includes/functions/users/_bookmarks.php +++ b/includes/functions/users/_bookmarks.php @@ -10,7 +10,7 @@ * Note: Bookmarks are not evaluated server-side, only stored as JSON string. * Everything else happens client-side. * - * @since Fictioneer 4.0 + * @since 4.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_get_validated_ajax_user() diff --git a/includes/functions/users/_checkmarks.php b/includes/functions/users/_checkmarks.php index 08975591..d923d834 100644 --- a/includes/functions/users/_checkmarks.php +++ b/includes/functions/users/_checkmarks.php @@ -11,7 +11,7 @@ if ( ! function_exists( 'fictioneer_load_checkmarks' ) ) { * Get an user's Checkmarks array from the database or creates a new one if it * does not yet exist. * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $user User to get the checkmarks for. * @@ -47,7 +47,7 @@ if ( ! function_exists( 'fictioneer_get_finished_checkmarks' ) ) { /** * Returns array of story IDs marked as finished * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $checkmarks The user's checkmarks. * @@ -78,7 +78,7 @@ if ( ! function_exists( 'fictioneer_count_chapter_checkmarks' ) ) { /** * Returns the total number of chapter checkmarks * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param array $checkmarks The user's checkmarks. * @@ -110,7 +110,7 @@ if ( ! function_exists( 'fictioneer_count_chapter_checkmarks' ) ) { /** * Set Checkmarks for a story via AJAX * - * @since Fictioneer 4.0 + * @since 4.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_get_validated_ajax_user() @@ -188,7 +188,7 @@ if ( get_option( 'fictioneer_enable_checkmarks' ) ) { /** * Clears Checkmarks for a story via AJAX * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_get_validated_ajax_user() @@ -224,7 +224,7 @@ if ( get_option( 'fictioneer_enable_checkmarks' ) ) { /** * Sends the HTML for list of finished stories via AJAX * - * @since Fictioneer 4.3 + * @since 4.3.0 */ function fictioneer_ajax_get_finished_checkmarks_list() { diff --git a/includes/functions/users/_follows.php b/includes/functions/users/_follows.php index 8aeb0c28..a81019fb 100644 --- a/includes/functions/users/_follows.php +++ b/includes/functions/users/_follows.php @@ -11,7 +11,7 @@ if ( ! function_exists( 'fictioneer_load_follows' ) ) { * Get an user's Follows array from the database or creates a new one if it * does not yet exist. * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $user User to get the Follows for. * @@ -51,7 +51,7 @@ if ( ! function_exists( 'fictioneer_load_follows' ) ) { /** * Toggle Follow for a story via AJAX * - * @since Fictioneer 4.3 + * @since 4.3.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_get_validated_ajax_user() @@ -121,7 +121,7 @@ if ( get_option( 'fictioneer_enable_follows' ) ) { /** * Clears an user's Follows via AJAX * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_get_validated_ajax_user() @@ -162,7 +162,7 @@ if ( get_option( 'fictioneer_enable_follows' ) ) { * which is used to determine whether Follows are new. This will mark all * of them as read, you cannot mark single items in the list as read. * - * @since Fictioneer 4.3 + * @since 4.3.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_get_validated_ajax_user() @@ -212,7 +212,7 @@ if ( ! function_exists( 'fictioneer_query_followed_chapters' ) ) { /** * Query chapters of followed stories * - * @since Fictioneer 4.3 + * @since 4.3.0 * * @param array $story_ids IDs of the followed stories. * @param string|false $after_date Optional. Only return chapters after this date, e.g. wp_date( 'c', $timestamp ). @@ -269,7 +269,7 @@ if ( ! function_exists( 'fictioneer_query_followed_chapters' ) ) { /** * Sends the HTML for Follows notifications via AJAX * - * @since Fictioneer 4.3 + * @since 4.3.0 * @see fictioneer_check_rate_limit() * @see fictioneer_get_validated_ajax_user() */ @@ -378,7 +378,7 @@ if ( get_option( 'fictioneer_enable_follows' ) ) { /** * Sends the HTML for list of followed stories via AJAX * - * @since Fictioneer 4.3 + * @since 4.3.0 */ function fictioneer_ajax_get_follows_list() { diff --git a/includes/functions/users/_reminders.php b/includes/functions/users/_reminders.php index 676b1e6e..db30bedd 100644 --- a/includes/functions/users/_reminders.php +++ b/includes/functions/users/_reminders.php @@ -11,7 +11,7 @@ if ( ! function_exists( 'fictioneer_load_reminders' ) ) { * Get an user's Reminders array from the database or creates a new one if it * does not yet exist. * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $user User to get the Reminders for. * @@ -47,7 +47,7 @@ if ( ! function_exists( 'fictioneer_load_reminders' ) ) { * Set Reminder for a story via AJAX * * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_get_validated_ajax_user() @@ -114,7 +114,7 @@ if ( get_option( 'fictioneer_enable_reminders' ) ) { /** * Clears an user's Reminders via AJAX * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_get_validated_ajax_user() @@ -150,7 +150,7 @@ if ( get_option( 'fictioneer_enable_reminders' ) ) { /** * Sends the HTML for list of remembered stories via AJAX * - * @since Fictioneer 4.3 + * @since 4.3.0 */ function fictioneer_ajax_get_reminders_list() { diff --git a/includes/functions/users/_user_data.php b/includes/functions/users/_user_data.php index 49be2d1c..22c3f5b9 100644 --- a/includes/functions/users/_user_data.php +++ b/includes/functions/users/_user_data.php @@ -7,7 +7,7 @@ /** * Make sure local storage is cleared on logout * - * @since Fictioneer 5.0 + * @since 5.0.0 */ function fictioneer_after_logout_cleanup() { @@ -32,7 +32,7 @@ add_action( 'login_form', 'fictioneer_after_logout_cleanup' ); * * Moderators can update some of these fields, administrators can update all. * - * @since Fictioneer 4.3 + * @since 4.3.0 * * @param int $updated_user_id The ID of the updated user. */ @@ -189,7 +189,7 @@ add_action( 'edit_user_profile_update', 'fictioneer_update_admin_user_profile' ) * * Only the respective user or an administrator can update these fields. * - * @since Fictioneer 4.3 + * @since 4.3.0 * * @param int $updated_user_id The ID of the updated user. */ @@ -350,7 +350,7 @@ add_action( 'edit_user_profile_update', 'fictioneer_update_my_user_profile' ); /** * Update profile from frontend * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_update_frontend_profile() { @@ -441,7 +441,7 @@ add_action( 'admin_post_fictioneer_update_frontend_profile', 'fictioneer_update_ /** * Cancel email change from frontend * - * @since Fictioneer 5.2.5 + * @since 5.2.5 */ function fictioneer_cancel_frontend_email_change() { @@ -475,7 +475,7 @@ add_action( 'admin_post_fictioneer_cancel_frontend_email_change', 'fictioneer_ca /** * Trigger delegated functions on user profile update * - * @since Fictioneer 5.8.0 + * @since 5.8.0 * * @param int $user_id The ID of the updated user. * @param WP_User $old_user_data Object containing user's data prior to update. @@ -500,7 +500,7 @@ add_filter( 'profile_update', 'fictioneer_on_profile_change', 10, 2 ); /** * Updates the display name on all comments for a given user * - * @since Fictioneer 5.8.0 + * @since 5.8.0 * * @global wpdb $wpdb WordPress database object. * @@ -523,7 +523,7 @@ function fictioneer_update_user_comments_nickname( $user_id, $new_display_name ) * Note: Will not update comments that have no 'comment_author_email' set, * because this might be a privacy issue. * - * @since Fictioneer 5.8.0 + * @since 5.8.0 * * @global wpdb $wpdb WordPress database object. * @@ -558,7 +558,7 @@ if ( ! function_exists( 'fictioneer_get_comment_badge' ) ) { /** * Get HTML for comment badge * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User|null $user The comment user. * @param WP_Comment|null $comment Optional. The comment object. @@ -657,7 +657,7 @@ if ( ! function_exists( 'fictioneer_get_override_badge' ) ) { /** * Get an user's custom badge (if any) * - * @since Fictioneer 4.0 + * @since 4.0.0 * * @param WP_User $user The user. * @param string|boolean $default Default value or false. @@ -695,7 +695,7 @@ if ( ! function_exists( 'fictioneer_get_patreon_badge' ) ) { /** * Get an user's Patreon badge (if any) * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $user The user. * @param string|boolean $default Default value or false. @@ -735,7 +735,7 @@ if ( ! function_exists( 'fictioneer_get_user_fingerprint' ) ) { * display name (which is possible) but without exposing any sensitive data, * a simple cryptic hash is calculated. * - * @since Fictioneer 4.7 + * @since 4.7.0 * * @param int $user_id User ID to get the hash for. * @@ -775,7 +775,7 @@ if ( ! function_exists( 'fictioneer_get_user_fingerprint' ) ) { /** * Unset one of the user's OAuth bindings via AJAX * - * @since Fictioneer 4.0 + * @since 4.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ */ @@ -833,7 +833,7 @@ if ( ! function_exists( 'fictioneer_soft_delete_user_comments' ) ) { * but leave the comment itself in the database. This preserves the * structure of comment threads. * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param int $user_id User ID to soft delete the comments for. * @@ -909,7 +909,7 @@ if ( ! function_exists( 'fictioneer_soft_delete_user_comments' ) ) { * Queries all comments of the user and overrides the comment data with * garbage, preserving the comment thread integrity. * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_get_validated_ajax_user() @@ -977,7 +977,7 @@ add_action( 'wp_ajax_fictioneer_ajax_clear_my_comments', 'fictioneer_ajax_clear_ * all associated previous comment subscriptions. This is far cheaper than looping * and updating all comments. * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_get_validated_ajax_user() @@ -1007,7 +1007,7 @@ add_action( 'wp_ajax_fictioneer_ajax_clear_my_comment_subscriptions', 'fictionee /** * Delete an user's account via AJAX * - * @since Fictioneer 4.5 + * @since 4.5.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_validate_id() @@ -1061,7 +1061,7 @@ if ( current_user_can( 'fcn_allow_self_delete' ) ) { /** * Get relevant user data via AJAX * - * @since Fictioneer 5.7.0 + * @since 5.7.0 */ function fictioneer_ajax_get_user_data() { diff --git a/index.php b/index.php index 6efe108a..4307ed83 100644 --- a/index.php +++ b/index.php @@ -7,7 +7,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.6 + * @since 4.6.0 * @see partials/_loop.php */ ?> diff --git a/partials/_bookmarks.php b/partials/_bookmarks.php index ad4d1482..3137a332 100644 --- a/partials/_bookmarks.php +++ b/partials/_bookmarks.php @@ -6,7 +6,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * * @internal $args['show_empty'] Whether to render a note when empty or nothing at all. * @internal $args['count'] Maximum number of bookmarks to render. diff --git a/partials/_card-chapter.php b/partials/_card-chapter.php index 905af90c..3a22351e 100644 --- a/partials/_card-chapter.php +++ b/partials/_card-chapter.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * * @internal $args['show_type'] Whether to show the post type label. Unsafe. * @internal $args['cache'] Whether to account for active caching. Unsafe. diff --git a/partials/_card-collection.php b/partials/_card-collection.php index 5d176cfd..618448bc 100644 --- a/partials/_card-collection.php +++ b/partials/_card-collection.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * * @internal $args['show_type'] Whether to show the post type label. Unsafe. * @internal $args['cache'] Whether to account for active caching. Unsafe. diff --git a/partials/_card-page.php b/partials/_card-page.php index 65d5a56d..42278d16 100644 --- a/partials/_card-page.php +++ b/partials/_card-page.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 * * @internal $args['show_type'] Whether to show the post type label. Unsafe. * @internal $args['cache'] Whether to account for active caching. Unsafe. diff --git a/partials/_card-post.php b/partials/_card-post.php index a69b795f..0b1925af 100644 --- a/partials/_card-post.php +++ b/partials/_card-post.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * * @internal $args['show_type'] Whether to show the post type label. Unsafe. * @internal $args['cache'] Whether to account for active caching. Unsafe. diff --git a/partials/_card-recommendation.php b/partials/_card-recommendation.php index 2e4c6463..2d9180b5 100644 --- a/partials/_card-recommendation.php +++ b/partials/_card-recommendation.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * * @internal $args['show_type'] Whether to show the post type label. Unsafe. * @internal $args['cache'] Whether to account for active caching. Unsafe. diff --git a/partials/_card-story.php b/partials/_card-story.php index 88e50628..974c1995 100644 --- a/partials/_card-story.php +++ b/partials/_card-story.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * * @internal $args['show_type'] Whether to show the post type label. Unsafe. * @internal $args['cache'] Whether to account for active caching. Unsafe. diff --git a/partials/_chapter-header.php b/partials/_chapter-header.php index cd25bc6c..4309bd55 100644 --- a/partials/_chapter-header.php +++ b/partials/_chapter-header.php @@ -7,7 +7,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 * @see single-fcn_chapter.php * * @internal $args['story_post'] Optional. Post object of the story. diff --git a/partials/_collection-header.php b/partials/_collection-header.php index 828da969..9cd7e95a 100644 --- a/partials/_collection-header.php +++ b/partials/_collection-header.php @@ -7,7 +7,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 * @see single-fcn_collection.php * * @internal $args['collection'] Collection post object. diff --git a/partials/_collection-statistics.php b/partials/_collection-statistics.php index e9f77f60..d59d9afb 100644 --- a/partials/_collection-statistics.php +++ b/partials/_collection-statistics.php @@ -8,7 +8,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.7 + * @since 4.7.0 * @see single-fcn_collection.php * * @internal $args['collection'] Collection post object. diff --git a/partials/_consent-banner.php b/partials/_consent-banner.php index 662df78a..86e5fe84 100644 --- a/partials/_consent-banner.php +++ b/partials/_consent-banner.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 */ ?> diff --git a/partials/_header-inner.php b/partials/_header-inner.php index 534cdb9b..9ea642be 100644 --- a/partials/_header-inner.php +++ b/partials/_header-inner.php @@ -6,7 +6,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 * * @internal $args['post_id'] Optional. Current post ID. * @internal $args['story_id'] Optional. Current story ID (if chapter). diff --git a/partials/_icon-menu.php b/partials/_icon-menu.php index 20034ffe..85c3c282 100644 --- a/partials/_icon-menu.php +++ b/partials/_icon-menu.php @@ -7,7 +7,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * * @internal $args['location'] Either 'in-navigation' or 'in-mobile-menu'. */ diff --git a/partials/_latest-chapters-compact.php b/partials/_latest-chapters-compact.php index 5c66a6f2..7a747fb6 100644 --- a/partials/_latest-chapters-compact.php +++ b/partials/_latest-chapters-compact.php @@ -6,7 +6,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * * @internal $args['count'] Number of posts provided by the shortcode. * @internal $args['author'] Author provided by the shortcode. diff --git a/partials/_latest-chapters.php b/partials/_latest-chapters.php index 5d14f24d..4840d4e8 100644 --- a/partials/_latest-chapters.php +++ b/partials/_latest-chapters.php @@ -6,7 +6,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * * @internal $args['count'] Number of posts provided by the shortcode. * @internal $args['author'] Author provided by the shortcode. diff --git a/partials/_latest-posts.php b/partials/_latest-posts.php index d562e8f6..6836a27e 100644 --- a/partials/_latest-posts.php +++ b/partials/_latest-posts.php @@ -6,7 +6,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * * @internal $args['author'] The author provided by the shortcode. Default false. * @internal $args['count'] The number of posts provided by the shortcode. Default 1. diff --git a/partials/_latest-recommendations-compact.php b/partials/_latest-recommendations-compact.php index 0b1d1d68..fa0df38e 100644 --- a/partials/_latest-recommendations-compact.php +++ b/partials/_latest-recommendations-compact.php @@ -6,7 +6,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * * @internal $args['count'] Number of posts provided by the shortcode. * @internal $args['author'] Author provided by the shortcode. diff --git a/partials/_latest-recommendations.php b/partials/_latest-recommendations.php index 0894ed2a..ae18c707 100644 --- a/partials/_latest-recommendations.php +++ b/partials/_latest-recommendations.php @@ -6,7 +6,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * * @internal $args['count'] Number of posts provided by the shortcode. * @internal $args['author'] Author provided by the shortcode. diff --git a/partials/_latest-stories-compact.php b/partials/_latest-stories-compact.php index dbcd959b..d811f944 100644 --- a/partials/_latest-stories-compact.php +++ b/partials/_latest-stories-compact.php @@ -6,7 +6,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * @see fictioneer_clause_sticky_stories() * * @internal $args['count'] Number of posts provided by the shortcode. diff --git a/partials/_latest-stories.php b/partials/_latest-stories.php index 4245399a..8bf988dc 100644 --- a/partials/_latest-stories.php +++ b/partials/_latest-stories.php @@ -6,7 +6,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * @see fictioneer_clause_sticky_stories() * * @internal $args['count'] Number of posts provided by the shortcode. diff --git a/partials/_latest-updates-compact.php b/partials/_latest-updates-compact.php index 17bd9343..5dc38749 100644 --- a/partials/_latest-updates-compact.php +++ b/partials/_latest-updates-compact.php @@ -9,7 +9,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.3 + * @since 4.3.0 * * @internal $args['count'] Number of posts provided by the shortcode. * @internal $args['author'] Author provided by the shortcode. diff --git a/partials/_latest-updates.php b/partials/_latest-updates.php index c6684d5b..6d9dba29 100644 --- a/partials/_latest-updates.php +++ b/partials/_latest-updates.php @@ -10,7 +10,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.3 + * @since 4.3.0 * * @internal $args['count'] Number of posts provided by the shortcode. * @internal $args['author'] Author provided by the shortcode. diff --git a/partials/_modal-bbcodes.php b/partials/_modal-bbcodes.php index 59410766..1f81bc9e 100644 --- a/partials/_modal-bbcodes.php +++ b/partials/_modal-bbcodes.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 */ ?> diff --git a/partials/_modal-formatting.php b/partials/_modal-formatting.php index cebd2b81..6228ecea 100644 --- a/partials/_modal-formatting.php +++ b/partials/_modal-formatting.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 */ ?> diff --git a/partials/_modal-login.php b/partials/_modal-login.php index 247da758..69aa04f0 100644 --- a/partials/_modal-login.php +++ b/partials/_modal-login.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 */ ?> diff --git a/partials/_modal-sharing.php b/partials/_modal-sharing.php index f49d0b1d..34b79804 100644 --- a/partials/_modal-sharing.php +++ b/partials/_modal-sharing.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 */ ?> diff --git a/partials/_modal-site-settings.php b/partials/_modal-site-settings.php index f47c73e5..50e4b78e 100644 --- a/partials/_modal-site-settings.php +++ b/partials/_modal-site-settings.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.1 + * @since 4.1.0 */ ?> diff --git a/partials/_modal-suggestions.php b/partials/_modal-suggestions.php index f5dc6e28..1858c9e0 100644 --- a/partials/_modal-suggestions.php +++ b/partials/_modal-suggestions.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 */ ?> diff --git a/partials/_navigation.php b/partials/_navigation.php index 003cf6a4..404ffc34 100644 --- a/partials/_navigation.php +++ b/partials/_navigation.php @@ -6,7 +6,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 * * @internal $args['post_id'] Optional. Current post ID. * @internal $args['story_id'] Optional. Current story ID (if chapter). diff --git a/partials/_recommendation-header.php b/partials/_recommendation-header.php index afc6d47d..9e413e75 100644 --- a/partials/_recommendation-header.php +++ b/partials/_recommendation-header.php @@ -7,7 +7,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 * @see single-fcn_recommendation.php * * @internal $args['recommendation'] Recommendation post object. diff --git a/partials/_share-buttons.php b/partials/_share-buttons.php index 97f4399d..35996009 100644 --- a/partials/_share-buttons.php +++ b/partials/_share-buttons.php @@ -7,7 +7,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.7 + * @since 4.7.0 * @see partials/_modal-sharing.php */ ?> diff --git a/partials/_showcase.php b/partials/_showcase.php index 4101aefe..cc90b84e 100644 --- a/partials/_showcase.php +++ b/partials/_showcase.php @@ -9,7 +9,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * * @internal $args['post_type'] Post type if the showcase. * @internal $args['count'] Maximum number of items. Default 8. diff --git a/partials/_story-comments.php b/partials/_story-comments.php index d7de4701..fbb623a7 100644 --- a/partials/_story-comments.php +++ b/partials/_story-comments.php @@ -8,7 +8,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.7 + * @since 4.7.0 * @see single-fcn_story.php * * @internal $args['story_data'] Story data from fictioneer_get_story_data(). diff --git a/partials/_story-footer.php b/partials/_story-footer.php index 6e6d19fb..cb979362 100644 --- a/partials/_story-footer.php +++ b/partials/_story-footer.php @@ -8,7 +8,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.7 + * @since 4.7.0 * @see single-fcn_story.php * * @internal $args['story_data'] Story data from fictioneer_get_story_data(). diff --git a/partials/_story-header.php b/partials/_story-header.php index 79ec0b23..448ae000 100644 --- a/partials/_story-header.php +++ b/partials/_story-header.php @@ -7,7 +7,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 * @see single-fcn_story.php * * @internal $args['story_data'] Story data from fictioneer_get_story_data(). diff --git a/partials/_tts-interface.php b/partials/_tts-interface.php index 41c4dd9d..ccda7919 100644 --- a/partials/_tts-interface.php +++ b/partials/_tts-interface.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 */ ?> diff --git a/partials/account/_danger-zone.php b/partials/account/_danger-zone.php index b46f3fd3..9de799e4 100644 --- a/partials/account/_danger-zone.php +++ b/partials/account/_danger-zone.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 * * @internal $args['user'] Current user. * @internal $args['is_admin'] True if the user is an administrator. diff --git a/partials/account/_data.php b/partials/account/_data.php index 1f3772ff..c5bb7bc1 100644 --- a/partials/account/_data.php +++ b/partials/account/_data.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 * * @internal $args['user'] Current user. * @internal $args['is_admin'] True if the user is an administrator. diff --git a/partials/account/_discussions.php b/partials/account/_discussions.php index 604e2e54..fe5a3bd9 100644 --- a/partials/account/_discussions.php +++ b/partials/account/_discussions.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 * * @internal $args['user'] Current user. * @internal $args['is_admin'] True if the user is an administrator. diff --git a/partials/account/_oauth.php b/partials/account/_oauth.php index 2b183790..f793fb91 100644 --- a/partials/account/_oauth.php +++ b/partials/account/_oauth.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 * * @internal $args['user'] Current user. * @internal $args['is_admin'] True if the user is an administrator. diff --git a/partials/account/_profile.php b/partials/account/_profile.php index b140db04..52794399 100644 --- a/partials/account/_profile.php +++ b/partials/account/_profile.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 * * @internal $args['user'] Current user. * @internal $args['is_admin'] True if the user is an administrator. diff --git a/repo/graveyard/discarded.php b/repo/graveyard/discarded.php index 3a16b99d..f123b122 100644 --- a/repo/graveyard/discarded.php +++ b/repo/graveyard/discarded.php @@ -15,7 +15,7 @@ * * DISABLED! * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $profile_user The profile user object. Not necessarily the one * currently editing the profile! @@ -49,7 +49,7 @@ function fictioneer_admin_profile_patreon_tiers( $profile_user ) { * * DISABLED! * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User $profile_user The profile user object. Not necessarily the one * currently editing the profile! @@ -79,7 +79,7 @@ function fictioneer_admin_profile_bookmarks( $profile_user ) { * Prevent moderators from editing the comment content, which is rarely a good action. * Doing this via JS is a terrible solution but better than nothing. * - * @since Fictioneer 5.0 + * @since 5.0.0 * @todo Do this server-side to prevent savvy moderators from circumventing it. */ @@ -108,7 +108,7 @@ function fictioneer_disable_moderator_comment_edit() { * Expected Parameters: * - post_id (required): The ID of the story post. * - * @since Fictioneer 5.6.3 + * @since 5.6.3 */ function fictioneer_register_endpoint_get_comment_form() { @@ -139,8 +139,8 @@ if ( get_option( 'fictioneer_enable_ajax_comment_form' ) ) { /** * Sends the comment form HTML * - * @since Fictioneer 5.0 - * @since Fictioneer 5.6.3 Refactored for REST API. + * @since 5.0.0 + * @since 5.6.3 Refactored for REST API. * * @param WP_REST_Request $WP_REST_Request Request object. * @@ -185,7 +185,7 @@ function fictioneer_rest_get_comment_form( WP_REST_Request $request ) { * Expected Parameters: * - post_id (required): The ID of the story post. * - * @since Fictioneer 5.6.3 + * @since 5.6.3 */ function fictioneer_register_endpoint_get_comment_section() { @@ -230,8 +230,8 @@ if ( get_option( 'fictioneer_enable_ajax_comments' ) ) { /** * Sends the comment section HTML * - * @since Fictioneer 5.0 - * @since Fictioneer 5.6.3 Refactored for REST API. + * @since 5.0.0 + * @since 5.6.3 Refactored for REST API. * * @param WP_REST_Request $WP_REST_Request Request object. * @@ -452,7 +452,7 @@ function validate_tags($content) { /** * Sends the user's Checkmarks as JSON via Ajax * - * @since Fictioneer 4.0 + * @since 4.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_get_validated_ajax_user() @@ -486,7 +486,7 @@ if ( get_option( 'fictioneer_enable_checkmarks' ) ) { /** * Sends the user's Reminders as JSON via Ajax * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_get_validated_ajax_user() @@ -520,7 +520,7 @@ if ( get_option( 'fictioneer_enable_reminders' ) ) { /** * Sends the user's Follows as JSON via Ajax * - * @since Fictioneer 4.3 + * @since 4.3.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_get_validated_ajax_user() @@ -569,7 +569,7 @@ if ( get_option( 'fictioneer_enable_follows' ) ) { /** * Sends the user's fingerprint via AJAX * - * @since Fictioneer 5.0 + * @since 5.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_get_validated_ajax_user() @@ -595,7 +595,7 @@ add_action( 'wp_ajax_fictioneer_ajax_get_fingerprint', 'fictioneer_ajax_get_fing /** * Get an user's bookmarks via AJAX * - * @since Fictioneer 4.0 + * @since 4.0.0 * @link https://developer.wordpress.org/reference/functions/wp_send_json_success/ * @link https://developer.wordpress.org/reference/functions/wp_send_json_error/ * @see fictioneer_get_validated_ajax_user() @@ -639,7 +639,7 @@ if ( ! function_exists( 'fictioneer_has_role' ) ) { /** * Checks if an user has a specific role * - * @since Fictioneer 5.0 + * @since 5.0.0 * * @param WP_User|int $user The user object or ID to check. * @param string $role The role to check for. @@ -673,7 +673,7 @@ if ( ! function_exists( 'fictioneer_has_role' ) ) { /** * When a fictioneer option is updated as empty, the option is deleted * - * @since Fictioneer 5.7.5 + * @since 5.7.5 * * @param string $option The option name. * @param mixed $old_value The previous value. diff --git a/rss-rss-main.php b/rss-rss-main.php index 844c21ee..2b28725a 100644 --- a/rss-rss-main.php +++ b/rss-rss-main.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.7 + * @since 4.7.0 * @link https://github.com/WordPress/WordPress/blob/master/wp-includes/feed-rss2.php */ diff --git a/rss-rss-story.php b/rss-rss-story.php index c2700526..3c9c42b2 100644 --- a/rss-rss-story.php +++ b/rss-rss-story.php @@ -9,7 +9,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.7 + * @since 4.7.0 * @link https://github.com/WordPress/WordPress/blob/master/wp-includes/feed-rss2.php */ diff --git a/search.php b/search.php index 4f831060..87449275 100644 --- a/search.php +++ b/search.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 */ ?> diff --git a/searchform.php b/searchform.php index 17f0c1dd..7e8c5cdf 100644 --- a/searchform.php +++ b/searchform.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 * * @internal $args['simple'] Optional. Hide advanced options. * @internal $args['placeholder'] Optional. Change search placeholder. diff --git a/single-fcn_collection.php b/single-fcn_collection.php index fe0be94a..ef1a0fcf 100644 --- a/single-fcn_collection.php +++ b/single-fcn_collection.php @@ -9,7 +9,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * @see partials/_collection-header.php * @see partials/_collection-statistics.php */ diff --git a/single-fcn_recommendation.php b/single-fcn_recommendation.php index a66ace5d..b68140e4 100644 --- a/single-fcn_recommendation.php +++ b/single-fcn_recommendation.php @@ -6,7 +6,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * @see partials/_recommendation-header.php */ ?> diff --git a/singular-bookmarks.php b/singular-bookmarks.php index ad072a42..92bcbd7f 100644 --- a/singular-bookmarks.php +++ b/singular-bookmarks.php @@ -9,7 +9,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.6 + * @since 4.6.0 */ ?> diff --git a/singular-bookshelf-ajax.php b/singular-bookshelf-ajax.php index dd46097b..5a506339 100644 --- a/singular-bookshelf-ajax.php +++ b/singular-bookshelf-ajax.php @@ -8,7 +8,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 */ ?> diff --git a/singular-bookshelf.php b/singular-bookshelf.php index 602e8dda..809475bc 100644 --- a/singular-bookshelf.php +++ b/singular-bookshelf.php @@ -8,7 +8,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 */ ?> diff --git a/singular-taxonomies.php b/singular-taxonomies.php index ffcbbc78..e9de13d4 100644 --- a/singular-taxonomies.php +++ b/singular-taxonomies.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 5.0 + * @since 5.0.0 */ ?> diff --git a/src/js/admin.js b/src/js/admin.js index 33b2f53a..dc0ebedd 100644 --- a/src/js/admin.js +++ b/src/js/admin.js @@ -154,7 +154,7 @@ _$$('[data-dialog-target="schema-dialog"]').forEach(element => { /** * Deletes an ePUB by filename. * - * @since 4.7 + * @since 4.7.0 * @param {String} name - Name of the ePUB. */ @@ -194,7 +194,7 @@ _$$('[data-action="delete-epub"]').forEach(element => { /** * Add attachment via WordPress media uploader. * - * @since 4.0 + * @since 4.0.0 * @link https://codex.wordpress.org/Javascript_Reference/wp.media * @link https://stackoverflow.com/a/28549014/17140970 * @@ -227,7 +227,7 @@ if (button = _$$$('fictioneer-button-og-upload')) { /** * Update SEO metabox with character count of title * - * @since 4.0 + * @since 4.0.0 */ function fcn_update_seo_title_chars() { @@ -245,7 +245,7 @@ if (button = _$$$('fictioneer-seo-title')) { /** * Remove OG image * - * @since 4.0 + * @since 4.0.0 * * @param {Event} event - The event. */ @@ -275,7 +275,7 @@ if (button = _$$$('fictioneer-button-seo-og-image-remove')) { * The element needs to have the data attributes 'data-dialog-message' * and 'data-dialog-confirm'. * - * @since 5.0 + * @since 5.0.0 * * @param {Event} event - The event. */ diff --git a/src/js/ajax-bookshelf.js b/src/js/ajax-bookshelf.js index 7f7ccec3..609f6bb0 100644 --- a/src/js/ajax-bookshelf.js +++ b/src/js/ajax-bookshelf.js @@ -20,7 +20,7 @@ if (fcn_theRoot.dataset.ajaxAuth) { /** * Get bookshelf content from web storage or create new JSON. * - * @since 4.3 + * @since 4.3.0 * @see fcn_parseJSON() */ diff --git a/src/js/ajax-comments.js b/src/js/ajax-comments.js index d87bb4de..57ed552b 100644 --- a/src/js/ajax-comments.js +++ b/src/js/ajax-comments.js @@ -17,7 +17,7 @@ const /** @const {HTMLElement} */ fcn_commentSection = _$$$('comments'); /** * Load comment section via AJAX. * - * @since 5.0 + * @since 5.0.0 * @param {Number=} post_id - The current post ID. * @param {Number=} page - The requested page number. */ @@ -167,7 +167,7 @@ function fcn_getCommentSection(post_id = null, page = null, scroll = false) { * Wrapper to reload the comments section with only the page number * as parameter and scroll set to true. * - * @since 5.0 + * @since 5.0.0 * @param {Number=} page - The requested page number. */ @@ -203,7 +203,7 @@ if (fcn_theRoot.dataset.ajaxAuth) { /** * Helper to set up comment section observer. * - * @since 5.0 + * @since 5.0.0 */ function fcn_setupCommentSectionObserver() { @@ -239,7 +239,7 @@ if (fcn_theRoot.dataset.ajaxAuth) { /** * Load comment section early if there is a comment* anchor. * - * @since 5.0 + * @since 5.0.0 */ function fcn_loadCommentEarly() { diff --git a/src/js/application.js b/src/js/application.js index 617c9edb..1b2e315e 100644 --- a/src/js/application.js +++ b/src/js/application.js @@ -48,7 +48,7 @@ if (typeof fcn_removeQueryArgs === 'function') { /** * Clean-up web storage. * - * @since 4.5 + * @since 4.5.0 * @param {Boolean} keepGuestData - Whether to keep data that does not need the * user to be logged in. */ @@ -112,7 +112,7 @@ _$$('.subscriber-login, .oauth-login-link, [data-prepare-login]').forEach(elemen /** * Cleanup view for non-authenticated guests. * - * @since 5.0 + * @since 5.0.0 */ function fcn_cleanupGuestView() { @@ -140,7 +140,7 @@ document.addEventListener('DOMContentLoaded', () => { /** * Authenticate user via AJAX or from web storage * - * @since 5.0 + * @since 5.0.0 */ function fcn_ajaxAuth() { @@ -243,7 +243,7 @@ function fcn_ajaxAuth() { /** * Append hidden input element with nonce to DOM. * - * @since 5.0 + * @since 5.0.0 * @param {String} nonceHtml - HTML for the hidden input with nonce value. */ @@ -274,7 +274,7 @@ if (!fcn_isLoggedIn && fcn_theRoot.dataset.ajaxAuth) { /** * Manually set logged-in state and call setup functions. * - * @since 5.0 + * @since 5.0.0 * @param {Object} state - Fetched/Cached login state. */ @@ -325,7 +325,7 @@ fcn_bindEventToAnimationFrame('resize', 'resize.rAF'); /** * Update viewport variables. * - * @since 4.0 + * @since 4.0.0 */ function fcn_updateViewportVariables() { @@ -469,7 +469,7 @@ fcn_theBody.addEventListener('click', e => { /** * Load embedded content by setting the src attribute. * - * @since 4.0 + * @since 4.0.0 * @param {Event} e - The event. */ @@ -500,7 +500,7 @@ var /** @const {Number} */ fcn_lastScrollTop = 0; * insignificant movements, the scroll direction class will be updated depending * on the difference. Updates the stored value afterwards for the next time. * - * @since 4.0 + * @since 4.0.0 * @since 5.8.1 - Also checks whether the page is scrolled to the top. */ @@ -579,7 +579,7 @@ document.addEventListener('DOMContentLoaded', () => { /** * Makes an element mouse draggable. * - * @since 4.0 + * @since 4.0.0 */ function fcn_dragElement(element) { @@ -627,7 +627,7 @@ _$$('.modal__header.drag-anchor').forEach(element => { /** * Show notification that will vanish after a while. * - * @since 4.0 + * @since 4.0.0 * @param {String} message - The message to display. * @param {Number} [duration=] - Seconds the message will be visible. Default 3. * @param {String} [type=] - Type of the message. Default 'base'. @@ -732,7 +732,7 @@ var /** @const {OBJECT} */ fcn_siteSettings = fcn_getSiteSettings(); /** * Toggle a single site setting. * - * @since 4.0 + * @since 4.0.0 * @see fcn_applySiteSettings(); * @param {HTMLElement} target - The clicked toggle. * @param {String} key - The setting to set. @@ -763,7 +763,7 @@ fcn_settingEvents.forEach(setting => { * back to the default set in the HTML root. Flips the state and then updates the * view and local storage via fcn_setLightMode(). * - * @since 4.3 + * @since 4.3.0 * @see fcn_setLightMode(); */ @@ -779,7 +779,7 @@ function fcn_toggleLightMode() { /** * Set the light mode state. * - * @since 4.3 + * @since 4.3.0 * @see fcn_updateThemeColor(); * @param {Boolean} boolean - Set light mode to true or false. * @param {Boolean} [silent=false] - Optional. Whether to not update the theme color meta tag. @@ -826,7 +826,7 @@ _$$('.toggle-light-mode').forEach(element => { /** * Update font weight setting. * - * @since 4.0 + * @since 4.0.0 */ function fcn_updateFontWeight() { @@ -847,7 +847,7 @@ function fcn_updateFontWeight() { /** * Reset font weight setting to default. * - * @since 4.3 + * @since 4.3.0 */ function fcn_resetFontWeight() { @@ -878,7 +878,7 @@ _$$('.site-setting-font-weight').forEach(setting => { /** * Update hue rotate setting. * - * @since 4.3 + * @since 4.3.0 */ function fcn_updateHueRotate(value) { @@ -904,7 +904,7 @@ function fcn_updateHueRotate(value) { /** * Helper to call fcn_updateHueRotate() with input value. * - * @since 4.0 + * @since 4.0.0 */ function fcn_setHueRotate() { @@ -927,7 +927,7 @@ fcn_settingHueRotateText?.addEventListener('input', fcn_setHueRotate); /** * Update darken setting. * - * @since 4.0 + * @since 4.0.0 */ function fcn_updateDarken(value = null) { @@ -957,7 +957,7 @@ function fcn_updateDarken(value = null) { /** * Helper to call fcn_updateDarken() with range input value. * - * @since 4.0 + * @since 4.0.0 */ function fcn_setDarkenFromRange() { @@ -967,7 +967,7 @@ function fcn_setDarkenFromRange() { /** * Helper to call fcn_updateDarken() with text input value. * - * @since 4.0 + * @since 4.0.0 */ function fcn_setDarkenFromText() { @@ -1000,7 +1000,7 @@ fcn_settingDarkenTexts.forEach(element => { /** * Update saturation setting. * - * @since 4.3 + * @since 4.3.0 */ function fcn_updateSaturation(value = null) { @@ -1029,7 +1029,7 @@ function fcn_updateSaturation(value = null) { /** * Helper to call fcn_updateSaturation() with range input value. * - * @since 4.0 + * @since 4.0.0 */ function fcn_setSaturationFromRange() { @@ -1039,7 +1039,7 @@ function fcn_setSaturationFromRange() { /** * Helper to call fcn_updateSaturation() with text input value. * - * @since 4.0 + * @since 4.0.0 */ function fcn_setSaturationFromText() { @@ -1073,7 +1073,7 @@ fcn_settingSaturationTexts.forEach(element => { /** * Returns default site settings. * - * @since 4.0 + * @since 4.0.0 * @return {Object} The site settings. */ @@ -1098,7 +1098,7 @@ function fcn_defaultSiteSettings() { /** * Get site settings JSON from web storage or create new one. * - * @since 4.0 + * @since 4.0.0 * @see fcn_parseJSON() * @see fcn_defaultSiteSettings() * @return {Object} The site settings. @@ -1117,7 +1117,7 @@ function fcn_getSiteSettings() { /** * Set the site settings object and save to local storage. * - * @since 4.0 + * @since 4.0.0 * @param {Object=} value - The site settings. */ @@ -1140,7 +1140,7 @@ function fcn_setSiteSettings(value = null) { /** * Apply site settings to the site. * - * @since 4.0 + * @since 4.0.0 * @param {Object} value - The site settings. */ @@ -1331,7 +1331,7 @@ _$$('.chapter-group__name').forEach(element => { /** * Toggle visibility of a spoiler. * - * @since 4.0 + * @since 4.0.0 * @param {HTMLElement} target - The spoiler. */ @@ -1346,7 +1346,7 @@ function fct_spoiler(target) { /** * Reveal image on click. * - * @since 5.0 + * @since 5.0.0 * @param {HTMLElement} button - The clicked reveal button. */ @@ -1369,7 +1369,7 @@ _$('.fictioneer-comments')?.addEventListener('click', event => { /** * Submit contact form via AJAX. * - * @since 5.0 + * @since 5.0.0 * @param {HTMLElement} button - The submit button in the form. */ diff --git a/src/js/bookmarks.js b/src/js/bookmarks.js index 2854498d..301e1928 100644 --- a/src/js/bookmarks.js +++ b/src/js/bookmarks.js @@ -29,7 +29,7 @@ document.addEventListener('fcnUserDataReady', event => { * @description Looks for bookmarks in local storage, both for guests and logged-in * users. If none are found, an empty bookmarks JSON is created and set. * - * @since 4.0 + * @since 4.0.0 */ function fcn_initializeLocalBookmarks() { @@ -174,7 +174,7 @@ function fcn_fixBookmarksNode(node) { * requests. Since the bookmarks are always saved as complete collection, yet * unfinished requests can be cancelled without loss of data. * - * @since 4.0 + * @since 4.0.0 * @see fcn_saveUserBookmarks() * @param {Object} value - The bookmarks JSON to be set. * @param {Boolean} [silent=false] - Whether or not to update the database. @@ -260,7 +260,7 @@ function fcn_updateBookmarksView() { * happen once every n seconds, as set by the timeout interval, to avoid further * unnecessary requests in case someone triggers multiple updates. * - * @since 4.0 + * @since 4.0.0 * @param {JSON} bookmarks - The bookmarks JSON to be saved. */ @@ -308,7 +308,7 @@ function fcn_saveUserBookmarks(bookmarks) { * the bookmarks JSON or removing them. Updates any available buttons, lists, * and calls to persist the updated JSON. * - * @since 4.0 + * @since 4.0.0 * @see fcn_getBookmarks() * @see fcn_removeBookmark() * @see fcn_offset() @@ -404,7 +404,7 @@ function fcn_toggleBookmark(id, color = 'none') { * 'current-bookmark' class is added to the bookmarked paragraph to show * the colored bookmark line and the jump buttons are revealed. * - * @since 4.0 + * @since 4.0.0 */ function fcn_showChapterBookmark() { @@ -451,7 +451,7 @@ function fcn_showChapterBookmark() { * mobile menu (usually when a new bookmark is added or the menu panel opened for * the first time per page load). * - * @since 4.0 + * @since 4.0.0 * @see fcn_bookmarkDeleteHandler() */ @@ -504,7 +504,7 @@ function fcn_setMobileMenuBookmarks() { * (via shortcode), bookmarks are rendered as cards up to the count specified * in the block as data-attribute (or all for -1). * - * @since 4.0 + * @since 4.0.0 * @see fcn_bookmarkDeleteHandler() */ @@ -577,7 +577,7 @@ function fcn_showBookmarkCards() { /** * Register event handler for bookmark delete button(s). * - * @since 4.0 + * @since 4.0.0 * @see fcn_removeBookmark() * @see fcn_setBookmarks() * @param {HTMLElement|HTMLElement[]} targets - One or more delete buttons. @@ -608,7 +608,7 @@ function fcn_bookmarkDeleteHandler(targets) { /** * Remove bookmark from JSON and view. * - * @since 4.0 + * @since 4.0.0 * @param {Number} id - ID of the bookmark (chapter ID). */ diff --git a/src/js/chapter.js b/src/js/chapter.js index deb45026..dd326157 100644 --- a/src/js/chapter.js +++ b/src/js/chapter.js @@ -250,7 +250,7 @@ if (fcn_paragraphTools) { /** * Enter fullscreen mode. * - * @since 4.2 + * @since 4.2.0 */ function fcn_openFullscreen() { @@ -279,7 +279,7 @@ _$$('.open-fullscreen').forEach(element => { /** * Close fullscreen mode. * - * @since 4.2 + * @since 4.2.0 */ function fcn_closeFullscreen() { @@ -308,7 +308,7 @@ _$$('.close-fullscreen').forEach(element => { /** * Get formatting JSON from local storage or create new one. * - * @since 4.0 + * @since 4.0.0 * @see fcn_parseJSON() * @see fcn_defaultFormatting() * @see fcn_setFormatting(); @@ -339,7 +339,7 @@ function fcn_getFormatting() { /** * Returns default formatting. * - * @since 4.0 + * @since 4.0.0 * @return {Object} The formatting settings. */ @@ -370,7 +370,7 @@ function fcn_defaultFormatting() { /** * Set the formatting settings object and save to local storage. * - * @since 4.0 + * @since 4.0.0 * @param {Object} value - The formatting settings. */ @@ -398,7 +398,7 @@ const /** @const {HTMLInputElement} */ fcn_fontSizeText = _$$$('reader-settings- /** * Update font size formatting on chapters. * - * @since 4.0 + * @since 4.0.0 * @see fcn_clamp(); * @see fcn_setFormatting(); * @param {Number} value - Integer between 50 and 200. @@ -430,7 +430,7 @@ function fcn_updateFontSize(value, save = true) { /** * Helper to call fcn_setFontSize() with input value. * - * @since 4.0 + * @since 4.0.0 */ function fcn_setFontSize() { @@ -440,7 +440,7 @@ function fcn_setFontSize() { /** * Helper to call fcn_setFontSize() with incremental/decremental value. * - * @since 4.0 + * @since 4.0.0 */ function fcn_modifyFontSize() { @@ -478,7 +478,7 @@ const /** @const {HTMLElement} */ fcn_fontColorReset = _$$$('reader-settings-fon /** * Update font color on chapters. * - * @since 4.0 + * @since 4.0.0 * @see fcn_setFormatting(); * @param {String} index - Index of the CSS color value to set. * @param {Boolean} [save=true] - Optional. Whether to save the change. @@ -506,7 +506,7 @@ function fcn_updateFontColor(index, save = true) { /** * Helper to call fcn_setFontColor() with color code and name. * - * @since 4.0 + * @since 4.0.0 * @param {Number} [step=1] - Index modifier to move inside the font color array. */ @@ -542,7 +542,7 @@ const /** @const {HTMLElement} */ fcn_fontFamilyReset = _$$$('reader-settings-fo /** * Update font family on chapters. * - * @since 4.0 + * @since 4.0.0 * @see fcn_setFormatting(); * @param {String} index - Index of the font. * @param {Boolean} [save=true] - Optional. Whether to save the change. @@ -586,7 +586,7 @@ function fcn_updateFontFamily(index, save = true) { /** * Helper to call fcn_setFontFamily() with font name. * - * @since 4.0 + * @since 4.0.0 * @param {Number} [step=1] - Index modifier to move inside the font array. */ @@ -623,7 +623,7 @@ const /** @const {HTMLInputElement} */ fcn_fontSaturationText = _$$$('reader-set /** * Update font saturation formatting on chapters. * - * @since 4.0 + * @since 4.0.0 * @see fcn_clamp(); * @see fcn_setFormatting(); * @param {Number} value - Float between -1 and 1. @@ -656,7 +656,7 @@ function fcn_updateFontSaturation(value, save = true) { /** * Helper to call fcn_updateFontSaturation() with range input value. * - * @since 4.0 + * @since 4.0.0 */ function fcn_setFontSaturationFromRange() { @@ -666,7 +666,7 @@ function fcn_setFontSaturationFromRange() { /** * Helper to call fcn_updateFontSaturation() with text input value. * - * @since 4.0 + * @since 4.0.0 */ function fcn_setFontSaturationFromText() { @@ -696,7 +696,7 @@ const /** @const {HTMLInputElement} */ fcn_letterSpacingText = _$$$('reader-sett /** * Update letter-spacing formatting on chapters. * - * @since 4.0 + * @since 4.0.0 * @see fcn_clamp(); * @see fcn_setFormatting(); * @param {Number} value - Float between -0.1 and 0.2. @@ -726,7 +726,7 @@ function fcn_updateLetterSpacing(value, save = true) { /** * Helper to call fcn_updateLetterSpacing() with input value. * - * @since 4.0 + * @since 4.0.0 */ function fcn_setLetterSpacing() { @@ -756,7 +756,7 @@ const /** @const {HTMLInputElement} */ fcn_paragraphSpacingText = _$$$('reader-s /** * Update paragraph spacing formatting on chapters. * - * @since 4.0 + * @since 4.0.0 * @see fcn_clamp(); * @see fcn_setFormatting(); * @param {Number} value - Float between 0 and 3. @@ -786,7 +786,7 @@ function fcn_updateParagraphSpacing(value, save = true) { /** * Helper to call fcn_setParagraphSpacing() with input value. * - * @since 4.0 + * @since 4.0.0 */ function fcn_setParagraphSpacing() { @@ -816,7 +816,7 @@ const /** @const {HTMLInputElement} */ fcn_lineHeightText = _$$$('reader-setting /** * Update line height formatting on chapters. * - * @since 4.0 + * @since 4.0.0 * @see fcn_clamp(); * @see fcn_setFormatting(); * @param {Number} value - Float between 0.8 and 3. @@ -846,7 +846,7 @@ function fcn_updateLineHeight(value, save = true) { /** * Helper to call fcn_setLineHeight() with input value. * - * @since 4.0 + * @since 4.0.0 */ function fcn_setLineHeight() { @@ -879,7 +879,7 @@ const /** @const {HTMLInputElement} */ fcn_siteWidthText = _$$$('reader-settings * @description Only affects the width of the main container since 5.0.10 * to avoid potential layout issues. * - * @since 4.0 + * @since 4.0.0 * @see fcn_clamp(); * @see fcn_setFormatting(); * @param {Number} value - Float between 640 and 1920. @@ -918,7 +918,7 @@ function fcn_updateSiteWidth(value, save = true) { /** * Helper to call fcn_updateSiteWidth() with input value. * - * @since 4.0 + * @since 4.0.0 */ function fcn_setSiteWidth() { @@ -944,7 +944,7 @@ fcn_updateSiteWidth(fcn_formatting['site-width'], false); /** * Update indent formatting on chapters. * - * @since 4.0 + * @since 4.0.0 * @see fcn_evaluateAsBoolean(); * @see fcn_setFormatting(); * @param {Any} value - The value that will be evaluated as boolean. @@ -988,7 +988,7 @@ fcn_updateIndent(fcn_formatting['indent'], false); /** * Update justify formatting on chapters. * - * @since 4.0 + * @since 4.0.0 * @see fcn_evaluateAsBoolean(); * @see fcn_setFormatting(); * @param {Any} value - The value that will be evaluated as boolean. @@ -1032,7 +1032,7 @@ fcn_updateJustify(fcn_formatting['justify'], false); /** * Enable or disable paragraph tools on chapters. * - * @since 4.0 + * @since 4.0.0 * @see fcn_evaluateAsBoolean(); * @see fcn_setFormatting(); * @param {Any} value - The value that will be evaluated as boolean. @@ -1073,7 +1073,7 @@ fcn_updateParagraphTools(fcn_formatting['show-paragraph-tools'], false); /** * Show or hide marked sensitive content on chapters. * - * @since 4.0 + * @since 4.0.0 * @see fcn_evaluateAsBoolean(); * @see fcn_setFormatting(); * @param {Any} value - The value that will be evaluated as boolean. @@ -1124,7 +1124,7 @@ fcn_updateSensitiveContent(fcn_formatting['show-sensitive-content'], false); /** * Show or hide chapter foreword, afterword, and warning. * - * @since 4.0 + * @since 4.0.0 * @see fcn_evaluateAsBoolean(); * @see fcn_setFormatting(); * @param {Any} value - The value that will be evaluated as boolean. @@ -1214,7 +1214,7 @@ if (_$('article:not(._password)')) { * Checks whether this is a chapter, then adds a throttled event listener to a * custom scroll event that is tied to request animation frame. * - * @since 4.0 + * @since 4.0.0 * @see fcn_readingProgress() * @see fcn_bindEventToAnimationFrame() */ @@ -1233,7 +1233,7 @@ function fcn_trackProgress() { * chapter and visualizes that information as filling bar at the top. If the end * of the chapter is reached, the chapter is marked as read for logged-in users. * - * @since 4.0 + * @since 4.0.0 * @see fcn_toggleCheckmark() * @see fcn_clamp() */ diff --git a/src/js/checkmarks.js b/src/js/checkmarks.js index 729f841b..af4e7cc9 100644 --- a/src/js/checkmarks.js +++ b/src/js/checkmarks.js @@ -17,7 +17,7 @@ document.addEventListener('fcnUserDataReady', event => { /** * Initialize checkmarks. * - * @since 5.0 + * @since 5.0.0 * @param {Event} event - The fcnUserDataReady event. */ @@ -62,7 +62,7 @@ function fcn_initializeCheckmarks(event) { /** * Toggle checkmarks for chapters and stories. * - * @since 4.0 + * @since 4.0.0 * @see fcn_removeItemOnce() * @see fcn_updateCheckmarksView() * @param {Number} storyId - ID of the story. @@ -190,7 +190,7 @@ function fcn_toggleCheckmark(storyId, type, chapter = null, source = null, mode /** * Evaluate click on a checkmark. * - * @since 4.0 + * @since 4.0.0 * @see fcn_toggleCheckmark() * @param {HTMLElement} source - Source of the event. */ @@ -246,7 +246,7 @@ function fcn_updateCheckmarks(storyId, checkmarks = null) { /** * Update the view with the current checkmarks state. * - * @since 4.0 + * @since 4.0.0 */ function fcn_updateCheckmarksView() { diff --git a/src/js/comments.js b/src/js/comments.js index 4644d54b..019b48c0 100644 --- a/src/js/comments.js +++ b/src/js/comments.js @@ -20,7 +20,7 @@ document.addEventListener('fcnUserDataReady', () => { * show and could be used better. A hashcash for example, to make spamming * really expensive! * - * @since 5.0 + * @since 5.0.0 */ function fcn_addJSTrap() { @@ -49,7 +49,7 @@ fcn_addJSTrap(); * by the operation string. Applies a successful result directly to the DOM * without reloading the page. * - * @since 4.7 + * @since 4.7.0 * @param {Number} id - ID of the comment to be moderated. * @param {String} operation - The moderation action to perform. Choose between * 'Sticky', 'Unsticky', 'Approve', 'Unapprove', 'Open', 'Close', 'Trash', or 'Spam'. @@ -146,7 +146,7 @@ function fcn_moderateComment(id, operation) { /** * Listen to clicks on moderation action. * - * @since 4.7 + * @since 4.7.0 */ function fcn_addModerationEvents() { @@ -168,7 +168,7 @@ fcn_addModerationEvents(); /** * Listen to mouseleave to close the moderation menu. * - * @since 4.7 + * @since 4.7.0 */ function fcn_addCommentMouseleaveEvents() { @@ -196,7 +196,7 @@ fcn_addCommentMouseleaveEvents(); /** * Report a comment via AJAX. * - * @since 4.7 + * @since 4.7.0 * @param {Number} id - ID of the comment to be moderated. */ @@ -273,7 +273,7 @@ function fcn_revealCommentFormInputs(area) { /** * Listen for events on comment form. * - * @since 4.7 + * @since 4.7.0 */ function fcn_addCommentFormEvents() { @@ -291,7 +291,7 @@ fcn_addCommentFormEvents(); /** * Adjust textarea height to fit the value without vertical scroll bar. * - * @since 4.7 + * @since 4.7.0 * @param {HTMLElement} area - The textarea element to adjust. */ @@ -303,7 +303,7 @@ function fcn_textareaAdjust(area) { /** * Listen for input on adaptive textareas. * - * @since 4.7 + * @since 4.7.0 */ function fcn_addTextareaEvents() { @@ -322,7 +322,7 @@ fcn_addTextareaEvents(); /** * Listen for changes of the private toggle. * - * @since 5.0 + * @since 5.0.0 */ function fcn_addPrivateToggleEvents() { @@ -343,7 +343,7 @@ fcn_addPrivateToggleEvents(); /** * Wrap a text selection within an editable element in tags. * - * @since 4.7 + * @since 4.7.0 * @param {HTMLElement} element - The editable element with the selection. * @param {String} tag - The tag to be used. * @param {String[]=} options - Options defined as strings. @@ -408,7 +408,7 @@ _$('.comment-section')?.addEventListener('keydown', event => { /** * Bind AJAX request to comment form submit and override default behavior. * - * @since 5.0 + * @since 5.0.0 */ function fcn_bindAJAXCommentSubmit() { @@ -646,7 +646,7 @@ var /** @type {Object} */ fcn_commentEditUndos = {}; * event listeners is unreasonable. All that extra code, all the extra work for * the system, for something that you can get at no cost. Seriously. * - * @since 5.0 + * @since 5.0.0 * @param {HTMLElement} source - Event source. */ @@ -677,7 +677,7 @@ function fcn_triggerInlineCommentEdit(source) { /** * Submit inline comment edit via AJAX * - * @since 5.0 + * @since 5.0.0 * @param {HTMLElement} source - Event source. */ @@ -756,7 +756,7 @@ function fcn_submitInlineCommentEdit(source) { /** * Cancel inline comment edit. * - * @since 5.0 + * @since 5.0.0 * @param {HTMLElement} source - Event source. */ @@ -773,7 +773,7 @@ function fcn_cancelInlineCommentEdit(source) { /** * Restore comment to non-editing state. * - * @since 5.0 + * @since 5.0.0 * @param {HTMLElement} target - The comment to restore. */ @@ -797,7 +797,7 @@ function fcn_restoreComment(target, undo = false, update = null) { /** * Reveal edit buttons that match the user's fingerprint * - * @since 5.0 + * @since 5.0.0 */ function fcn_revealEditButton() { @@ -842,7 +842,7 @@ document.addEventListener('fcnUserDataReady', () => { /** * Reveal delete buttons that match the user's fingerprint * - * @since 5.0 + * @since 5.0.0 */ function fcn_revealDeleteButton() { @@ -871,7 +871,7 @@ document.addEventListener('fcnUserDataReady', () => { /** * Soft-delete comment on user request * - * @since 5.0 + * @since 5.0.0 * @param {HTMLElement} button - The clicked delete button. */ @@ -968,7 +968,7 @@ function fcn_setupCommentFormObserver() { /** * Load comment form via AJAX. * - * @since 5.0 + * @since 5.0.0 */ function fcn_getCommentForm() { diff --git a/src/js/follows.js b/src/js/follows.js index 4a75dd7d..db760deb 100644 --- a/src/js/follows.js +++ b/src/js/follows.js @@ -21,7 +21,7 @@ document.addEventListener('fcnUserDataReady', event => { /** * Initialize Follows. * - * @since 5.0 + * @since 5.0.0 * @param {Event} event - The fcnUserDataReady event. */ @@ -57,7 +57,7 @@ function fcn_initializeFollows(event) { * Adds or removes a story ID from the Follows JSON, then calls for an update of * the view to reflect the changes and makes a save request to the database. * - * @since 4.3 + * @since 4.3.0 * @see fcn_updateFollowsView() * @param {Number} storyId - The ID of the story. */ @@ -131,7 +131,7 @@ function fcn_toggleFollow(storyId) { /** * Updates the view with the current Follows state. * - * @since 4.3 + * @since 4.3.0 */ function fcn_updateFollowsView() { @@ -177,7 +177,7 @@ function fcn_updateFollowsView() { /** * Fetch and insert HTML for Follows list via AJAX. * - * @since 4.3 + * @since 4.3.0 */ function fcn_setupFollowsHTML() { @@ -229,7 +229,7 @@ function fcn_setupFollowsHTML() { /** * Mark all Follows as read via Ajax. * - * @since 4.3 + * @since 4.3.0 */ function fcn_markFollowsRead() { diff --git a/src/js/mobile-menu.js b/src/js/mobile-menu.js index 44f4e6b7..8776e392 100644 --- a/src/js/mobile-menu.js +++ b/src/js/mobile-menu.js @@ -55,7 +55,7 @@ function fcn_toggleSimpleMobileMenu(isOpened) { * well. So the scroll position needs to be corrected by remembering the * position before the transformation and setting it after. * - * @since 4.0 + * @since 4.0.0 * @param {boolean} isOpened - True or false. */ @@ -222,7 +222,7 @@ _$$('.mobile-menu__back-button').forEach(element => { /** * Appends a cloned chapter list to the mobile menu. * - * @since 4.0 + * @since 4.0.0 */ function fcn_appendChapterList() { diff --git a/src/js/reminders.js b/src/js/reminders.js index 140fda34..9fddfaa7 100644 --- a/src/js/reminders.js +++ b/src/js/reminders.js @@ -17,7 +17,7 @@ document.addEventListener('fcnUserDataReady', event => { /** * Initialize Reminders. * - * @since 5.0 + * @since 5.0.0 * @param {Event} event - The fcnUserDataReady event. */ @@ -53,7 +53,7 @@ function fcn_initializeReminders(event) { * Adds or removes a story ID from the Reminders JSON, then calls for an update * of the view to reflect the changes and makes a save request to the database. * - * @since 5.0 + * @since 5.0.0 * @see fcn_updateRemindersView() * @param {Number} storyId - The ID of the story. */ @@ -127,7 +127,7 @@ function fcn_toggleReminder(storyId) { /** * Updates the view with the current Reminders state. * - * @since 5.0 + * @since 5.0.0 */ function fcn_updateRemindersView() { diff --git a/src/js/story.js b/src/js/story.js index de1a08c8..48e0cf5a 100644 --- a/src/js/story.js +++ b/src/js/story.js @@ -182,7 +182,7 @@ _$$('.tabs__item').forEach(element => { /** * Fetch and insert the HTML for the next batch of comments on the story page. * - * @since 4.0 + * @since 4.0.0 */ function fcn_loadStoryComments() { diff --git a/src/js/user-profile.js b/src/js/user-profile.js index e0cf6e89..62cf920b 100644 --- a/src/js/user-profile.js +++ b/src/js/user-profile.js @@ -10,7 +10,7 @@ * per default). In case this function is called maliciously, the request is * validated server-side as well. * - * @since 4.5 + * @since 4.5.0 * @param {String} none - Nonce for the action. * @param {String} channel - The OAuth channel to delete. * @param {Number} id - The ID of the user. @@ -96,7 +96,7 @@ _$$('.button-unset-oauth').forEach(element => { * In case this function is called maliciously, the request is validated * server-side as well. * - * @since 4.5 + * @since 4.5.0 * @param {HTMLElement} button - The clicked button. */ @@ -163,7 +163,7 @@ const /** @const {DOMStringMap} */ fcn_profileDataTranslations = _$$$('profile-d /** * Prompt with string submission before deletion of user data. * - * @since 5.0 + * @since 5.0.0 * @param {HTMLElement} button - The clicked button. * @return {Boolean} True or false. */ @@ -187,7 +187,7 @@ function fcn_dataDeletionPrompt(button) { /** * AJAX request to clear specific data. * - * @since 4.5 + * @since 4.5.0 * @param {HTMLElement} button - The clicked button. * @param {String} action - The action to perform. */ diff --git a/src/js/user.js b/src/js/user.js index 20f5022c..399fea2d 100644 --- a/src/js/user.js +++ b/src/js/user.js @@ -5,7 +5,7 @@ /** * Append image with avatar to target element. * - * @since 4.0 + * @since 4.0.0 */ function fcn_replaceProfileImage(target, avatar) { @@ -30,7 +30,7 @@ function fcn_replaceProfileImage(target, avatar) { /** * Save avatar image in local storage and add it to the document. * - * @since 4.0 + * @since 4.0.0 * @see fcn_isValidUrl(url) * @see fcn_replaceProfileImage(element, avatar) * @@ -63,7 +63,7 @@ function fcn_setProfileImage(avatar, save = true) { /** * Get avatar from local storage or pull it from the server. * - * @since 4.0 + * @since 4.0.0 * @see fcn_isValidUrl(url) * @see fcn_setProfileImage(avatar) * @see fcn_getUserAvatar() @@ -96,7 +96,7 @@ function fcn_getProfileImage() { /** * Fetch avatar from server via AJAX. * - * @since 4.0 + * @since 4.0.0 * @see fcn_setProfileImage(avatar) */ diff --git a/src/js/utility.js b/src/js/utility.js index 883a3135..d0c35e82 100644 --- a/src/js/utility.js +++ b/src/js/utility.js @@ -5,7 +5,7 @@ /** * Query one (first) element by selector. * - * @since 4.0 + * @since 4.0.0 * @alias document.querySelector * @type {function} * @const @@ -18,7 +18,7 @@ const _$ = document.querySelector.bind(document); /** * Query all elements by selector. * - * @since 4.0 + * @since 4.0.0 * @alias document.querySelectorAll * @type {function} * @const @@ -31,7 +31,7 @@ const _$$ = document.querySelectorAll.bind(document); /** * Get an element by ID. * - * @since 4.0 + * @since 4.0.0 * @alias document.getElementById * @type {function} * @const @@ -48,7 +48,7 @@ const _$$$ = document.getElementById.bind(document); /** * Make a POST request with the Fetch API * - * @since 5.0 + * @since 5.0.0 * @param {Object} data - The payload, including the action and nonce. * @param {String} url - Optional. The request URL if different from the default. * @param {Object} headers - Optional. Headers for the request. @@ -96,7 +96,7 @@ async function fcn_ajaxPost(data = {}, url = null, headers = {}) { /** * Make a GET request with the Fetch API. * - * @since 5.0 + * @since 5.0.0 * @param {Object} data - The payload, including the action and nonce. * @param {String} url - Optional. The request URL if different from the default. * @param {Object} headers - Optional. Headers for the request. @@ -146,7 +146,7 @@ async function fcn_ajaxGet(data = {}, url = null, headers = {}) { /** * Evaluate anything as boolean with a fallback value. * - * @since 5.0 + * @since 5.0.0 * @param {Any} candidate - The boolean hopeful to be evaluated. * @param {Boolean} fallback - Optional. The fallback boolean, default false. * @return {Boolean} True or false. @@ -200,7 +200,7 @@ function fcn_evaluateAsBoolean(candidate, fallback = false) { /** * Copy valid to clipboard and optionally show a notice. * - * @since 4.0 + * @since 4.0.0 * @param {String} text - The text to be copied. * @param {String} [message] - Optional notice to show. */ @@ -248,7 +248,7 @@ function fcn_parseJSON(str) { /** * Remove item from array once. * - * @since 4.0 + * @since 4.0.0 * @param {Any[]} array - The array from which to remove the item from. * @param {Any} value - The value of the item to remove. * @return {Any[]} The modified array. @@ -271,7 +271,7 @@ function fcn_removeItemOnce(array, value) { /** * Clamp a number between a minimum and a maximum. * - * @since 4.0 + * @since 4.0.0 * @param {Number} min - The minimum. * @param {Number} max - The maximum. * @param {Number} val - The value to clamp. @@ -288,7 +288,7 @@ function fcn_clamp(min, max, val) { /** * Update theme color meta tag. * - * @since 4.0 + * @since 4.0.0 * @param {String|Boolean} [color=false] - Optional color code. */ @@ -320,7 +320,7 @@ function fcn_updateThemeColor(color = false) { /** * Returns the top-left position of an element relative to the window. * - * @since 4.0 + * @since 4.0.0 * @param {HTMLElement} element - Element to get the position for. * @return {TopLeftPosition} Top-left position of the element. */ @@ -341,7 +341,7 @@ function fcn_offset(element) { /** * Throttle event for improved performance. * - * @since 4.1 + * @since 4.1.0 * @link https://github.com/jashkenas/underscore/blob/master/underscore.js * @link https://stackoverflow.com/a/27078401/17140970 * @param {Function} func - The function to throttle. @@ -410,7 +410,7 @@ var /** @const {Map} */ fcn_animFrameEvents = new Map(); /** * Bind event to animation frame for improved performance. * - * @since 4.1 + * @since 4.1.0 * @param {String} type - The event type, e.g. 'scroll' or 'resize'. * @param {String} name - Name of the bound event. * @param {HTMLElement} [obj=window] - Target of the event listener. @@ -442,7 +442,7 @@ var /** @const {HTMLElement} */ fcn_lastClicked; /** * Toggle the 'last-clicked' class on an element. * - * @since 4.0 + * @since 4.0.0 * @param {HTMLElement} element - The clicked element. */ @@ -516,7 +516,7 @@ _$('body').addEventListener( * needs to make sure to not accidentally remove content since, while not * common, the button labels may occur in the chapter text intentionally. * - * @since 4.0 + * @since 4.0.0 * @param {String} selection - The text selection to be cleaned. * @return {String} The cleaned text selection. */ @@ -543,7 +543,7 @@ function fcn_cleanTextSelectionFromButtons(selection) { /** * Delete a cookie. * - * @since 4.7 + * @since 4.7.0 * @param {String} cname - Name of the cookie to delete. */ @@ -555,7 +555,7 @@ function fcn_deleteCookie(cname) { /** * Delete all cookies. * - * @since 4.7 + * @since 4.7.0 * @link https://stackoverflow.com/questions/179355/clearing-all-cookies-with-javascript */ @@ -578,7 +578,7 @@ function fcn_deleteAllCookies() { /** * Set a cookie. * - * @since 4.7 + * @since 4.7.0 * @param {String} cname - Name of the cookie to set. * @param {String} value - Value of the cookie to set. * @param {Number} [days=30] - Days the cookie will last. @@ -601,7 +601,7 @@ function fcn_setCookie(cname, value, days = 30) { /** * Retrieves the given cookie if available. * - * @since 4.7 + * @since 4.7.0 * @param {String} cname - Name of the cookie to retrieve. * @return {String|Null} The cookie or null if not found. */ @@ -628,7 +628,7 @@ function fcn_getCookie(cname) { /** * Very simple check whether an URL is valid. * - * @since 4.7 + * @since 4.7.0 * @return {Boolean} True of the URL is valid, false otherwise. */ @@ -647,7 +647,7 @@ function fcn_isValidUrl(url) { /** * Return the Fictioneer nonce, accounting for dynamic nonces. * - * @since 5.0 + * @since 5.0.0 * @return {String} The fictioneer_nonce value. */ @@ -662,7 +662,7 @@ function fcn_getNonce() { /** * Match a fingerprint with the local user fingerprint if set. * - * @since 5.0 + * @since 5.0.0 * @param {String} fingerprint - The fingerprint to match with. * @return {Boolean} True or false */ @@ -684,7 +684,7 @@ function fcn_matchFingerprint(fingerprint) { /** * Build new URL with search parameters. * - * @since 5.0 + * @since 5.0.0 * @param {Object} [params=] - Optional. Search params to add. * @param {String|null} [url=] - Optional. The base URL string. * @return {URL} The built URL. @@ -713,7 +713,7 @@ function fcn_buildUrl(params = {}, url = null) { /** * Build error message notice to add to the DOM. * - * @since 5.0 + * @since 5.0.0 * @param {String} message - Message of the error notice. * @param {String} [id=false] - Optional. ID of the element. * @param {Boolean} [sanitize=true] - Optional. Whether to sanitize the HTML. diff --git a/taxonomy-fcn_character.php b/taxonomy-fcn_character.php index 826e4ddd..9a240b8f 100644 --- a/taxonomy-fcn_character.php +++ b/taxonomy-fcn_character.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * @see partials/_archive-loop.php */ ?> diff --git a/taxonomy-fcn_content_warning.php b/taxonomy-fcn_content_warning.php index d041a850..4156d7a3 100644 --- a/taxonomy-fcn_content_warning.php +++ b/taxonomy-fcn_content_warning.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.6 + * @since 4.6.0 * @see partials/_archive-loop.php */ ?> diff --git a/taxonomy-fcn_fandom.php b/taxonomy-fcn_fandom.php index 8cdf365d..60fe8483 100644 --- a/taxonomy-fcn_fandom.php +++ b/taxonomy-fcn_fandom.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.0 + * @since 4.0.0 * @see partials/_archive-loop.php */ ?> diff --git a/taxonomy-fcn_genre.php b/taxonomy-fcn_genre.php index 48cd5b86..25287da1 100644 --- a/taxonomy-fcn_genre.php +++ b/taxonomy-fcn_genre.php @@ -4,7 +4,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.6 + * @since 4.6.0 * @see partials/_archive-loop.php */ ?> diff --git a/user-profile.php b/user-profile.php index bff9885b..ee89451f 100644 --- a/user-profile.php +++ b/user-profile.php @@ -8,7 +8,7 @@ * * @package WordPress * @subpackage Fictioneer - * @since 4.5 + * @since 4.5.0 */ ?>