Docs / API & Plugin Development / Hummingbird API Docs
Hummingbird API Docs

2. Hummingbird API Docs

Written by Anton Vanyukov & Patrick Cohen | Last updated: October 28, 2020
Actions
Advanced Tools – Database Cleanup
Action: wphb_delete_db_data
/core/modules/class-module-advanced.php
Performance Test – Reporting
Action: wphb_get_performance_report
/core/modules/class-module-performance.php
Caching – Page Cache
Action: wphb_clear_page_cache
/core/modules/class-module-page-cache.php
Filters
Disable minification
Filter: wp_hummingbird_is_active_module_minify’, ‘__return_false
Page Caching – Clear custom terms
Filter: wphb_page_cache_custom_terms
REST API
Module status endpoint
Endpoint: /status/(?P[\\w-]+)
Clear cache endpoint
Endpoint: /clear_cache/(?P[\\w-]+)

2.1 Action: wphb_delete_db_data

Copy chapter anchor to clipboard

Description

Can be used to run certain actions or configure notifications for database cleanup actions. Will fire after the database cleanup task in Advanced Tools – Database Cleanup.

Usage

add_action( ‘wphb_delete_db_data’, ‘database_cleanup’, 10, 2 );

Parameters

$type
String
Data type that was cleared from the database. Can return following values: all, revisions, drafts, trash, spam, trash_comment, expired_transients, transients.
$items
Integer
Number of items that was cleared from the database for the selected data type.

Example

Loading gist pcwriter/373f128cd396260798a72a2ebd1748b2

2.2 Action: wphb_get_performance_report

Copy chapter anchor to clipboard

Description

Will fire after Hummingbird fetches the latest Performance report.

Usage

add_action( ‘wphb_get_performance_report’, ‘performance_report’ );

Parameters

$report
Object
Report data object. Contains id, time, url, score, score_class, title, response_code, page_stats and rule_result objects from the Page Speed report (see https://developers.google.com/speed/docs/insights/v4/reference/pagespeedapi/runpagespeed for a better description about the report format).

Example

Loading gist pcwriter/f4c3cf8d45e8e569a584afc15ee5b812

2.3 Action: wphb_clear_page_cache

Copy chapter anchor to clipboard

Description

Allows to clear the page cache.

Usage

do_action( ‘wphb_clear_page_cache’, $page_id );

Parameters

$page_id
Integer
Optional parameter. ID of the page/post to clear the cache for. If not set, will clear all the cache.

Example

Loading gist pcwriter/9560897f229d4102a7f8d5b319986c7c

2.4 Filter: wp_hummingbird_is_active_module_minify', '__return_false

Copy chapter anchor to clipboard

Description

Disables minification when Hummingbird is active.

Example

For example, if you want to disable minification for a post page with an ID=24, you can add the following to the functions.php file:

Loading gist pcwriter/a29fbc65e9ae2d8b3b5b51b3e42fa6ee

2.5 Filter: wphb_page_cache_custom_terms

Copy chapter anchor to clipboard

Description

Allows to clear custom terms on page/post update

Example

For example, this filter can be used to clear product categories in WooCommerce, when a product is updated:

Loading gist pcwriter/abdabc4a03b37a32339efc53bbf4e2fd

2.6 Endpoint: /status/(?P<module>[\\w-]+)

Copy chapter anchor to clipboard

Description

Allows to fetch the status of Gzip compression and Browser caching modules.

Usage

Query
http://example.com/wp-json/hummingbird/v1/status/gzip

Return

Loading gist pcwriter/f90264ea511dbaacadd3d15c7e0f600d

Query
http://example.com/wp-json/hummingbird/v1/status/caching

Return

Loading gist pcwriter/97a64126ff917ee167b9d21593eca0e8

2.7 Endpoint: /clear_cache/(?P<module>[\\w-]+)

Copy chapter anchor to clipboard

Description

Allow to clear the cache for various Hummingbird modules.

Usage

Query
http://example.com/wp-json/hummingbird/v1/clear_cache/

List of module names:

  • page_cache
  • performance
  • gravatar
  • minify
  • cloudflare
Hummingbird API Docs