Yet-Another-Stars-Rating/yasr_hooks.md at master · Dudo1985/Yet-Another-Stars-Rating

Argument	Type	Description
$shortcode_html	string	html for the shortcode
$stored_votes	array	array with average rating data for the post id.
$this->post_id	int	the post id
$stored_votes	YasrDB::visitorVotes()	array

`apply_filters('yasr_vv_cookie')`

Source: ../includes/shortcodes/classes/YasrVisitorVotes.php, line 130

Use this filter to customize the visitor votes cookie name

Argument	Type	Description
	string	yasr_visitor_votes_cookie is the default name

`apply_filters('yasr_cstm_text_already_voted')`

Source: ../includes/shortcodes/classes/YasrVisitorVotes.php, line 209

Use this filter to customize the text "You have already voted for this article with rating %rating%"

Unless you're using a multi-language site, there is no need to use this hook; you can customize this in

"General Settings" -> "Custom text to display when an user has already rated"

`apply_filters('yasr_must_sign_in')`

Source: ../includes/shortcodes/classes/YasrVisitorVotes.php, line 226

Use this filter to customize the text "you must sign in"

Unless you're using a multi-language site, there is no need to use this hook; you can customize this in

"General Settings" -> "Custom text to display when login is required to vote"

`apply_filters('yasr_cstm_text_before_vv')`

Source: ../includes/shortcodes/classes/YasrVisitorVotes.php, line 261

Use this filter to customize text before visitor rating.

Unless you're using a multi-language site, there is no need to use this hook; you can customize this in

"General Settings" -> "Custom text to display BEFORE Visitor Rating"

Argument	Type	Description
$number_of_votes	int	the total number of votes
$average_rating	float	the average rating
$this->unique_id	string	the dom ID

`apply_filters('yasr_cstm_text_after_vv')`

Source: ../includes/shortcodes/classes/YasrVisitorVotes.php, line 317

Use this filter to customize text after visitor rating.

Unless you're using a multi-language site, there is no need to use this hook; you can customize this in

"General Settings" -> "Custom text to display AFTER Visitor Rating"

Argument	Type	Description
$number_of_votes	int	the total number of votes
$average_rating	float	the average rating
$this->unique_id	string	the dom ID

`apply_filters('yasr_vv_shortcode')`

Source: ../includes/shortcodes/classes/YasrVisitorVotes.php, line 433

Use this filter to customize the yasr_visitor_votes shortcode

Argument	Type	Description
$shortcode_html	string	html for the shortcode
$this->post_id	int	the post id
$this->starSize	string	() the star size
$this->readonly	string	is the stars are readonly or not
$this->ajax_nonce_visitor	string	the WordPress nonce
$this->is_singular	string	if the current page is_singular or not

`apply_filters('yasr_seconds_between_ratings')`

Source: ../includes/yasr-includes-defines.php, line 34

`apply_filters('yasr_filter_ip')`

Source: ../includes/yasr-includes-functions.php, line 156

`apply_filters('yasr_auto_insert_disable')`

Source: ../public/classes/YasrPublicFilters.php, line 62

`apply_filters('yasr_auto_insert_exclude_cpt')`

Source: ../public/classes/YasrPublicFilters.php, line 92

`apply_filters('yasr_title_vv_widget')`

Source: ../public/classes/YasrPublicFilters.php, line 276

`apply_filters('yasr_title_overall_widget')`

Source: ../public/classes/YasrPublicFilters.php, line 313

`apply_filters('yasr_filter_schema_jsonld')`

Source: ../public/classes/YasrRichSnippets.php, line 77

Use this hook to write your custom microdata from scratch

Argument	Type	Description
$item_type_for_post	string	the itemType selected for the post

`apply_filters('yasr_filter_existing_schema')`

Source: ../public/classes/YasrRichSnippets.php, line 191

`apply_filters('yasr_filter_schema_title')`

Source: ../public/classes/YasrRichSnippets.php, line 223

`do_action('yasr_display_posts_top')`

Source: ../templates/content.php, line 28

hook here to add content at the beginning of yasr_display_posts

`do_action('yasr_display_posts_bottom')`

Source: ../templates/content.php, line 61

hook here to add content at the end of yasr_display_posts

`do_action('yasr_ur_add_custom_form_fields')`

Source: ../yasr_pro/public/classes/YasrProCommentForm.php, line 170

`apply_filters('yasr_ur_display_custom_fields')`

Source: ../yasr_pro/public/classes/YasrProCommentForm.php, line 284

`do_action('yasr_ur_save_custom_form_fields')`

Source: ../yasr_pro/public/classes/YasrProCommentForm.php, line 496

`do_action('yasr_ur_do_content_after_save_commentmeta')`

Source: ../yasr_pro/public/classes/YasrProCommentForm.php, line 505

`do_action('yasr_fs_loaded')`

Source: ../yet-another-stars-rating.php, line 82

Yet-Another-Stars-Rating/docs/yasr_hooks.md

do_action('yasr_add_admin_scripts_begin')

do_action('yasr_add_admin_scripts_end')

do_action('yasr_add_tabs_on_tinypopupform')

do_action('yasr_add_content_on_tinypopupform')

do_action('yasr_metabox_below_editor_add_tab')

do_action('yasr_metabox_below_editor_content')

do_action('yasr_add_content_multiset_tab_top')

do_action('yasr_add_content_multiset_tab_pro')

do_action('yasr_on_save_post')

do_action('yasr_action_on_overall_rating')

do_action('yasr_add_content_bottom_topright_metabox')

do_action('yasr_add_settings_tab')

do_action('yasr_settings_tab_content')

do_action('yasr_right_settings_panel_box')

apply_filters('yasr_settings_select_ranking')

apply_filters('yasr_filter_style_options')

do_action('yasr_style_options_add_settings_field')

apply_filters('yasr_sanitize_style_options')

do_action('yasr_add_stats_tab')

apply_filters('yasr_export_box_button')

do_action('yasr_export_box_end')

do_action('yasr_migration_page_bottom')

do_action('yasr_stats_tab_content')

apply_filters('yasr_feature_locked')

apply_filters('yasr_feature_locked_html_attribute')

apply_filters('yasr_feature_locked_text')

apply_filters('yasr_rankings_query_ov')

apply_filters('yasr_rankings_query_vv')

apply_filters('yasr_rankings_query_tu')

apply_filters('yasr_rankings_multi_query')

apply_filters('yasr_rankings_query_tr')

apply_filters('yasr_rankings_multivv_query')

apply_filters('yasr_user_rate_history_must_login_text')

apply_filters('yasr_filter_itemtypes')

apply_filters('yasr_filter_itemtypes_fields')

apply_filters('yasr_custom_loader')

apply_filters('yasr_custom_loader_url')

do_action('yasr_add_front_script_css')

do_action('yasr_add_front_script_js')

apply_filters('yasr_gutenberg_constants')

apply_filters('yasr_rest_rankings_args')

apply_filters('yasr_rest_sanitize')

apply_filters('yasr_tr_rankings_atts')

apply_filters('yasr_tu_rankings_atts')

apply_filters('yasr_tu_rankings_display')

apply_filters('yasr_overall_rating_shortcode')

apply_filters('yasr_cstm_text_before_overall')

apply_filters('yasr_ov_rankings_atts')

apply_filters('yasr_vv_rankings_atts')

apply_filters('yasr_multi_set_ranking_atts')

apply_filters('yasr_visitor_multi_set_ranking_atts')

apply_filters('yasr_size_ranking')

do_action('yasr_enqueue_assets_shortcode')

do_action('yasr_action_on_visitor_vote')

apply_filters('yasr_vv_cookie')

apply_filters('yasr_vv_updated_text')

apply_filters('yasr_vv_saved_text')

apply_filters('yasr_vv_rating_error_text')

do_action('yasr_action_on_visitor_multiset_vote')

apply_filters('yasr_mv_cookie')

apply_filters('yasr_mv_saved_text')

apply_filters('yasr_filter_ranking_request')

apply_filters('yasr_add_sources_ranking_request')

apply_filters('yasr_mv_cookie')

apply_filters('yasr_must_sign_in')

apply_filters('yasr_vv_ro_shortcode')

apply_filters('yasr_vv_cookie')

apply_filters('yasr_cstm_text_already_voted')

apply_filters('yasr_must_sign_in')

apply_filters('yasr_cstm_text_before_vv')

apply_filters('yasr_cstm_text_after_vv')

apply_filters('yasr_vv_shortcode')

apply_filters('yasr_seconds_between_ratings')

apply_filters('yasr_filter_ip')

apply_filters('yasr_auto_insert_disable')

apply_filters('yasr_auto_insert_exclude_cpt')

apply_filters('yasr_title_vv_widget')

apply_filters('yasr_title_overall_widget')

apply_filters('yasr_filter_schema_jsonld')

`do_action('yasr_add_admin_scripts_begin')`

`do_action('yasr_add_admin_scripts_end')`

`do_action('yasr_add_tabs_on_tinypopupform')`

`do_action('yasr_add_content_on_tinypopupform')`

`do_action('yasr_metabox_below_editor_add_tab')`

`do_action('yasr_metabox_below_editor_content')`

`do_action('yasr_add_content_multiset_tab_top')`

`do_action('yasr_add_content_multiset_tab_pro')`

`do_action('yasr_on_save_post')`

`do_action('yasr_action_on_overall_rating')`

`do_action('yasr_add_content_bottom_topright_metabox')`

`do_action('yasr_add_settings_tab')`

`do_action('yasr_settings_tab_content')`

`do_action('yasr_right_settings_panel_box')`

`apply_filters('yasr_settings_select_ranking')`

`apply_filters('yasr_filter_style_options')`

`do_action('yasr_style_options_add_settings_field')`

`apply_filters('yasr_sanitize_style_options')`

`do_action('yasr_add_stats_tab')`

`apply_filters('yasr_export_box_button')`

`do_action('yasr_export_box_end')`

`do_action('yasr_migration_page_bottom')`

`do_action('yasr_stats_tab_content')`

`apply_filters('yasr_feature_locked')`

`apply_filters('yasr_feature_locked_html_attribute')`

`apply_filters('yasr_feature_locked_text')`

`apply_filters('yasr_rankings_query_ov')`

`apply_filters('yasr_rankings_query_vv')`

`apply_filters('yasr_rankings_query_tu')`

`apply_filters('yasr_rankings_multi_query')`

`apply_filters('yasr_rankings_query_tr')`

`apply_filters('yasr_rankings_multivv_query')`

`apply_filters('yasr_user_rate_history_must_login_text')`

`apply_filters('yasr_filter_itemtypes')`

`apply_filters('yasr_filter_itemtypes_fields')`

`apply_filters('yasr_custom_loader')`

`apply_filters('yasr_custom_loader_url')`

`do_action('yasr_add_front_script_css')`

`do_action('yasr_add_front_script_js')`

`apply_filters('yasr_gutenberg_constants')`

`apply_filters('yasr_rest_rankings_args')`

`apply_filters('yasr_rest_sanitize')`

`apply_filters('yasr_tr_rankings_atts')`

`apply_filters('yasr_tu_rankings_atts')`

`apply_filters('yasr_tu_rankings_display')`

`apply_filters('yasr_overall_rating_shortcode')`

`apply_filters('yasr_cstm_text_before_overall')`

`apply_filters('yasr_ov_rankings_atts')`

`apply_filters('yasr_vv_rankings_atts')`

`apply_filters('yasr_multi_set_ranking_atts')`

`apply_filters('yasr_visitor_multi_set_ranking_atts')`

`apply_filters('yasr_size_ranking')`

`do_action('yasr_enqueue_assets_shortcode')`

`do_action('yasr_action_on_visitor_vote')`

`apply_filters('yasr_vv_cookie')`

`apply_filters('yasr_vv_updated_text')`

`apply_filters('yasr_vv_saved_text')`

`apply_filters('yasr_vv_rating_error_text')`

`do_action('yasr_action_on_visitor_multiset_vote')`

`apply_filters('yasr_mv_cookie')`

`apply_filters('yasr_mv_saved_text')`

`apply_filters('yasr_filter_ranking_request')`

`apply_filters('yasr_add_sources_ranking_request')`

`apply_filters('yasr_mv_cookie')`

`apply_filters('yasr_must_sign_in')`

`apply_filters('yasr_vv_ro_shortcode')`

`apply_filters('yasr_vv_cookie')`

`apply_filters('yasr_cstm_text_already_voted')`

`apply_filters('yasr_must_sign_in')`

`apply_filters('yasr_cstm_text_before_vv')`

`apply_filters('yasr_cstm_text_after_vv')`

`apply_filters('yasr_vv_shortcode')`

`apply_filters('yasr_seconds_between_ratings')`

`apply_filters('yasr_filter_ip')`

`apply_filters('yasr_auto_insert_disable')`

`apply_filters('yasr_auto_insert_exclude_cpt')`

`apply_filters('yasr_title_vv_widget')`

`apply_filters('yasr_title_overall_widget')`

`apply_filters('yasr_filter_schema_jsonld')`

`apply_filters('yasr_filter_existing_schema')`