{"id":368691,"date":"2025-10-24T10:13:01","date_gmt":"2025-10-24T04:13:01","guid":{"rendered":"https:\/\/directorist.com\/?post_type=docs&p=368691"},"modified":"2025-10-24T10:13:06","modified_gmt":"2025-10-24T04:13:06","password":"","slug":"filter-hooks","status":"publish","type":"docs","link":"https:\/\/directorist.com\/docs\/filter-hooks\/","title":{"rendered":"Filter Hooks"},"content":{"rendered":"\n

Use filters to modify data before it is displayed or saved. Add filters in a custom plugin or a child theme.<\/p>\n\n\n\n

Core Plugin Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
atbdp_right_sidebar_name<\/code><\/td>Change the default right sidebar ID used by Directorist.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
plugin_locale<\/code><\/td>Override plugin textdomain locale (global WP filter).<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_admin_template<\/code><\/td>Override the admin template base path.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_create_required_pages<\/code><\/td>Control auto-creation of required pages on setup.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
directorist_show_migration_button<\/code><\/td>Show\/hide migration button in admin.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
import_upload_size_limit<\/code><\/td>Set maximum upload size for imports (bytes).<\/td>int<\/code> \u2192 int<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Example<\/strong><\/p>\n\n\n\n

add_filter( 'directorist_show_migration_button', '__return_false' );\n<\/code><\/pre>\n\n\n\n
\n\n\n\n
Template and Display Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
atbdp_contact_listing_owner_widget_form_id<\/code><\/td>Replace contact form ID used in the \u201cContact Owner\u201d widget.<\/td>`int<\/td><\/tr>
directorist_widget_featured_listings_query_arguments<\/code><\/td>Adjust query args for Featured Listings widget.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_avatar_size<\/code><\/td>Change avatar size (px).<\/td>int<\/code> \u2192 int<\/code><\/td><\/tr>
directorist_taxonomy_category_wrapper<\/code><\/td>Add\/replace CSS classes for category wrapper.<\/td>`string<\/td><\/tr>
directorist_taxonomy_location_wrapper<\/code><\/td>Add\/replace CSS classes for location wrapper.<\/td>`string<\/td><\/tr>
directorist\/review_form\/comment_fields<\/code><\/td>Modify review form fields.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist\/review_form\/comment_form_args<\/code><\/td>Override comment_form()<\/code> args for reviews.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_payment_receipt_button_link<\/code><\/td>Change receipt button URL.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_payment_receipt_button_text<\/code><\/td>Change receipt button label.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_checkout_not_now_link<\/code><\/td>Change \u201cNot now\u201d link on checkout.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_widget_template_args<\/code><\/td>Pass variables to widget templates.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_archive_single_listing_url<\/code><\/td>Override single listing URL on archives.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
widget_title<\/code> \/ atbdp_widget_title<\/code><\/td>Filter widget titles (core + plugin).<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Example<\/strong><\/p>\n\n\n\n
add_filter( 'atbdp_avatar_size', fn( $size ) => 64 );\n<\/code><\/pre>\n\n\n\n
\n\n\n\n
Query and Data Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
`atbdp_allow_{similar<\/td>featured<\/td>search<\/td><\/tr>
atbdp_popular_listing_number<\/code><\/td>Count of popular listings to fetch.<\/td>int<\/code> \u2192 int<\/code><\/td><\/tr>
atbdp_popular_listing_args<\/code><\/td>Query args for popular listings.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_related_listing_args<\/code><\/td>Base related listings query args.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_related_listings_meta_queries<\/code><\/td>Meta query parts for related listings.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
Form and Field Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
directorist_listing_form_fields_class_map<\/code><\/td>Map field types to classes.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_section_template<\/code> \/ directorist_field_template<\/code> \/ directorist_field_admin_template<\/code><\/td>Override template paths for sections\/fields.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_form_field_data<\/code><\/td>Mutate field config before render.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_add_listing_page_template<\/code><\/td>Switch Add Listing page template.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_search_field_template<\/code><\/td>Template for search field.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_single_section_template<\/code><\/td>Template for single listing sections.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_single_section_has_contents<\/code><\/td>Control section visibility by content.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
directorist_single_listing_widget_value<\/code><\/td>Change values displayed in single widgets.<\/td>mixed<\/code> \u2192 mixed<\/code><\/td><\/tr>
directorist_single_item_template<\/code><\/td>Template for single content items.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_custom_single_listing_pre_page_content<\/code><\/td>Inject HTML before single page content.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_single_listing_social_sharing_items<\/code><\/td>Social share list.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_single_listing_slider_image_size<\/code><\/td>Image size for single slider.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_listing_price<\/code><\/td>Displayed listing price text\/value.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_the_content<\/code><\/td>Filter single listing main content.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_listing_map_info_window<\/code><\/td>Map info window HTML.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_address_in_map_info_window<\/code><\/td>Address markup inside info window.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_single_listing_map_section_text<\/code><\/td>Title\/label for map section.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_related_listing_args<\/code><\/td>Related listings args (single context).<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_archive_single_listing_url<\/code><\/td>Archive item link URL.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Example<\/strong><\/p>\n\n\n\n
add_filter( 'atbdp_listing_price', function( $price ) {\n    return $price ? $price . ' \/night' : __( 'Contact for price', 'my-textdomain' );\n});\n<\/code><\/pre>\n\n\n\n
\n\n\n\n
Dashboard and Navigation Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
directorist_dashboard_query_arguments<\/code><\/td>Change dashboard listings query.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_dashboard_tabs<\/code><\/td>Add\/remove dashboard tabs.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_dashboard_listing_action_items<\/code><\/td>Prepend action items per row.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_dashboard_listing_action_items_end<\/code><\/td>Append action items per row.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
Listings and Archive Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
atbdp_all_listings_params<\/code><\/td>Archive defaults (view, order, etc.).<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_all_listings_meta_queries<\/code><\/td>Meta queries for archive.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_all_listings_query_arguments<\/code><\/td>Final WP_Query args for archive.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_custom_fields_meta_query_args<\/code><\/td>Meta query built from custom fields.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_search_listings_meta_queries<\/code><\/td>Meta queries for search.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_listing_search_query_argument<\/code><\/td>Search query args.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_all_listings_directory_type_args<\/code><\/td>Restrict by directory type.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_map_options<\/code><\/td>JS map options object.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_listings_map_view_marker_icon<\/code><\/td>Marker icon URL\/args.<\/td>`string<\/td><\/tr>
directorist_listings_found_text<\/code><\/td>\u201cListings found\u201d label.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_loop_wrapper_class<\/code> \/ directorist_listings_wrapper_class<\/code><\/td>Add CSS classes.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
grid_view_title_link_add_attr<\/code> \/ grid_view_thumbnail_link_add_attr<\/code><\/td>Add HTML attributes to links.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_loop_label<\/code><\/td>Change loop labels\/badges.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_featured_badge_field_data<\/code><\/td>Featured badge data payload.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_listings_grid_container_fluid<\/code><\/td>Use container-fluid layout.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
directorist_listings_header_title<\/code><\/td>Archive header title.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_pagination<\/code><\/td>Pagination HTML.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_pagination_prev_text<\/code> \/ directorist_pagination_next_text<\/code><\/td>Prev\/Next labels.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
Payment and Checkout Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
atbdp_enable_monetization_checkout<\/code><\/td>Enable checkout flow.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
atbdp_checkout_form_data<\/code> \/ atbdp_checkout_form_final_data<\/code><\/td>Mutate checkout data.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_featured_active_checkout<\/code><\/td>Auto-check featured option.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
atbdp_payment_receipt_data<\/code> \/ directorist_payment_receipt_data<\/code><\/td>Receipt payload.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_order_items<\/code><\/td>Order line items.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_before_order_recipt<\/code><\/td>HTML before receipt (typo kept for back-compat).<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_order_details<\/code><\/td>Order details payload.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_order_amount_before_tax_calculation<\/code><\/td>Subtotal before tax.<\/td>float<\/code> \u2192 float<\/code><\/td><\/tr>
atbdp_order_amount<\/code><\/td>Final order amount.<\/td>float<\/code> \u2192 float<\/code><\/td><\/tr>
atbdp_payment_receipt_page_link<\/code><\/td>Receipt page URL.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_is_checkout<\/code> \/ atbdp_can_checkout<\/code><\/td>Control checkout context\/permission.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
atbdp_get_success_page_uri<\/code> \/ atbdp_is_success_page<\/code><\/td>Success page handling.<\/td>`string<\/td><\/tr>
atbdp_success_page_redirect<\/code><\/td>Custom redirect after success.<\/td>`string<\/td><\/tr>
atbdp_get_checkout_uri<\/code><\/td>Checkout URL.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_send_back_to_checkout<\/code><\/td>Redirect back to checkout.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
atbdp_get_failed_transaction_uri<\/code> \/ atbdp_is_failure_page<\/code><\/td>Failure page handling.<\/td>`string<\/td><\/tr>
atbdp_get_banned_emails<\/code> \/ atbdp_is_email_banned<\/code><\/td>Banlist control.<\/td>`array<\/td><\/tr>
atbdp_valiate_card_format_pre_type<\/code> \/ atbdp_cc_is_valid_format<\/code><\/td>Card validation logic.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
directorist_checkout_guard<\/code><\/td>Block or allow checkout programmatically.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
atbdp_cc_card_types<\/code> \/ atbdp_cc_found_card_type<\/code><\/td>Supported and detected card types.<\/td>`array<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
Currency and Payment Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
atbdp_payment_statuses<\/code><\/td>Register custom payment statuses.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_order_bulk_actions<\/code><\/td>Add bulk actions to Orders table.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_format_amount<\/code><\/td>Format money output.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_payment_currency_settings<\/code><\/td>Currency settings payload.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_currency_decimal_count<\/code><\/td>Decimal places.<\/td>int<\/code> \u2192 int<\/code><\/td><\/tr>
atbdp_{currency}_currency_filter_before<\/code> \/ atbdp_{currency}_currency_filter_after<\/code><\/td>Surround amount with currency symbol.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_currency_symbol<\/code><\/td>Override symbol (e.g., USD \u2192 $<\/code>).<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
Order and Receipt Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
atbdp_order_items_data<\/code><\/td>Normalize order items for emails\/UI.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_email_receipt_order_amount<\/code><\/td>Amount shown in email receipt.<\/td>`float<\/td><\/tr>
atbdp_add_new_order_column<\/code><\/td>Register custom column in Orders list.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_order_for<\/code><\/td>Label for \u201cOrder for\u201d field.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_{gateway}gateway_label<\/code><\/td>Gateway label text.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_order_table_shortable_colums<\/code><\/td>Sortable columns (typo kept).<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
Email and Notification Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
directorist_email_notification_to_owner_on_order_created<\/code><\/td>Toggle owner email on order created.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
directorist_notify_owner_listing_submitted<\/code><\/td>Toggle owner email on submit.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
directorist_notify_admin_listing_published<\/code><\/td>Toggle admin email on publish.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
directorist_notify_owner_listing_published<\/code><\/td>Toggle owner email on publish.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
directorist_notify_owner_listing_to_expire<\/code><\/td>Toggle pre-expiry email.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
directorist_notify_owner_listing_expired<\/code><\/td>Toggle expired email.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
directorist_notify_owner_to_renew<\/code><\/td>Toggle renewal email.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
directorist_notify_admin_listing_submitted<\/code><\/td>Toggle admin email on submit.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
directorist_email_verification_title<\/code><\/td>Change email verification subject.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
Directory and Taxonomy Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
directorist_category_page_redirection_enabled<\/code><\/td>Enable redirect from category to directory.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
cptm_fields_before_update<\/code><\/td>Mutate fields before save (builder).<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_builder_localize_data<\/code><\/td>Data passed to builder scripts.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_test_migration<\/code><\/td>Control test migration UI.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
directorist_builder\/fields<\/code> \/ directorist_builder\/layouts<\/code> \/ directorist\/builder\/config<\/code><\/td>Extend builder registry\/config.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
12) Import and Migration Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
atbdp_listing_import_limit_per_cycle<\/code><\/td>Batch size for importer.<\/td>int<\/code> \u2192 int<\/code><\/td><\/tr>
directorist_importing_listings_post_date<\/code><\/td>Set post date during import.<\/td>`string<\/td><\/tr>
directorist_listing_imported<\/code><\/td>Alter payload after each import.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_legacy_attachment_importer<\/code><\/td>Toggle legacy attachment importer.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
directorist_listings_importer_header_nav_menu<\/code><\/td>Add header nav items in importer.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_importable_fields<\/code><\/td>Register importable fields map.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_listings_importer_default_time_limit<\/code><\/td>Time limit per cycle (seconds).<\/td>int<\/code> \u2192 int<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
Template and URI Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
directorist_template_directory<\/code> \/ directorist_template_file_path<\/code><\/td>Control template resolution.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_ext_template_path_{shortcode_key}<\/code><\/td>Custom template for a shortcode.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_template<\/code><\/td>Final template HTML.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_container<\/code> \/ directorist_container_fluid<\/code> \/ directorist_row<\/code> \/ directorist_column<\/code><\/td>CSS class names for layout grid.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
Widget and Display Filters<\/h2>\n\n\n\n
(Also listed earlier under \u201cTemplate and Display\u201d for visibility)<\/p>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
atbdp_widget_template_args<\/code><\/td>Data passed to widgets.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
`atbdp_allow_{similar<\/td>featured<\/td>search<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
Review and Comment Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
directorist\/review\/rating_html<\/code><\/td>Replace rating HTML.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_comment_edit_link<\/code><\/td>Edit link for comments.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist\/review\/comments_open<\/code><\/td>Allow\/disallow review comments.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
directorist\/review\/preprocess_comment_data<\/code><\/td>Sanitize\/reshape comment data.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_comment_form_default_fields<\/code><\/td>Default comment fields.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_comment_form_defaults<\/code><\/td>comment_form()<\/code> defaults.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_comment_form_logged_in<\/code><\/td>Logged-in message HTML.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_comment_form_fields<\/code><\/td>Entire fields array.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_comment_form_field_comment<\/code><\/td>Main comment field HTML.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
comment_form_field_{name}<\/code><\/td>One field by key.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_comment_form_submit_button<\/code> \/ directorist_comment_form_submit_field<\/code><\/td>Submit button markup\/field.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_review_date_format<\/code><\/td>Date format for reviews.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
System and Configuration Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
directorist_has_block_template<\/code><\/td>Use a block template for single.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
directorist_listings_export_submission_form_fields_row<\/code> \/ directorist_listings_export_row<\/code><\/td>CSV export shaping.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_single_listing_header_migration_data<\/code><\/td>Header migration mapping.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_*_page_url<\/code> family (login, register, dashboard, add listing, fee plan, privacy, terms, edit, category\/location\/tag archives, receipt, checkout, renewal, PayPal IPN, author profile, search, listings, transaction failure)<\/td>Override critical URLs.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
atbdp_current_page_url<\/code><\/td>Current page URL.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
`atbdp_single_{category<\/td>location<\/td>tag}`<\/td><\/tr>
directorist_page_id<\/code><\/td>Resolve page IDs by key.<\/td>int<\/code> \u2192 int<\/code><\/td><\/tr>
directorist_password_reset_url<\/code><\/td>Password reset link.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_date_format<\/code> \/ directorist_time_format<\/code><\/td>Date\/time formats.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
`atbdp_search_listing_{category<\/td>location}_argument`<\/td>Search taxonomy args.<\/td><\/tr>
directorist_warnings<\/code><\/td>Admin warnings array.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_get_directory_type_nav_url<\/code><\/td>Directory type nav URLs.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
directorist_add_query_args_with_no_pagination<\/code><\/td>Append query args when removing pagination.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_registration_error_messages<\/code><\/td>Register error messages.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_supported_file_types_groups<\/code><\/td>Allowed file type groups.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_user_favorites<\/code><\/td>Favorites list for a user.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_get_allowed_attributes<\/code> \/ directorist_get_allowed_html<\/code><\/td>KSES allowlists.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
Elementor and Builder Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
directorist_all_listings_elementor_widget_atts<\/code><\/td>Default atts for All Listings widget.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_elementor_widgets<\/code><\/td>Register Elementor widgets.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
atbdp_elementor_widgets_activated<\/code><\/td>Toggle widgets active.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
Appsero and Licensing Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
appsero_endpoint<\/code><\/td>Change Appsero endpoint.<\/td>string<\/code> \u2192 string<\/code><\/td><\/tr>
appsero_is_local<\/code><\/td>Treat site as local for Appsero.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
appsero_custom_deactivation_reasons<\/code><\/td>Add deactivation reasons.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
Background Process Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
{identifier}_queue_lock_time<\/code> \/ {identifier}_default_time_limit<\/code> \/ {identifier}_time_exceeded<\/code><\/td>Control batch processor timings.<\/td>`int<\/td><\/tr>
{identifier}_memory_exceeded<\/code><\/td>Memory guard.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr>
{identifier}_cron_interval<\/code><\/td>Custom cron interval.<\/td>`int<\/td><\/tr>
{identifier}_query_args<\/code> \/ {identifier}_query_url<\/code> \/ {identifier}_post_args<\/code><\/td>Remote request shaping.<\/td>`array<\/td><\/tr>
https_local_ssl_verify<\/code><\/td>SSL verify for local HTTP API calls.<\/td>bool<\/code> \u2192 bool<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
Schema and Configuration Filters<\/h2>\n\n\n\n
Hook<\/th>Purpose<\/th>Expected \/ Return<\/th><\/tr><\/thead>
directorist_schema_types<\/code><\/td>Register structured data types.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr>
directorist_system_status_environment_rows<\/code><\/td>Add rows to system status.<\/td>array<\/code> \u2192 array<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n\n\n\n
Notes<\/h3>\n\n\n\n
    \n
  • Some hooks include historic typos (e.g.,\u00a0recipt<\/code>,\u00a0shortable_colums<\/code>) kept for backward compatibility. Use them exactly as listed by the plugin you are targeting.<\/li>\n\n\n\n
  • When a hook appears in more than one section (for clarity), it is the same filter.<\/li>\n<\/ul>\n\n\n\n
    \n","protected":false},"excerpt":{"rendered":"
    Use filters to modify data before it is displayed or saved. Add filters in a custom plugin or a child theme. Core Plugin Filters Hook Purpose Expected \/ Return atbdp_right_sidebar_name Change the default right sidebar ID used by Directorist. string \u2192 string plugin_locale Override plugin textdomain locale (global WP filter). string \u2192 string directorist_admin_template Override the admin template base […]<\/p>\n","protected":false},"author":24585,"featured_media":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"doc_category":[699],"doc_tag":[],"class_list":["post-368691","docs","type-docs","status-publish","hentry","doc_category-developers-doc"],"year_month":"2026-03","word_count":2155,"total_views":0,"reactions":{"happy":0,"normal":0,"sad":0},"author_info":{"name":"yousuf.sovware","author_nicename":"yousuf-sovware","author_url":"https:\/\/directorist.com\/author\/yousuf-sovware\/"},"doc_category_info":[{"term_name":"Developers Doc","term_url":"https:\/\/directorist.com\/docs-category\/developers-doc\/"}],"doc_tag_info":[],"_links":{"self":[{"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/docs\/368691","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/users\/24585"}],"replies":[{"embeddable":true,"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/comments?post=368691"}],"version-history":[{"count":0,"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/docs\/368691\/revisions"}],"wp:attachment":[{"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/media?parent=368691"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/doc_category?post=368691"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/doc_tag?post=368691"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}