Document all actions and filters in-line.

[tw2113]

Lets get some actions/filters documentation in place for anyone poking through the code directly, instead of relying on potentially realizing https://github.com/WebDevStudios/wp-search-with-algolia/wiki/Filter-Hooks and https://github.com/WebDevStudios/wp-search-with-algolia/wiki/Action-Hooks exist

[tw2113]

Going to exclude the 2 from the template files to avoid any need to bump version numbers there.

[tw2113]

Filters

file	filters
includes/indices/class-algolia-index.php	algolia_should_force_settings_update, algolia_indexing_batch_size, algolia_' . $this->get_id() . '_indexing_batch_size, algolia_index_replicas, algolia_' . $this->get_id() . '_index_replicas
includes/indices/class-algolia-posts-index.php	algolia_should_index_post, algolia_post_content, algolia_post_records, algolia_post_' . $post->post_type . '_records, algolia_post_shared_attributes, algolia_post_' . $post->post_type . '_shared_attributes, algolia_posts_index_settings, algolia_posts_' . $this->post_type . '_index_settings, algolia_posts_index_synonyms, algolia_posts_' . $this->post_type . '_index_synonyms
includes/indices/class-algolia-terms-index.php	algolia_should_index_term, algolia_term_record, algolia_term_' . $item->taxonomy . '_record, algolia_terms_index_settings, algolia_terms_' . $this->taxonomy . '_index_settings, algolia_terms_index_synonyms
includes/indices/class-algolia-searchable-posts-index.php	algolia_should_index_searchable_post, algolia_searchable_post_content, algolia_searchable_post_records, algolia_searchable_post_' . $post->post_type . '_records, algolia_searchable_post_shared_attributes, algolia_searchable_post_' . $post->post_type . '_shared_attributes, algolia_searchable_posts_index_settings, algolia_searchable_posts_index_synonyms
includes/indices/class-algolia-users-index.php	algolia_should_index_user, algolia_user_record, algolia_users_index_settings, algolia_users_index_synonyms
includes/class-algolia-autocomplete-config.php	algolia_autocomplete_config
includes/class-algolia-plugin.php	algolia_searchable_post_types, algolia_indices, algolia_changes_watchers
includes/class-algolia-template-loader.php	algolia_autocomplete_input_selector, algolia_config
includes/class-algolia-settings.php	algolia_get_synced_indices_ids, algolia_excluded_taxonomies, algolia_should_override_search_with_instantsearch, algolia_native_search_index_id
includes/class-algolia-search.php	algolia_search_order_by, algolia_search_order, algolia_search_highlighting_enable_bundled_styles, algolia_search_highlighting_enabled
includes/utilities/class-algolia-template-utils.php	algolia_custom_template_location
includes/factories/class-algolia-search-client-factory.php	algolia_ua_integration_name, algolia_ua_integration_version
includes/class-algolia-utils.php	algolia_post_images_sizes, algolia_get_post_images, algolia_strip_patterns
includes/watchers/class-algolia-user-changes-watcher.php	algolia_watch_user_meta_keys
includes/watchers/class-algolia-term-changes-watcher.php	algolia_watch_term_meta_keys
includes/watchers/class-algolia-post-changes-watcher.php	algolia_watch_post_meta_keys

Action hooks

file	hooks
includes/indices/class-algolia-index.php	algolia_before_get_records, algolia_after_get_records, algolia_re_indexed_items, algolia_de_indexed_items
includes/indices/class-algolia-posts-index.php	algolia_posts_index_post_updated, algolia_posts_index_post_' . $post->post_type . '_updated
includes/indices/class-algolia-searchable-posts-index.php	algolia_searchable_posts_index_post_updated, algolia_searchable_posts_index_post_' . $post->post_type . '_updated
includes/class-algolia-template-loader.php	algolia_autocomplete_scripts, algolia_instantsearch_scripts

[tw2113]

See branch feature/363-action-filter-docs

[tw2113]

@asharirfan since this is going to be all comments, do you have any feelings against the idea of getting this as part of a potential 2.6.2 release? or would you prefer it be held until 2.7.0?