• Listless I’m counting my [li]bullets[/li].

[quote]… me like my landlord![/quote]

$1

$1

$1

' . _x( ' Show Image', 'Comment image consent wrapper button.', 'fictioneer' ) . '

' . _x( ' Show Image', 'Comment image consent wrapper button.', 'fictioneer' ) . '

` or `` tags!
   *
   * @since 5.4.0
   *
   * @param string $html  The HTML string to be minified.
   *
   * @return string The minified HTML string.
   */

  function fictioneer_minify_html( $html ) {
    return preg_replace( '/\s+/', ' ', trim( $html ) );
  }
}

// =============================================================================
// GET CLEAN CURRENT URL
// =============================================================================

if ( ! function_exists( 'fictioneer_get_clean_url' ) ) {
  /**
   * Returns URL without query arguments or page number
   *
   * @since 5.4.0
   *
   * @return string The clean URL.
   */

  function fictioneer_get_clean_url() {
    global $wp;

    // Setup
    $url = home_url( $wp->request );

    // Remove page (if any)
    $url = preg_replace( '/\/page\/\d+\/$/', '', $url );
    $url = preg_replace( '/\/page\/\d+$/', '', $url );

    // Return cleaned URL
    return $url;
  }
}

// =============================================================================
// GET AUTHOR IDS OF POST
// =============================================================================

if ( ! function_exists( 'fictioneer_get_post_author_ids' ) ) {
  /**
   * Returns array of author IDs for a post ID
   *
   * @since 5.4.8
   *
   * @param int $post_id  The post ID.
   *
   * @return array The author IDs.
   */

  function fictioneer_get_post_author_ids( $post_id ) {
    $author_ids = get_post_meta( $post_id, 'fictioneer_story_co_authors', true ) ?: [];
    $author_ids = is_array( $author_ids ) ? $author_ids : [];
    array_unshift( $author_ids, get_post_field( 'post_author', $post_id ) );

    return array_unique( $author_ids );
  }
}

// =============================================================================
// DELETE TRANSIENTS THAT INCLUDE A STRING
// =============================================================================

if ( ! function_exists( 'fictioneer_delete_transients_like' ) ) {
  /**
   * Delete Transients with a like key and return the count deleted
   *
   * @since 5.4.9
   *
   * @param string  $partial_key  String that is part of the key.
   * @param boolean $fast         Optional. Whether to delete with a single SQL query or
   *                              loop each Transient with delete_transient(), which can
   *                              trigger hooked actions (if any). Default true.
   *
   * @return int Count of deleted Transients.
   */

  function fictioneer_delete_transients_like( $partial_key, $fast = true ) {
    // Globals
    global $wpdb;

    // Setup
    $count = 0;

    // Fast?
    if ( $fast ) {
      // Prepare SQL
      $sql = $wpdb->prepare(
        "DELETE FROM $wpdb->options WHERE `option_name` LIKE %s OR `option_name` LIKE %s",
        "%_transient%{$partial_key}%",
        "%_transient_timeout%{$partial_key}%"
      );

      // Query
      $count = $wpdb->query( $sql ) / 2; // Count Transient and Transient timeout as one
    } else {
      // Prepare SQL
      $sql = $wpdb->prepare(
        "SELECT `option_name` AS `name` FROM $wpdb->options WHERE `option_name` LIKE %s",
        "_transient%{$partial_key}%"
      );

      // Query
      $transients = $wpdb->get_col( $sql );

      // Build full keys and delete
      foreach ( $transients as $transient ) {
        $key = str_replace( '_transient_', '', $transient );
        $count += delete_transient( $key ) ? 1 : 0;
      }
    }

    // Return count
    return $count;
  }
}

// =============================================================================
// GET OPTION PAGE LINK
// =============================================================================

if ( ! function_exists( 'fictioneer_get_assigned_page_link' ) ) {
  /**
   * Returns permalink for an assigned page or null
   *
   * @since 5.4.9
   *
   * @param string $option  The option name of the page assignment.
   *
   * @return string|null The permalink or null.
   */

  function fictioneer_get_assigned_page_link( $option ) {
    // Setup
    $page_id = get_option( $option );

    // Null if no page has been selected (null or -1)
    if ( empty( $page_id ) || $page_id < 0 ) {
      return null;
    }

    // Get permalink from options or post
    $link = get_option( "{$option}_link" );

    if ( empty( $link ) ) {
      $link = get_permalink( $page_id );
      update_option( "{$option}_link", $link, true ); // Save for next time
    }

    // Return
    return $link;
  }
}

// =============================================================================
// MULTI SAVE GUARD
// =============================================================================

if ( ! function_exists( 'fictioneer_multi_save_guard' ) ) {
  /**
   * Prevents multi-fire in update hooks
   *
   * Unfortunately, the block editor always fires twice: once as REST request and
   * followed by WP_POST. Only the first will have the correct parameters such as
   * $update set, the second is technically no longer an update. Since blocking
   * the follow-up WP_POST would block programmatically triggered actions, there
   * is no other choice but to block the REST request and live with it.
   *
   * @since 5.5.2
   *
   * @param int $post_id  The ID of the updated post.
   *
   * @return boolean True if NOT allowed, false otherwise.
   */

  function fictioneer_multi_save_guard( $post_id ) {
    if (
      ( defined('REST_REQUEST') && REST_REQUEST ) ||
      wp_is_post_autosave( $post_id ) ||
      wp_is_post_revision( $post_id ) ||
      get_post_status( $post_id ) === 'auto-draft'
    ) {
      return true;
    }

    // Pass
    return false;
  }
}

// =============================================================================
// GET TOTAL WORD COUNT FOR ALL STORIES
// =============================================================================

if ( ! function_exists( 'fictioneer_get_stories_total_word_count' ) ) {
  /**
   * Return the total word count of all published stories
   *
   * @since 4.0.0
   * @see fictioneer_get_story_data()
   */

  function fictioneer_get_stories_total_word_count() {
    // Look for cached value (purged after each update, should never be stale)
    $transient_word_count_cache = get_transient( 'fictioneer_stories_total_word_count' );

    // Return cached value if found
    if ( $transient_word_count_cache ) {
      return $transient_word_count_cache;
    }

    // Setup
    $word_count = 0;

    // Query all stories
    $stories = get_posts(
      array(
        'numberposts' => -1,
        'post_type' => 'fcn_story',
        'post_status' => 'publish',
        'update_post_meta_cache' => true,
        'update_post_term_cache' => false, // Improve performance
        'no_found_rows' => true, // Improve performance
      )
    );

    // Sum of all word counts
    foreach( $stories as $story ) {
      $story_data = fictioneer_get_story_data( $story->ID, false ); // Does not refresh comment count!
      $word_count += $story_data['word_count'];
    }

    // Cache for next time
    set_transient( 'fictioneer_stories_total_word_count', $word_count, 900 );

    // Return newly calculated value
    return $word_count;
  }
}

// =============================================================================
// USER SELF-DELETE
// =============================================================================

/**
 * Deletes the current user's account and anonymized their comments
 *
 * @since 5.6.0
 *
 * @return bool True if the user was successfully deleted, false otherwise.
 */

function fictioneer_delete_my_account() {
  // Setup
  $current_user = wp_get_current_user();

  // Guard
  if (
    ! $current_user ||
    $current_user->ID === 1 ||
    in_array( 'administrator', $current_user->roles ) ||
    ! current_user_can( 'fcn_allow_self_delete' ) ||
    current_user_can( 'manage_options' )
  ) {
    return false;
  }

  // Update comments
  $comments = get_comments( array( 'user_id' => $current_user->ID ) );

  foreach ( $comments as $comment ) {
    wp_update_comment(
      array(
        'comment_ID' => $comment->comment_ID,
        'user_ID' => 0,
        'comment_author' => fcntr( 'deleted_user' ),
        'comment_author_email' => '',
        'comment_author_IP' => '',
        'comment_agent' => '',
        'comment_author_url' => ''
      )
    );

    // Make absolutely sure no comment subscriptions remain
    fictioneer_update_comment_meta( $comment->comment_ID, 'fictioneer_send_notifications', false );

    // Retain some (redacted) data in case there was a mistake
    add_comment_meta( $comment->comment_ID, 'fictioneer_deleted_user_id', $current_user->ID );
    add_comment_meta( $comment->comment_ID, 'fictioneer_deleted_username_substr', substr( $current_user->user_login, 0, 3 ) );
    add_comment_meta( $comment->comment_ID, 'fictioneer_deleted_email_substr', substr( $comment->comment_author_email, 0, 3 ) );
  }

  // Delete user
  if ( wp_delete_user( $current_user->ID ) ) {
    return true;
  }

  // Failure
  return false;
}

// =============================================================================
// RESCUE EMPTY ARRAY AS [0]
// =============================================================================

/**
 * Returns the given array or an array with a single 0 if empty
 *
 * Prevents an array from being empty, which is useful for 'post__in' query
 * arguments that cannot deal with empty arrays.
 *
 * @since 5.6.0
 *
 * @param array $array  The input array to check.
 *
 * @return array The original array or [0].
 */

function fictioneer_rescue_array_zero( $array ) {
  return empty( $array ) ? [0] : $array;
}

// =============================================================================
// REDIRECT TO 404
// =============================================================================

if ( ! function_exists( 'fictioneer_redirect_to_404' ) ) {
  /**
   * Redirects the current request to the WordPress 404 page
   *
   * @since 5.6.0
   *
   * @global WP_Query $wp_query  The main WP_Query instance.
   */

  function fictioneer_redirect_to_404() {
    global $wp_query;

    // Remove scripts to avoid errors
    add_action( 'wp_print_scripts', function() {
      wp_dequeue_script( 'fictioneer-chapter-scripts' );
      wp_dequeue_script( 'fictioneer-suggestion-scripts' );
      wp_dequeue_script( 'fictioneer-tts-scripts' );
      wp_dequeue_script( 'fictioneer-story-scripts' );
    }, 99 );

    // Set query to 404
    $wp_query->set_404();
    status_header( 404 );
    nocache_headers();
    get_template_part( 404 );

    // Terminate
    exit();
  }
}

// =============================================================================
// PREVIEW ACCESS VERIFICATION
// =============================================================================

if ( ! function_exists( 'fictioneer_verify_unpublish_access' ) ) {
  /**
   * Verifies access to unpublished posts (not drafts)
   *
   * @since 5.6.0
   *
   * @return boolean True if access granted, false otherwise.
   */

  function fictioneer_verify_unpublish_access( $post_id ) {
    // Setup
    $post = get_post( $post_id );

    // Always let owner to pass
    if ( get_current_user_id() === absint( $post->post_author ) ) {
      return true;
    }

    // Always let administrators pass
    if ( current_user_can( 'manage_options' ) ) {
      return true;
    }

    // Check capability for post type
    if ( $post->post_status === 'private' ) {
      switch ( $post->post_type ) {
        case 'post':
          return current_user_can( 'edit_private_posts' );
          break;
        case 'page':
          return current_user_can( 'edit_private_pages' );
          break;
        case 'fcn_chapter':
          return current_user_can( 'read_private_fcn_chapters' );
          break;
        case 'fcn_story':
          return current_user_can( 'read_private_fcn_stories' );
          break;
        case 'fcn_recommendation':
          return current_user_can( 'read_private_fcn_recommendations' );
          break;
        case 'fcn_collection':
          return current_user_can( 'read_private_fcn_collections' );
          break;
        default:
          return current_user_can( 'edit_others_posts' );
      }
    }

    // Drafts are handled by WordPress
    return false;
  }
}

// =============================================================================
// ADD ACTION TO SAVE/TRASH/UNTRASH/DELETE HOOKS WITH POST ID
// =============================================================================

/**
 * Adds callback to save, trash, untrash, and delete hooks (1 argument)
 *
 * 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 5.6.3
 *
 * @param callable $function  The callback function to be added.
 * @param int      $priority  Optional. Used to specify the order in which the
 *                            functions associated with a particular action are
 *                            executed. Default 10. Lower numbers correspond with
 *                            earlier execution, and functions with the same
 *                            priority are executed in the order in which they
 *                            were added to the action.
 *
 * @return true Will always return true.
 */

function fictioneer_add_stud_post_actions( $function, $priority = 10 ) {
  $hooks = ['save_post', 'trashed_post', 'delete_post', 'untrash_post'];

  foreach ( $hooks as $hook ) {
    add_action( $hook, $function, $priority );
  }

  return true;
}

// =============================================================================
// CONVERT URL LIST TO ARRAY
// =============================================================================

/**
 * Turn line-break separated list into array of links
 *
 * @since 5.7.4
 *
 * @param string $list  The list of links
 *
 * @return array The array of links.
 */

function fictioneer_url_list_to_array( $list ) {
  // Already array?
  if ( is_array( $list ) ) {
    return $list;
  }

  // Catch falsy values
  if ( empty( $list ) ) {
    return [];
  }

  // Prepare URLs
  $urls = [];
  $lines = explode( "\n", $list );

  // Extract
  foreach ( $lines as $line ) {
    $tuple = explode( '|', $line );
    $tuple = array_map( 'trim', $tuple );

    $urls[] = array(
      'name' => wp_strip_all_tags( $tuple[0] ),
      'url' => sanitize_url( $tuple[1] )
    );
  }

  // Return
  return $urls;
}

// =============================================================================
// ARRAY OPERATIONS
// =============================================================================

/**
 * Unset array element by value
 *
 * @since 5.7.5
 *
 * @param mixed $value  The value to look for.
 * @param array $array  The array to be modified.
 *
 * @return array The modified array.
 */

function fictioneer_unset_by_value( $value, $array ) {
  if ( ( $key = array_search( $value, $array ) ) !== false ) {
    unset( $array[ $key ] );
  }

  return $array;
}

// =============================================================================
// RETURN NO FORMAT STRING
// =============================================================================

/**
 * Returns an unformatted replacement string
 *
 * @since 5.7.5
 *
 * @return string Just a simple '%s'.
 */

function fictioneer__return_no_format() {
  return '%s';
}

// =============================================================================
// TRUNCATE STRING
// =============================================================================

/**
 * Returns a truncated string without tags
 *
 * @since 5.9.0
 *
 * @param string      $string    The string to truncate.
 * @param int         $length    Maximum length in characters.
 * @param string|null $ellipsis  Optional. Truncation indicator suffix.
 *
 * @return string The truncated string without tags.
 */

function fictioneer_truncate( string $string, int $length, string $ellipsis = null ) {
  // Setup
  $string = wp_strip_all_tags( $string ); // Prevent tags from being cut off
  $ellipsis = $ellipsis ?? FICTIONEER_TRUNCATION_ELLIPSIS;

  // Return truncated string
  if ( ! function_exists( 'mb_strimwidth' ) ) {
    return mb_strimwidth( $string, 0, $length, $ellipsis );
  } else {
    return strlen( $string ) > $length ? substr( $string, 0, $length ) . $ellipsis : $string;
  }
}

// =============================================================================
// APPEND MISSING META FIELDS
// =============================================================================

/**
 * Append a missing meta field to selected posts
 *
 * @since 5.7.4
 * @global wpdb $wpdb  WordPress database object.
 *
 * @param string $post_type   The post type to append to.
 * @param string $meta_key    The meta key to append.
 * @param mixed  $meta_value  The value to assign.
 */

function fictioneer_append_meta_fields( $post_type, $meta_key, $meta_value ) {
  global $wpdb;

  // Setup
  $values = [];

  // Get posts with missing meta field
  $posts = $wpdb->get_col("
    SELECT p.ID
    FROM {$wpdb->posts} p
    LEFT JOIN {$wpdb->postmeta} pm ON p.ID = pm.post_id AND pm.meta_key = '{$meta_key}'
    WHERE p.post_type = '{$post_type}' AND pm.meta_id IS NULL
  ");

  // Prepare values
  foreach ( $posts as $post_id ) {
    $values[] = $wpdb->prepare( "(%d, %s, %d)", $post_id, $meta_key, $meta_value );
  }

  $chunks = array_chunk( $values, 1000 );

  // Query
  foreach ( $chunks as $chunk ) {
    $values_sql = implode( ', ', $chunk );

    if( ! empty( $values_sql ) ) {
      $wpdb->query("
        INSERT INTO {$wpdb->postmeta} (post_id, meta_key, meta_value)
        VALUES {$values_sql};
      ");
    }
  }
}

// =============================================================================
// COMPARE WORDPRESS VERSION
// =============================================================================

/**
 * Compare installed WordPress version against version string
 *
 * @since 5.12.2
 * @global wpdb $wp_version  Current WordPress version string.
 *
 * @param string $version   The version string to test against.
 * @param string $operator  Optional. How to compare. Default '>='.
 *
 * @return boolean True or false.
 */

function fictioneer_compare_wp_version( $version, $operator = '>=' ) {
  global $wp_version;

  return version_compare( $wp_version, $version, $operator );
}

// =============================================================================
// CSS LOADING PATTERN
// =============================================================================

if ( ! function_exists( 'fictioneer_get_async_css_loading_pattern' ) ) {
  /**
   * Returns the media attribute and loading strategy for stylesheets
   *
   * @since 5.12.2
   *
   * @return string Media attribute script for stylesheet links.
   */

  function fictioneer_get_async_css_loading_pattern() {
    if ( FICTIONEER_ENABLE_ASYNC_ONLOAD_PATTERN ) {
      return 'media="print" onload="this.media=\'all\'; this.onload=null;"';
    }

    return 'media="all"';
  }
}

// =============================================================================
// GENERATE PLACEHOLDER
// =============================================================================

if ( ! function_exists( 'fictioneer_generate_placeholder' ) ) {
  /**
   * Dummy implementation (currently used a CSS background)
   *
   * @since 5.14.0
   *
   * @param array|null $args  Optional arguments to generate a placeholder.
   *
   * @return string The placeholder URL or data URI.
   */

  function fictioneer_generate_placeholder( $args = [] ) {
    return '';
  }
}

// =============================================================================
// FIND USER(S)
// =============================================================================

/**
 * Find (first) user by display name
 *
 * @since 5.14.1
 *
 * @param string $display_name  The display name to search for.
 *
 * @return WP_User|null The first matching user or null if not found.
 */

function fictioneer_find_user_by_display_name( $display_name ) {
  // No choice but to query all because the display name is not unique
  $users = get_users(
    array(
      'search' => sanitize_user( $display_name ),
      'search_columns' => ['display_name'],
      'number' => 1
    )
  );

  // If found, return first
  if ( ! empty( $users ) ) {
    return $users[0];
  }

  // Not found
  return null;
}

// =============================================================================
// JOIN ARRAYS IN SPECIAL WAYS
// =============================================================================

if ( ! function_exists( 'fictioneer_get_human_readable_list' ) ) {
  /**
   * Join string in an array as human readable list.
   *
   * @since 5.15.0
   * @link https://gist.github.com/SleeplessByte/4514697
   *
   * @param array $array  Array of strings.
   *
   * @return string The human readable list.
   */

  function fictioneer_get_human_readable_list( $array ) {
    // Setup
    $comma = _x( ', ', 'Human readable list joining three or more items except the last two.', 'fictioneer' );
    $double = _x( ' or ', 'Human readable list joining two items.', 'fictioneer' );
    $final = _x( ', or ', 'Human readable list joining the last two of three or more items.', 'fictioneer' );

    // One or two items
    if ( count( $array ) < 3 ) {
      return implode( $double, $array );
    }

    // Three or more items
    array_splice( $array, -2, 2, implode( $final, array_slice( $array, -2, 2 ) ) );

    // Finish
    return implode( $comma , $array );
  }
}

// =============================================================================
// PATREON UTILITIES
// =============================================================================

/**
 * Get Patreon data in regards to a post
 *
 * @since 5.15.0
 *
 * @param WP_Post|null $post  The post to check. Default to global $post.
 *
 * @return array|null Array with 'gated' (bool), 'gate_tiers' (array), 'gate_cents' (int),
 *                    and 'gate_lifetime_cents' (int). Null if the post could not be found.
 */

function fictioneer_get_patreon_data( $post = null ) {
  // Static cache
  static $cache = [];

  // Post?
  $post = $post ?? get_post();

  if ( ! $post ) {
    return null;
  }

  // Check cache
  if ( isset( $cache[ $post->ID ] ) ) {
    return $cache[ $post->ID ];
  }

  // Setup
  $global_tiers = get_option( 'fictioneer_patreon_global_lock_tiers', [] ) ?: [];
  $global_amount_cents = get_option( 'fictioneer_patreon_global_lock_amount', 0 ) ?: 0;
  $global_lifetime_amount_cents = get_option( 'fictioneer_patreon_global_lock_lifetime_amount', 0 ) ?: 0;
  $post_tiers = get_post_meta( $post->ID, 'fictioneer_patreon_lock_tiers', true );
  $post_tiers = is_array( $post_tiers ) ? $post_tiers : [];
  $post_amount_cents = absint( get_post_meta( $post->ID, 'fictioneer_patreon_lock_amount', true ) );
  $check_tiers = array_merge( $global_tiers, $post_tiers );
  $check_tiers = array_unique( $check_tiers );
  $check_amount_cents = $post_amount_cents > 0 ? $post_amount_cents : $global_amount_cents;
  $check_amount_cents = $post_amount_cents > 0 && $global_amount_cents > 0
    ? min( $post_amount_cents, $global_amount_cents ) : $check_amount_cents;
  $check_amount_cents = max( $check_amount_cents, 0 );

  // Compile
  $data = array(
    'gated' => $check_tiers || $check_amount_cents > 0,
    'gate_tiers' => $check_tiers,
    'gate_cents' => $check_amount_cents,
    'gate_lifetime_cents' => $global_lifetime_amount_cents
  );

  // Cache
  $cache[ $post->ID ] = $data;

  // Return
  return $data;
}