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

Remove problematic commit message

Browse Source 
Revert revert!
This commit is contained in:
Tetrakern 2024-01-26 17:45:59 +01:00
parent e00787589d
commit 365496c807
142 changed files with 813 additions and 813 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
404.php
View File

@ -4,7 +4,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.7
* @since 4.7.0
*/
?>

2
author.php
View File

@ -4,7 +4,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.6
* @since 4.6.0
* @see fictioneer_clause_sticky_stories()
*/
?>

2
collections.php
View File

@ -8,7 +8,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 5.0
* @since 5.0.0
*/
?>

2
comments.php
View File

@ -6,7 +6,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.7
* @since 4.7.0
*/
?>

18
includes/functions/_admin.php
View File

@ -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() {

10
includes/functions/_api.php
View File

@ -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.

32
includes/functions/_caching_and_transients.php
View File

@ -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() {

6
includes/functions/_cleanup.php
View File

@ -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.
*/

64
includes/functions/_content_helpers.php
View File

@ -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 <use> 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.

24
includes/functions/_cpt_and_taxonomies.php
View File

@ -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.
*/

6
includes/functions/_customizer-settings.php
View File

@ -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.
*/

20
includes/functions/_customizer.php
View File

@ -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() {

4
includes/functions/_discord.php
View File

@ -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.

32
includes/functions/_epub.php
View File

@ -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() {

2
includes/functions/_forms.php
View File

@ -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/
*/

58
includes/functions/_meta_fields.php
View File

@ -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.
*/

50
includes/functions/_oauth.php
View File

@ -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() {

12
includes/functions/_post_updates.php
View File

@ -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.
*/

4
includes/functions/_query_helpers.php
View File

@ -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.

54
includes/functions/_roles.php
View File

@ -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() {

16
includes/functions/_schemas.php
View File

@ -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.
*/

6
includes/functions/_search.php
View File

@ -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.
*/

14
includes/functions/_seo.php
View File

@ -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 <head> SEO meta
*
* @since Fictioneer 5.0
* @since 5.0.0
*/
function fictioneer_output_head_seo() {

24
includes/functions/_shortcodes.php
View File

@ -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.

16
includes/functions/_sitemap.php
View File

@ -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 <loc> 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 <lastmod> 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 <changefreq> 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 <url> 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() {

30
includes/functions/_theme_setup.php
View File

@ -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 <html> 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 <body>
*
* @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 <body>
*
* @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 <head>.
*
* @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 <head> 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 <html> 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.

90
includes/functions/_utility.php
View File

@ -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 <body>.
*
* @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.

38
includes/functions/_wordpress_mods.php
View File

@ -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.
*

10
includes/functions/comments/_comments_ajax.php
View File

@ -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/
*/

18
includes/functions/comments/_comments_controller.php
View File

@ -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.

8
includes/functions/comments/_comments_form.php
View File

@ -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.

24
includes/functions/comments/_comments_moderation.php
View File

@ -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/
*

22
includes/functions/comments/_comments_threads.php
View File

@ -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.
*

8
includes/functions/comments/_story_comments.php
View File

@ -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.
*

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

@ -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() {

8
includes/functions/hooks/_collection_hooks.php
View File

@ -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.

24
includes/functions/hooks/_general_hooks.php
View File

@ -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() {

18
includes/functions/hooks/_mobile_menu_hooks.php
View File

@ -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() {

8
includes/functions/hooks/_post_hooks.php
View File

@ -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() {

12
includes/functions/hooks/_profile_hooks.php
View File

@ -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.

8
includes/functions/hooks/_recommendation_hooks.php
View File

@ -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.

22
includes/functions/hooks/_story_hooks.php
View File

@ -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.

4
includes/functions/schemas/_chapter_schema.php
View File

@ -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.
*

4
includes/functions/schemas/_chapters_schema.php
View File

@ -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.
*

4
includes/functions/schemas/_collections_schema.php
View File

@ -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.
*

4
includes/functions/schemas/_post_schema.php
View File

@ -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.
*

4
includes/functions/schemas/_recommendation_schema.php
View File

@ -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.
*

4
includes/functions/schemas/_recommendations_schema.php
View File

@ -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.
*

4
includes/functions/schemas/_stories_schema.php
View File

@ -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.
*

4
includes/functions/schemas/_story_schema.php
View File

@ -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.
*

12
includes/functions/settings/_register_settings.php
View File

@ -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.

40
includes/functions/settings/_settings.php
View File

@ -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.
*/

72
includes/functions/settings/_settings_actions.php
View File

@ -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()
*/

8
includes/functions/settings/_settings_ajax.php
View File

@ -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() {

34
includes/functions/settings/_settings_loggers.php
View File

@ -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.

2
includes/functions/settings/_settings_page_connections.php
View File

@ -4,7 +4,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.7
* @since 4.7.0
*/
?>

2
includes/functions/settings/_settings_page_epubs.php
View File

@ -4,7 +4,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.7
* @since 4.7.0
*/
?>

2
includes/functions/settings/_settings_page_general.php
View File

@ -4,7 +4,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.7
* @since 4.7.0
*/
?>

2
includes/functions/settings/_settings_page_logs.php
View File

@ -4,7 +4,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 5.0
* @since 5.0.0
*/
?>

2
includes/functions/settings/_settings_page_phrases.php
View File

@ -4,7 +4,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.7
* @since 4.7.0
*/
?>

2
includes/functions/settings/_settings_page_seo.php
View File

@ -4,7 +4,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.7
* @since 4.7.0
*/
?>

2
includes/functions/settings/_settings_page_tools.php
View File

@ -4,7 +4,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.7
* @since 4.7.0
*/
?>

36
includes/functions/users/_admin_profile.php
View File

@ -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!

10
includes/functions/users/_avatars.php
View File

@ -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()

2
includes/functions/users/_bookmarks.php
View File

@ -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()

12
includes/functions/users/_checkmarks.php
View File

@ -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() {

14
includes/functions/users/_follows.php
View File

@ -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() {

8
includes/functions/users/_reminders.php
View File

@ -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() {

36
includes/functions/users/_user_data.php
View File

@ -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() {

2
index.php
View File

@ -7,7 +7,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.6
* @since 4.6.0
* @see partials/_loop.php
*/
?>

2
partials/_bookmarks.php
View File

@ -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.

2
partials/_card-chapter.php
View File

@ -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.

2
partials/_card-collection.php
View File

@ -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.

2
partials/_card-page.php
View File

@ -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.

2
partials/_card-post.php
View File

@ -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.

2
partials/_card-recommendation.php
View File

@ -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.

2
partials/_card-story.php
View File

@ -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.

2
partials/_chapter-header.php
View File

@ -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.

2
partials/_collection-header.php
View File

@ -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.

2
partials/_collection-statistics.php
View File

@ -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.

2
partials/_consent-banner.php
View File

@ -4,7 +4,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.0
* @since 4.0.0
*/
?>

2
partials/_header-inner.php
View File

@ -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).

2
partials/_icon-menu.php
View File

@ -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'.
*/

2
partials/_latest-chapters-compact.php
View File

@ -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.

2
partials/_latest-chapters.php
View File

@ -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.

2
partials/_latest-posts.php
View File

@ -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.

2
partials/_latest-recommendations-compact.php
View File

@ -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.

2
partials/_latest-recommendations.php
View File

@ -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.

2
partials/_latest-stories-compact.php
View File

@ -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.

2
partials/_latest-stories.php
View File

@ -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.

2
partials/_latest-updates-compact.php
View File

@ -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.

2
partials/_latest-updates.php
View File

@ -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.

2
partials/_modal-bbcodes.php
View File

@ -4,7 +4,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.0
* @since 4.0.0
*/
?>

2
partials/_modal-formatting.php
View File

@ -4,7 +4,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.0
* @since 4.0.0
*/
?>

2
partials/_modal-login.php
View File

@ -4,7 +4,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.0
* @since 4.0.0
*/
?>

2
partials/_modal-sharing.php
View File

@ -4,7 +4,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.0
* @since 4.0.0
*/
?>

2
partials/_modal-site-settings.php
View File

@ -4,7 +4,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.1
* @since 4.1.0
*/
?>

2
partials/_modal-suggestions.php
View File

@ -4,7 +4,7 @@
*
* @package WordPress
* @subpackage Fictioneer
* @since 4.0
* @since 4.0.0
*/
?>

2
partials/_navigation.php
View File

@ -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).

2
partials/_recommendation-header.php
View File

@ -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.

Some files were not shown because too many files have changed in this diff Show More