crp_settings_general(),
'list' => crp_settings_list(),
'output' => crp_settings_output(),
'thumbnail' => crp_settings_thumbnail(),
'styles' => crp_settings_styles(),
'feed' => crp_settings_feed(),
);
/**
* Filters the settings array
*
* @since 2.6.0
*
* @param array $crp_settings Settings array
*/
return apply_filters( 'crp_registered_settings', $crp_settings );
}
/**
* Retrieve the array of General settings
*
* @since 2.6.0
*
* @return array General settings array
*/
function crp_settings_general() {
$settings = array(
'cache_posts' => array(
'id' => 'cache_posts',
'name' => esc_html__( 'Cache posts only', 'contextual-related-posts' ),
'desc' => esc_html__( 'Enabling this will only cache the related posts but not the entire HTML output. This gives you more flexibility at marginally lower performance. Use this if you only have the related posts called with the same set of parameters.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => false,
),
'cache' => array(
'id' => 'cache',
'name' => esc_html__( 'Cache HTML output', 'contextual-related-posts' ),
'desc' => esc_html__( 'Only works if the previous option is disabled. Enabling this will cache the entire HTML generated when the post is visited the first time. The cache is cleaned when you save this page. Highly recommended particularly on busy sites.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => false,
),
'add_to' => array(
'id' => 'add_to',
'name' => esc_html__( 'Automatically add related posts to', 'contextual-related-posts' ),
/* translators: 1: Code. */
'desc' => sprintf( esc_html__( 'If you choose to disable this, please add %1$s to your template file where you want it displayed', 'contextual-related-posts' ), "<?php if ( function_exists( 'echo_crp' ) ) { echo_crp(); } ?>" ),
'type' => 'multicheck',
'default' => array(
'single' => 'single',
'page' => 'page',
),
'options' => array(
'single' => esc_html__( 'Posts', 'contextual-related-posts' ),
'page' => esc_html__( 'Pages', 'contextual-related-posts' ),
'home' => esc_html__( 'Home page', 'contextual-related-posts' ),
'feed' => esc_html__( 'Feeds', 'contextual-related-posts' ),
'category_archives' => esc_html__( 'Category archives', 'contextual-related-posts' ),
'tag_archives' => esc_html__( 'Tag archives', 'contextual-related-posts' ),
'other_archives' => esc_html__( 'Other archives', 'contextual-related-posts' ),
),
),
'content_filter_priority' => array(
'id' => 'content_filter_priority',
'name' => esc_html__( 'Display location priority', 'contextual-related-posts' ),
'desc' => esc_html__( 'Select the relative position of the related posts in the post content. A higher number pushes the related posts later in the content. Any number below 10 is not recommended.', 'contextual-related-posts' ),
'type' => 'number',
'options' => '999',
),
'insert_after_paragraph' => array(
'id' => 'insert_after_paragraph',
'name' => esc_html__( 'Insert after paragraph number', 'contextual-related-posts' ),
'desc' => esc_html__( 'Enter 0 to display the related posts before the post content, -1 to display this at the end or a number to insert it after that paragraph number. If your post has less paragraphs, related posts will be displayed at the end.', 'contextual-related-posts' ),
'type' => 'number',
'options' => '-1',
'min' => '-1',
),
'disable_on_mobile' => array(
'id' => 'disable_on_mobile',
'name' => esc_html__( 'Disable on mobile devices', 'contextual-related-posts' ),
'desc' => esc_html__( 'Disable display of related posts on mobile devices. Might not always work with caching plugins.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => false,
),
'disable_on_amp' => array(
'id' => 'disable_on_amp',
'name' => esc_html__( 'Disable on AMP pages', 'contextual-related-posts' ),
'desc' => esc_html__( 'Disable display of related posts on AMP pages.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => false,
),
'uninstall_options' => array(
'id' => 'uninstall_options',
'name' => esc_html__( 'Delete options on uninstall', 'contextual-related-posts' ),
'desc' => esc_html__( 'If this is checked, all settings related to Contextual Related Posts are removed from the database if you choose to uninstall/delete the plugin.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => true,
),
'uninstall_indices' => array(
'id' => 'uninstall_indices',
'name' => esc_html__( 'Delete FULLTEXT indices on uninstall', 'contextual-related-posts' ),
'desc' => esc_html__( 'If this is checked, FULLTEXT indices generated by Contextual Related Posts are removed from the database if you choose to uninstall/delete the plugin.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => true,
),
'uninstall_indices_deactivate' => array(
'id' => 'uninstall_indices_deactivate',
'name' => esc_html__( 'Delete FULLTEXT indices on deactivate', 'contextual-related-posts' ),
'desc' => esc_html__( 'If this is checked, FULLTEXT indices generated by Contextual Related Posts are removed from the database if you choose to deactivate the plugin.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => false,
),
'show_metabox' => array(
'id' => 'show_metabox',
'name' => esc_html__( 'Show metabox', 'contextual-related-posts' ),
'desc' => esc_html__( 'This will add the Contextual Related Posts metabox on Edit Posts or Add New Posts screens. Also applies to Pages and Custom Post Types.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => true,
),
'show_metabox_admins' => array(
'id' => 'show_metabox_admins',
'name' => esc_html__( 'Limit meta box to Admins only', 'contextual-related-posts' ),
'desc' => esc_html__( 'If selected, the meta box will be hidden from anyone who is not an Admin. By default, Contributors and above will be able to see the meta box. Applies only if the above option is selected.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => false,
),
'show_credit' => array(
'id' => 'show_credit',
'name' => esc_html__( 'Link to Contextual Related Posts plugin page', 'contextual-related-posts' ),
'desc' => esc_html__( 'A no-follow link to the plugin homepage will be added as the last item of the related posts.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => false,
),
);
/**
* Filters the General settings array
*
* @since 2.6.0
*
* @param array $settings General settings array
*/
return apply_filters( 'crp_settings_general', $settings );
}
/**
* Retrieve the array of Output settings
*
* @since 2.6.0
*
* @return array Output settings array
*/
function crp_settings_output() {
$settings = array(
'title' => array(
'id' => 'title',
'name' => esc_html__( 'Heading of posts', 'contextual-related-posts' ),
'desc' => esc_html__( 'Displayed before the list of the posts as a master heading', 'contextual-related-posts' ),
'type' => 'text',
'options' => '' . esc_html__( 'Related Posts', 'contextual-related-posts' ) . ':
',
'size' => 'large',
),
'blank_output' => array(
'id' => 'blank_output',
'name' => esc_html__( 'Show when no posts are found', 'contextual-related-posts' ),
/* translators: 1: Code. */
'desc' => '',
'type' => 'radio',
'default' => 'blank',
'options' => array(
'blank' => esc_html__( 'Blank output', 'contextual-related-posts' ),
'custom_text' => esc_html__( 'Display custom text', 'contextual-related-posts' ),
),
),
'blank_output_text' => array(
'id' => 'blank_output_text',
'name' => esc_html__( 'Custom text', 'contextual-related-posts' ),
'desc' => esc_html__( 'Enter the custom text that will be displayed if the second option is selected above.', 'contextual-related-posts' ),
'type' => 'textarea',
'options' => esc_html__( 'No related posts found', 'contextual-related-posts' ),
),
'show_excerpt' => array(
'id' => 'show_excerpt',
'name' => esc_html__( 'Show post excerpt', 'contextual-related-posts' ),
'desc' => esc_html__( 'If the post does not have an excerpt, the plugin will automatically create one containing the number of words specified in the next option.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => false,
),
'excerpt_length' => array(
'id' => 'excerpt_length',
'name' => esc_html__( 'Length of excerpt (in words)', 'contextual-related-posts' ),
'desc' => '',
'type' => 'number',
'options' => '10',
'min' => '0',
'size' => 'small',
),
'show_date' => array(
'id' => 'show_date',
'name' => esc_html__( 'Show date', 'contextual-related-posts' ),
'desc' => esc_html__( 'Displays the date of the post. Uses the same date format set in General Options.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => false,
),
'show_author' => array(
'id' => 'show_author',
'name' => esc_html__( 'Show author', 'contextual-related-posts' ),
'desc' => '',
'type' => 'checkbox',
'options' => false,
),
'show_primary_term' => array(
'id' => 'show_primary_term',
'name' => esc_html__( 'Show primary category/term', 'contextual-related-posts' ),
'desc' => esc_html__( 'This will display the primary category/term. This is usually set via your SEO plugin and will default to the first category/term returned by WordPress', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => false,
),
'title_length' => array(
'id' => 'title_length',
'name' => esc_html__( 'Limit post title length (in characters)', 'contextual-related-posts' ),
'desc' => esc_html__( 'Any title longer than the number of characters set above will be cut and appended with an ellipsis (…)', 'contextual-related-posts' ),
'type' => 'number',
'options' => '60',
'min' => '0',
'size' => 'small',
),
'link_new_window' => array(
'id' => 'link_new_window',
'name' => esc_html__( 'Open links in new window', 'contextual-related-posts' ),
'desc' => '',
'type' => 'checkbox',
'options' => false,
),
'link_nofollow' => array(
'id' => 'link_nofollow',
'name' => esc_html__( 'Add nofollow to links', 'contextual-related-posts' ),
'desc' => '',
'type' => 'checkbox',
'options' => false,
),
'exclude_output_header' => array(
'id' => 'exclude_output_header',
'name' => '' . esc_html__( 'Exclusion settings', 'contextual-related-posts' ) . '
',
'desc' => '',
'type' => 'header',
),
'exclude_on_post_ids' => array(
'id' => 'exclude_on_post_ids',
'name' => esc_html__( 'Exclude display on these posts', 'contextual-related-posts' ),
'desc' => esc_html__( 'Comma separated list of post, page or custom post type IDs. e.g. 188,320,500', 'contextual-related-posts' ),
'type' => 'numbercsv',
'options' => '',
),
'exclude_on_post_types' => array(
'id' => 'exclude_on_post_types',
'name' => esc_html__( 'Exclude display on these post types', 'contextual-related-posts' ),
'desc' => esc_html__( 'The related posts will not display on any of the above selected post types.', 'contextual-related-posts' ),
'type' => 'posttypes',
'options' => '',
),
'exclude_on_cat_slugs' => array(
'id' => 'exclude_on_cat_slugs',
'name' => esc_html__( 'Exclude on Terms', 'contextual-related-posts' ),
'desc' => esc_html__( 'The field above has an autocomplete so simply start typing in the starting letters and it will prompt you with options. This field requires a specific format as displayed by the autocomplete.', 'contextual-related-posts' ),
'type' => 'csv',
'options' => '',
'size' => 'large',
'field_class' => 'category_autocomplete',
),
'html_wrapper_header' => array(
'id' => 'html_wrapper_header',
'name' => '' . esc_html__( 'HTML to display', 'contextual-related-posts' ) . '
',
'desc' => '',
'type' => 'header',
),
'before_list' => array(
'id' => 'before_list',
'name' => esc_html__( 'Before the list of posts', 'contextual-related-posts' ),
'desc' => '',
'type' => 'text',
'options' => '',
),
'after_list' => array(
'id' => 'after_list',
'name' => esc_html__( 'After the list of posts', 'contextual-related-posts' ),
'desc' => '',
'type' => 'text',
'options' => '
',
),
'before_list_item' => array(
'id' => 'before_list_item',
'name' => esc_html__( 'Before each list item', 'contextual-related-posts' ),
'desc' => '',
'type' => 'text',
'options' => '',
),
'after_list_item' => array(
'id' => 'after_list_item',
'name' => esc_html__( 'After each list item', 'contextual-related-posts' ),
'desc' => '',
'type' => 'text',
'options' => '',
),
);
/**
* Filters the Output settings array
*
* @since 2.6.0
*
* @param array $settings Output settings array
*/
return apply_filters( 'crp_settings_output', $settings );
}
/**
* Retrieve the array of List settings
*
* @since 2.6.0
*
* @return array List settings array
*/
function crp_settings_list() {
$settings = array(
'limit' => array(
'id' => 'limit',
'name' => esc_html__( 'Number of posts to display', 'contextual-related-posts' ),
'desc' => esc_html__( 'Maximum number of posts that will be displayed in the list. This option is used if you do not specify the number of posts in the widget or shortcodes', 'contextual-related-posts' ),
'type' => 'number',
'options' => '6',
'min' => '0',
'size' => 'small',
),
'daily_range' => array(
'id' => 'daily_range',
'name' => esc_html__( 'Related posts should be newer than', 'contextual-related-posts' ),
'desc' => esc_html__( 'This sets the cut-off period for which posts will be displayed. e.g. setting it to 365 will show related posts from the last year only. Set to 0 to disable limiting posts by date.', 'contextual-related-posts' ),
'type' => 'number',
'options' => '0',
'min' => '0',
),
'ordering' => array(
'id' => 'ordering',
'name' => esc_html__( 'Order posts', 'contextual-related-posts' ),
'desc' => '',
'type' => 'radio',
'default' => 'relevance',
'options' => crp_get_orderings(),
),
'random_order' => array(
'id' => 'random_order',
'name' => esc_html__( 'Randomize posts', 'contextual-related-posts' ),
'desc' => esc_html__( 'This shuffles the selected related posts. If you select to order by date in the previous option, then the related posts will first be sorted by date and the selected ones are shuffled. Does not work if Cache HTML output is enabled.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => false,
),
'match_content' => array(
'id' => 'match_content',
'name' => esc_html__( 'Related posts based on title and content', 'contextual-related-posts' ),
'desc' => esc_html__( 'If unchecked, only posts titles are used. Enable the cache if enabling this option for better performance. Each site is different, so toggle this option to see which setting gives you better quality related posts.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => true,
),
'match_content_words' => array(
'id' => 'match_content_words',
'name' => esc_html__( 'Limit content to be compared', 'contextual-related-posts' ),
/* translators: 1: Number. */
'desc' => sprintf( esc_html__( 'This sets the maximum words of the content that will be matched. Set to 0 for no limit. Max value: %1$s. Only applies if you activate the above option.', 'contextual-related-posts' ), CRP_MAX_WORDS ),
'type' => 'number',
'options' => '0',
'min' => '0',
'max' => CRP_MAX_WORDS,
),
'post_types' => array(
'id' => 'post_types',
'name' => esc_html__( 'Post types to include', 'contextual-related-posts' ),
'desc' => esc_html__( 'At least one option should be selected above. Select which post types you want to include in the list of posts. This field can be overridden using a comma separated list of post types when using the manual display.', 'contextual-related-posts' ),
'type' => 'posttypes',
'options' => 'post,page',
),
'same_post_type' => array(
'id' => 'same_post_type',
'name' => esc_html__( 'Limit to same post type', 'contextual-related-posts' ),
'desc' => esc_html__( 'If checked, the related posts will only be selected from the same post type of the current post.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => false,
),
'same_author' => array(
'id' => 'same_author',
'name' => esc_html__( 'Limit to same author', 'contextual-related-posts' ),
'desc' => esc_html__( 'If checked, the related posts will only be selected from the same author of the current post.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => false,
),
'primary_term' => array(
'id' => 'primary_term',
'name' => esc_html__( 'Limit to same primary term', 'contextual-related-posts' ),
'desc' => esc_html__( 'If enabled, then it will only select posts from the primary category/term. This is usually set via your SEO plugin and will default to the first category/term returned by WordPress', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => false,
),
'same_taxes' => array(
'id' => 'same_taxes',
'name' => esc_html__( 'Only from same', 'contextual-related-posts' ),
'desc' => esc_html__( 'Limit the related posts only to the categories, tags, and/or taxonomies of the current post.', 'contextual-related-posts' ),
'type' => 'taxonomies',
'options' => '',
),
'match_all' => array(
'id' => 'match_all',
'name' => esc_html__( 'Match all taxonomies', 'contextual-related-posts' ),
'desc' => esc_html__( 'If enabled, then it will only select posts that match all the above selected taxonomies. This can result in no related posts being found.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => false,
),
'no_of_common_terms' => array(
'id' => 'no_of_common_terms',
'name' => esc_html__( 'Number of common terms', 'contextual-related-posts' ),
'desc' => esc_html__( 'Enter the minimum number of common terms that have to be matched before a post is considered related.', 'contextual-related-posts' ),
'type' => 'number',
'options' => '1',
'min' => '1',
),
'related_meta_keys' => array(
'id' => 'related_meta_keys',
'name' => esc_html__( 'Related Meta Keys', 'contextual-related-posts' ),
'desc' => esc_html__( 'Enter a comma-separated list of meta keys. Posts that match the same value of the meta key are displayed before the other related posts', 'contextual-related-posts' ),
'type' => 'csv',
'options' => '',
'size' => 'large',
),
'exclude_post_ids' => array(
'id' => 'exclude_post_ids',
'name' => esc_html__( 'Post/page IDs to exclude', 'contextual-related-posts' ),
'desc' => esc_html__( 'Comma-separated list of post or page IDs to exclude from the list. e.g. 188,320,500', 'contextual-related-posts' ),
'type' => 'numbercsv',
'options' => '',
),
'exclude_cat_slugs' => array(
'id' => 'exclude_cat_slugs',
'name' => esc_html__( 'Exclude Terms', 'contextual-related-posts' ),
'desc' => esc_html__( 'The field above has an autocomplete so simply start typing in the starting letters and it will prompt you with options. This field requires a specific format as displayed by the autocomplete.', 'contextual-related-posts' ),
'type' => 'csv',
'options' => '',
'size' => 'large',
'field_class' => 'category_autocomplete',
),
'exclude_categories' => array(
'id' => 'exclude_categories',
'name' => esc_html__( 'Exclude Term Taxonomy IDs', 'contextual-related-posts' ),
'desc' => esc_html__( 'This is a readonly field that is automatically populated based on the above input when the settings are saved. These might differ from the IDs visible in the Categories page which use the term_id. Contextual Related Posts uses the term_taxonomy_id which is unique to this taxonomy.', 'contextual-related-posts' ),
'type' => 'text',
'options' => '',
'readonly' => true,
),
'disable_contextual' => array(
'id' => 'disable_contextual',
'name' => esc_html__( 'Disable contextual matching', 'contextual-related-posts' ),
'desc' => esc_html__( 'Selecting this option will turn off contextual matching. This is only useful if you activate the option: "Only from same" from the General tab. Otherwise, you will end up with the same set of related posts on all pages with no relevance.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => false,
),
'disable_contextual_cpt' => array(
'id' => 'disable_contextual_cpt',
'name' => esc_html__( 'Disable contextual matching ONLY on attachments and custom post types', 'contextual-related-posts' ),
'desc' => esc_html__( 'Applies only if the previous option is checked. Selecting this option will retain contextual matching for posts and pages but disable this on any custom post types.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => true,
),
);
/**
* Filters the List settings array
*
* @since 2.6.0
*
* @param array $settings List settings array
*/
return apply_filters( 'crp_settings_list', $settings );
}
/**
* Retrieve the array of Thumbnail settings
*
* @since 2.6.0
*
* @return array Thumbnail settings array
*/
function crp_settings_thumbnail() {
$settings = array(
'post_thumb_op' => array(
'id' => 'post_thumb_op',
'name' => esc_html__( 'Location of the post thumbnail', 'contextual-related-posts' ),
'desc' => '',
'type' => 'radio',
'default' => 'text_only',
'options' => array(
'inline' => esc_html__( 'Display thumbnails inline with posts, before title', 'contextual-related-posts' ),
'after' => esc_html__( 'Display thumbnails inline with posts, after title', 'contextual-related-posts' ),
'thumbs_only' => esc_html__( 'Display only thumbnails, no text', 'contextual-related-posts' ),
'text_only' => esc_html__( 'Do not display thumbnails, only text', 'contextual-related-posts' ),
),
),
'thumb_size' => array(
'id' => 'thumb_size',
'name' => esc_html__( 'Thumbnail size', 'contextual-related-posts' ),
'desc' => esc_html__( 'You can choose from existing image sizes above or create a custom size. If you have chosen Custom size above, then enter the width, height and crop settings below. For best results, use a cropped image. If you change the width and/or height below, existing images will not be automatically resized.' ) . '
' . sprintf(
/* translators: 1: OTF Regenerate plugin link, 2: Force regenerate plugin link. */
esc_html__( 'I recommend using %1$s or %2$s to regenerate all image sizes.', 'contextual-related-posts' ),
'OTF Regenerate Thumbnails',
'Regenerate Thumbnails'
),
'type' => 'thumbsizes',
'default' => 'crp_thumbnail',
'options' => crp_get_all_image_sizes(),
),
'thumb_width' => array(
'id' => 'thumb_width',
'name' => esc_html__( 'Thumbnail width', 'contextual-related-posts' ),
'desc' => '',
'type' => 'number',
'options' => '150',
'min' => '0',
'size' => 'small',
),
'thumb_height' => array(
'id' => 'thumb_height',
'name' => esc_html__( 'Thumbnail height', 'contextual-related-posts' ),
'desc' => '',
'type' => 'number',
'options' => '150',
'min' => '0',
'size' => 'small',
),
'thumb_crop' => array(
'id' => 'thumb_crop',
'name' => esc_html__( 'Hard crop thumbnails', 'contextual-related-posts' ),
'desc' => esc_html__( 'Check this box to hard crop the thumbnails. i.e. force the width and height above vs. maintaining proportions.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => true,
),
'thumb_create_sizes' => array(
'id' => 'thumb_create_sizes',
'name' => esc_html__( 'Generate thumbnail sizes', 'contextual-related-posts' ),
'desc' => esc_html__( 'If you select this option and Custom size is selected above, the plugin will register the image size with WordPress to create new thumbnails. Does not update old images as explained above.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => true,
),
'thumb_html' => array(
'id' => 'thumb_html',
'name' => esc_html__( 'Thumbnail size attributes', 'contextual-related-posts' ),
'desc' => '',
'type' => 'radio',
'default' => 'html',
'options' => array(
/* translators: %s: Code. */
'css' => sprintf( esc_html__( 'Use CSS to set the width and height: e.g. %s', 'contextual-related-posts' ), 'style="max-width:250px;max-height:250px"' ),
/* translators: %s: Code. */
'html' => sprintf( esc_html__( 'Use HTML attributes to set the width and height: e.g. %s', 'contextual-related-posts' ), 'width="250" height="250"' ),
'none' => esc_html__( 'No width or height set. You will need to use external styles to force any width or height of your choice.', 'contextual-related-posts' ),
),
),
'thumb_meta' => array(
'id' => 'thumb_meta',
'name' => esc_html__( 'Thumbnail meta field name', 'contextual-related-posts' ),
'desc' => esc_html__( 'The value of this field should contain the URL of the image and can be set in the metabox in the Edit Post screen', 'contextual-related-posts' ),
'type' => 'text',
'options' => 'post-image',
),
'scan_images' => array(
'id' => 'scan_images',
'name' => esc_html__( 'Get first image', 'contextual-related-posts' ),
'desc' => esc_html__( 'The plugin will fetch the first image in the post content if this is enabled. This can slow down the loading of your page if the first image in the followed posts is large in file-size.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => true,
),
'thumb_default_show' => array(
'id' => 'thumb_default_show',
'name' => esc_html__( 'Use default thumbnail?', 'contextual-related-posts' ),
'desc' => esc_html__( 'If checked, when no thumbnail is found, show a default one from the URL below. If not checked and no thumbnail is found, no image will be shown.', 'contextual-related-posts' ),
'type' => 'checkbox',
'options' => true,
),
'thumb_default' => array(
'id' => 'thumb_default',
'name' => esc_html__( 'Default thumbnail', 'contextual-related-posts' ),
'desc' => esc_html__( 'Enter the full URL of the image that you wish to display if no thumbnail is found. This image will be displayed below.', 'contextual-related-posts' ),
'type' => 'text',
'options' => CRP_PLUGIN_URL . 'default.png',
'size' => 'large',
),
);
/**
* Filters the Thumbnail settings array
*
* @since 2.6.0
*
* @param array $settings Thumbnail settings array
*/
return apply_filters( 'crp_settings_thumbnail', $settings );
}
/**
* Retrieve the array of Styles settings
*
* @since 2.6.0
*
* @return array Styles settings array
*/
function crp_settings_styles() {
$settings = array(
'crp_styles' => array(
'id' => 'crp_styles',
'name' => esc_html__( 'Related Posts style', 'contextual-related-posts' ),
'desc' => '',
'type' => 'radiodesc',
'default' => 'rounded_thumbs',
'options' => crp_get_styles(),
),
'custom_css' => array(
'id' => 'custom_css',
'name' => esc_html__( 'Custom CSS', 'contextual-related-posts' ),
/* translators: 1: Opening a tag, 2: Closing a tag, 3: Opening code tage, 4. Closing code tag. */
'desc' => sprintf( esc_html__( 'Do not include %3$sstyle%4$s tags. Check out the %1$sFAQ%2$s for available CSS classes to style.', 'contextual-related-posts' ), '', '', '', '' ),
'type' => 'css',
'options' => '',
'field_class' => 'codemirror_css',
),
);
/**
* Filters the Styles settings array
*
* @since 2.6.0
*
* @param array $settings Styles settings array
*/
return apply_filters( 'crp_settings_styles', $settings );
}
/**
* Retrieve the array of Feed settings
*
* @since 2.6.0
*
* @return array Feed settings array
*/
function crp_settings_feed() {
$settings = array(
'feed_options_desc' => array(
'id' => 'feed_options_desc',
'name' => '' . esc_html__( 'About this tab', 'contextual-related-posts' ) . '',
'desc' => esc_html__( 'Below options override the related posts settings for your blog feed. These only apply if you have selected to add related posts to Feeds in the General Options tab. It is recommended to not display thumbnails as there is no easy way to style the related posts in the feed.', 'contextual-related-posts' ),
'type' => 'descriptive_text',
),
'limit_feed' => array(
'id' => 'limit_feed',
'name' => esc_html__( 'Number of posts to display', 'contextual-related-posts' ),
'desc' => '',
'type' => 'number',
'options' => '5',
'min' => '0',
'size' => 'small',
),
'show_excerpt_feed' => array(
'id' => 'show_excerpt_feed',
'name' => esc_html__( 'Show post excerpt', 'contextual-related-posts' ),
'desc' => '',
'type' => 'checkbox',
'options' => false,
),
'post_thumb_op_feed' => array(
'id' => 'post_thumb_op_feed',
'name' => esc_html__( 'Location of the post thumbnail', 'contextual-related-posts' ),
'desc' => '',
'type' => 'radio',
'default' => 'text_only',
'options' => array(
'inline' => esc_html__( 'Display thumbnails inline with posts, before title', 'contextual-related-posts' ),
'after' => esc_html__( 'Display thumbnails inline with posts, after title', 'contextual-related-posts' ),
'thumbs_only' => esc_html__( 'Display only thumbnails, no text', 'contextual-related-posts' ),
'text_only' => esc_html__( 'Do not display thumbnails, only text', 'contextual-related-posts' ),
),
),
'thumb_width_feed' => array(
'id' => 'thumb_width_feed',
'name' => esc_html__( 'Thumbnail width', 'contextual-related-posts' ),
'desc' => '',
'type' => 'number',
'options' => '250',
'min' => '0',
'size' => 'small',
),
'thumb_height_feed' => array(
'id' => 'thumb_height_feed',
'name' => esc_html__( 'Thumbnail height', 'contextual-related-posts' ),
'desc' => '',
'type' => 'number',
'options' => '250',
'min' => '0',
'size' => 'small',
),
);
/**
* Filters the Feed settings array
*
* @since 2.6.0
*
* @param array $settings Feed settings array
*/
return apply_filters( 'crp_settings_feed', $settings );
}
/**
* Upgrade pre v2.5.0 settings.
*
* @since 2.6.0
* @return array Settings array
*/
function crp_upgrade_settings() {
$old_settings = get_option( 'ald_crp_settings' );
if ( empty( $old_settings ) ) {
return false;
}
// Start will assigning all the old settings to the new settings and we will unset later on.
$settings = $old_settings;
$settings['add_to'] = array();
// Convert the add_to_{x} to the new settings format.
$add_to = array(
'single' => 'add_to_content',
'page' => 'add_to_page',
'feed' => 'add_to_feed',
'home' => 'add_to_home',
'category_archives' => 'add_to_category_archives',
'tag_archives' => 'add_to_tag_archives',
'other_archives' => 'add_to_archives',
);
foreach ( $add_to as $newkey => $oldkey ) {
if ( $old_settings[ $oldkey ] ) {
$settings['add_to'][ $newkey ] = $newkey;
}
unset( $settings[ $oldkey ] );
}
// Convert 'blank_output' to the new format: true = 'blank' and false = 'custom_text'.
$settings['blank_output'] = ! empty( $old_settings['blank_output'] ) ? 'blank' : 'custom_text';
$settings['custom_css'] = $old_settings['custom_CSS'];
return $settings;
}
/**
* Get the various styles.
*
* @since 2.6.0
* @return array Style options.
*/
function crp_get_styles() {
$styles = array(
array(
'id' => 'no_style',
'name' => esc_html__( 'No styles', 'contextual-related-posts' ),
'description' => esc_html__( 'Select this option if you plan to add your own styles', 'contextual-related-posts' ) . '
',
),
array(
'id' => 'text_only',
'name' => esc_html__( 'Text only', 'contextual-related-posts' ),
'description' => esc_html__( 'Disable thumbnails and no longer include the default style sheet', 'contextual-related-posts' ) . '
',
),
array(
'id' => 'rounded_thumbs',
'name' => esc_html__( 'Rounded thumbnails', 'contextual-related-posts' ),
'description' => '
 ) . ')
' . esc_html__( 'Enabling this option will turn on the thumbnails. It will also turn off the display of the author, excerpt and date if already enabled. Disabling this option will not revert any settings.', 'contextual-related-posts' ) . '
',
),
array(
'id' => 'masonry',
'name' => esc_html__( 'Masonry', 'contextual-related-posts' ),
'description' => '
 ) . ')
' . esc_html__( 'Enables a masonry style layout similar to one made famous by Pinterest.', 'contextual-related-posts' ) . '
',
),
array(
'id' => 'grid',
'name' => esc_html__( 'Grid', 'contextual-related-posts' ),
'description' => '
 ) . ')
' . esc_html__( 'Uses CSS Grid for display. Might not work on older browsers.', 'contextual-related-posts' ) . '
',
),
array(
'id' => 'thumbs_grid',
'name' => esc_html__( 'Rounded thumbnails with CSS grid', 'contextual-related-posts' ),
'description' => '
 ) . ')
' . esc_html__( 'Uses CSS grid. It will also turn off the display of the author, excerpt and date if already enabled. Disabling this option will not revert any settings.', 'contextual-related-posts' ) . '
',
),
);
/**
* Filter the array containing the styles to add your own.
*
* @since 2.6.0
*
* @param string $styles Different styles.
*/
return apply_filters( 'crp_get_styles', $styles );
}
/**
* Get the various order settings.
*
* @since 2.8.0
* @return array Order settings.
*/
function crp_get_orderings() {
$orderings = array(
'relevance' => esc_html__( 'By relevance', 'contextual-related-posts' ),
'random' => esc_html__( 'Randomly', 'contextual-related-posts' ),
'date' => esc_html__( 'By date', 'contextual-related-posts' ),
);
/**
* Filter the array containing the order settings.
*
* @since 2.8.0
*
* @param string $orderings Order settings.
*/
return apply_filters( 'crp_get_orderings', $orderings );
}