/indexer/index_object This filter is called before a facet object (post, term or user) is indexed. It allows to bypass the default index system by returning a custom array holding at least one row (to insert in the index table) with a facet_value and facet_name. If an empty value is set to the facet_value , row…
/card/attributes This filter is called before a card is lay out. It allows to modify card attributes like the number of columns or rows, content_background, overlay_background, content_color_scheme, overlay_color_scheme or class Argument Type Description $atts array Holds card attributes $card object Holds card layout (layers/blocks) definition [pastacode lang=”php” manual=”function%20prefix_card_attributes(%20%24atts%2C%20%24card%20)%20%7B%0A%0A%09%2F%2F%20We%20get%20post%20in%20the%20custom%20loop%20of%20the%20plugin.%20%0A%09%24post%20%3D%20wpgb_get_post()%3B%0A%0A%09%2F%2F%20If%20current%20post%20ID%20is%20equal%20to%201%2C%20change%20number%20of%20rows%2Fcolumns.%20%0A%09if%20(%201%20%3D%3D%3D%20%24post-%3EID%20)%20%7B%20%0A%0A%09%09%24atts%5B’rows’%5D%20%3D%201%3B%0A%09%09%24atts%5B’columns’%5D%20%3D%202%3B%0A%09%0A%09%7D%0A%0A%09return%20%24atts%3B%0A%0A%7D%0A%0Aadd_filter(%20’wp_grid_builder%2Fcard%2Fattributes’%2C%20’prefix_card_attributes’%2C%2010%2C%202%20)%3B” message=”” highlight=”” provider=”manual”/]
/facet/search_query_args This filter is called before the search facet query object ids (posts, terms, users). It allows to modifies the search query arguments made by WP_Query, WP_Term_Query or WP_User_Query Argument Type Description $query array Holds search query args $facet array Holds facet settings [pastacode lang=”php” manual=”function%20prefix_search_query_args(%20%24query_args%2C%20%24facet%20)%20%7B%0A%0A%0A%09%2F%2F%20We%20exclude%20post%20IDs%20from%20search%20if%20facet%20ID%20is%20equal%20to%201.%0A%09if%20(%201%20%3D%3D%3D%20%24facet%5B’id’%5D%20)%20%7B%0A%09%09%24query_args%5B’post__not_in’%5D%20%3D%20%5B%201%2C%202%2C%203%2C%204%20%5D%3B%0A%09%7D%0A%09%0A%09return%20%24query_args%3B%0A%09%0A%7D%0A%0Aadd_filter(%20’wp_grid_builder%2Ffacet%2Fsearch_query_args’%2C%20’prefix_search_query_args’%2C%2010%2C%202%20)%3B” message=”” highlight=”” provider=”manual”/]
/grid/inline_script This filter is called once the inline JavaScript of all grids in a page is generated. It allows to change the inline script or to completely remove it if you want more control or initialize grids from your own script. Argument Type Description $script string Inline JavaScript of grids [pastacode lang=”php” manual=”function%20prefix_inline_script(%20%24script%20)%20%7B%0A%09%2F%2F%20We%20prevent%20initialization%20of%20grids%20in%20page.%0A%09return%20”%3B%0A%0A%7D%0A%0Aadd_filter(%20’wp_grid_builder%2Fgrid%2Finline_script’%2C%20’prefix_inline_script’%2C%2010%2C%201%20)%3B” message=”” highlight=””…
JS Methods JS Methods are actions done by the plugin. Public methods allows to trigger an action programmatically and at any time. Methods can be set directly in your grid settings or in your own JS script. All Method examples presented in this documentation can be directly applied in your grid settings under customization tab…
/cron/max_execution_time This filter is called everytime the indexer start a cron process. It allows to modifies the max_execution_time (in seconds) of the cron indexer. The cron system of the plugin will frequently check, when indexing, if the server max_execution_time is not reached at a certain rate (80%). It prevents to break the indexer if this…
/indexer/row This filter is called before a row is inserted into the index table. It allows to modifies properties of a row like the facet_value and facet_name This filter should not be used to query a facet value but simply used to modify it (like formatting a date). To setup rows and facet values you…
/facet/html This filter is called before to display a facet on render or refresh. It allows to modifies the output of facets. Argument Type Description $html string Facet HTML markup $facet_id integer Facet id [pastacode lang=”php” manual=”function%20prefix_facet_html(%20%24html%2C%20%24facet_id%20)%20%7B%0A%0A%09%2F%2F%20If%20it%20matches%20facet%20id%201%2C%20we%20replace%20string%20in%20facet%20HTML.%20%0A%09if%20(%201%20%3D%3D%3D%20%24facet_id%20)%20%7B%20%24html%20%3D%20str_replace(%20’Facet%20string’%2C%20’Another%20string’%2C%20%24html%20)%3B%0A%0A%09%7D%0A%0A%09return%20%24html%3B%0A%0A%7D%0A%0Aadd_filter(%20’wp_grid_builder%2Ffacet%2Fhtml’%2C%20’prefix_facet_html’%2C%2010%2C%202%20)%3B” message=”” highlight=”” provider=”manual”/]
/grid/the_object This filter is called when an object (post, term or user) has been setup in the loop after the WP_Query, WP_Term_Query or WP_User_Query It allows to modifies object properties like the title, excerpt, etc… Argument Type Description $object object Holds current object data in the loop (title, excerpt, etc…) [pastacode lang=”php” manual=”function%20prefix_object_data(%20%24object%20)%20%7B%0A%0A%09%2F%2F%20We%20get%20attachment%20object%20properties%20from%20a%20custom%20field.%20%0A%09%24attachment%20%3D%20get_post_meta(%20%24object-%3EID%2C%20’my_custom_attachment’%2C%20true%20)%3B%0A%09%09%0A%09%2F%2F%20We%20override%20post%20thumbnail%20(custom%20property%20of%20the%20plugin).%20%0A%09%24object-%3Epost_thumbnail%20%3D%20%5B%0A%09’alt’%20%3D%3E%20%24attachment-%3Ealt%2C%0A%09’title’%20%3D%3E%20%24attachment-%3Etitle%2C%0A%09’caption’%20%3D%3E%20%24attachment-%3Ecaption%2C%0A%09’description’%20%3D%3E%20%24attachment-%3Edescription%2C%20%0A%09’mime_type’%20%3D%3E%20’image’%2C%0A%09’sizes’%20%3D%3E%20%5B%20%0A%09%09’thumbnail’%20%3D%3E%20%5B%20%0A%09%09%09’url’%20%3D%3E%20%24attachment-%3Ethumbnail_url%2C%20%0A%09%09%09’width’%20%3D%3E%20%24attachment-%3Ethumbnail_width%2C%0A%09%09%09’height’%20%3D%3E%20%24attachment-%3Ethumbnail_height%2C%0A%09%09%09%5D%2C%0A%09%09’lightbox’%20%3D%3E%20%5B%0A%09%09%09’url’%20%3D%3E%20%24attachment-%3Elightbox_url%2C%0A%09%09%09%5D%2C%0A%09%09%5D%2C%0A%09%5D%3B%0A%09%0A%09return%20%24object%3B%0A%09%0A%7D%0A%0Aadd_filter(%20’wp_grid_builder%2Fgrid%2Fthe_object’%2C%20’prefix_object_data’%2C%2010%2C%201%20)” message=”” highlight=””…
/grid/loaders This filter allows to add custom loaders to display when a grid is filtered. Argument Type Description $loaders array Holds registered grid loaders [pastacode lang=”php” manual=”function%20prefix_register_grid_loaders(%20%24loaders%20)%20%7B%0A%0A%09%2F%2F%20’my_loader’%20corresponds%20to%20the%20loader%20slug.%20%0A%09%24loaders%5B’my_loader’%5D%20%3D%20%5B%20%0A%09%09’name’%20%3D%3E%20__(%20’Loading…’%2C%20’text-domain’%20)%2C%0A%09%09’html’%20%3D%3E%20’%3Cdiv%20class%3D%22loading-text%22%3E’%20.%20esc_html__(%20’Loading…’%2C%20’text-domain’%20)%20.%20’%3C%2Fdiv%3E’%2C%20%0A%09%09’css’%20%3D%3E%20’%40keyframes%20loading-animation%7B0%25%7Bopacity%3A1%7D50%25%7Bopacity%3A0%7D100%25%7Bopacity%3A1%7D%7D.my_loader%7Bdisplay%3Aflex%3Balign-items%3Acenter%3Bjustify-content%3Acenter%7D.loading-text%7Bfont-weight%3A600%3Bfont-size%3A14px%3Bbackground%3A0%200!important%3Banimation%3Aloading-animation%201s%20infinite%7D’%2C%20%0A%09%5D%3B%0A%09%0A%09return%20%24loaders%3B%0A%0A%7D%0A%0Aadd_filter(%20’wp_grid_builder%2Fgrid%2Floaders’%2C%20’prefix_register_grid_loaders’%2C%2010%2C%201%20)%3B” message=”” highlight=”” provider=”manual”/]
EN 
NL