WordPress's Heartbeat API is used to enable regular communication between the browser and the server. 1. Initialize Heartbeat requests to customize the frequency and data through wp_enqueue_script and JavaScript, listen to the heartbeat_send event to add custom data and set window.heartbeatInterval to adjust the interval; 2. Receive data through the heartbeat_received filter on the PHP side, use callback functions to process and return responses; 3. To avoid performance problems, set reasonable intervals, avoid complex operations, and disable Heartbeat on unwanted pages. Reasonable use of Heartbeat API can realize lightweight real-time functions such as online user counting and automatic saving.
WordPress's Heartbeat API is a tool used to maintain regular communication between the browser and the server. It is often used for real-time updates, user status tracking, automatic save and other functions. If you are developing plug-ins or themes and want to enable real-time interaction between the backend and the frontend, the Heartbeat API is a very practical choice.
Here are some practical methods and suggestions for using the Heartbeat API:
How to initialize Heartbeat request
By default, WordPress has loaded the Heartbeat API and sends a request every 15 seconds. If you want to customize this frequency or add your own data, you can use wp_enqueue_script
and JavaScript to operate.
Basic practices:
- Inject your script using
wp_localize_script
- Listen to the
heartbeat_send
event in JavaScript to send additional data - Set
window.heartbeatInterval
to adjust the heartbeat interval (units in seconds)
Sample code:
jQuery(document).on('heartbeat_send', function(e, data) { data['custom_data'] = 'some_value'; });
This way you can receive this data on the PHP side and process it.
How to receive Heartbeat data on PHP
In the backend, you can receive data sent from the browser through the heartbeat_received
filter and return the response content.
Commonly used hooks:
-
add_filter( 'heartbeat_received', 'your_callback_function', 10, 2 );
- The parameters are the current heartbeat data and the sent data object respectively
You can make judgments based on the incoming data, such as checking whether a certain field exists and then returning the corresponding result.
Example:
function handle_heartbeat($response, $data) { if (isset($data['custom_data'])) { $response['result'] = 'Data received: ' . $data['custom_data']; } return $response; } add_filter('heartbeat_received', 'handle_heartbeat', 10, 2);
How to avoid performance issues
Although Heartbeat is convenient, it can be a burden on the server if it is frequently requested or handled improperly. Especially when multiple users are online at the same time, special attention should be paid to optimization.
A few tips:
- Do not set too short intervals (such as less than 5 seconds)
- Avoid performing time-consuming operations in each heartbeat, such as a large number of database queries
- If you do not need a Heartbeat page, you can disable it:
wp_deregister_script('heartbeat');
In addition, some hosting platforms or cache plug-ins will restrict Heartbeat, and it is best to test the actual effect before deployment.
Basically that's it. Mastering the use of Heartbeat API can enable you to implement some lightweight "pseudo-real-time" functions in WordPress development, such as online user counting, automatic draft saving, message push, etc. Although the mechanism is simple, you should still pay attention to the reasonable use of details.
The above is the detailed content of How to use the WordPress Heartbeat API. For more information, please follow other related articles on the PHP Chinese website!

Hot AI Tools

Undress AI Tool
Undress images for free

Undresser.AI Undress
AI-powered app for creating realistic nude photos

AI Clothes Remover
Online AI tool for removing clothes from photos.

Clothoff.io
AI clothes remover

Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Article

Hot Tools

Notepad++7.3.1
Easy-to-use and free code editor

SublimeText3 Chinese version
Chinese version, very easy to use

Zend Studio 13.0.1
Powerful PHP integrated development environment

Dreamweaver CS6
Visual web development tools

SublimeText3 Mac version
God-level code editing software (SublimeText3)

Hot Topics

To roll back the WordPress version, you can use the plug-in or manually replace the core file and disable automatic updates. 1. Use WPDowngrade and other plug-ins to enter the target version number to automatically download and replace; 2. Manually download the old version of WordPress and replace wp-includes, wp-admin and other files through FTP, but retain wp-config.php and wp-content; 3. Add code in wp-config.php or use filters to disable core automatic updates to prevent further upgrades. Be sure to back up the website and database before operation to ensure safety and reliability. It is recommended to keep the latest version for security and functional support in the long term.

The steps to create a custom shortcode in WordPress are as follows: 1. Write a PHP function through functions.php file or custom plug-in; 2. Use add_shortcode() to bind the function to the shortcode tag; 3. Process parameters in the function and return the output content. For example, when creating button shortcodes, you can define color and link parameters for flexible configuration. When using it, you can insert a tag like [buttoncolor="red"url="https://example.com"] in the editor, and you can use do_shortcode() to model it

The main reasons why WordPress causes the surge in server CPU usage include plug-in problems, inefficient database query, poor quality of theme code, or surge in traffic. 1. First, confirm whether it is a high load caused by WordPress through top, htop or control panel tools; 2. Enter troubleshooting mode to gradually enable plug-ins to troubleshoot performance bottlenecks, use QueryMonitor to analyze the plug-in execution and delete or replace inefficient plug-ins; 3. Install cache plug-ins, clean up redundant data, analyze slow query logs to optimize the database; 4. Check whether the topic has problems such as overloading content, complex queries, or lack of caching mechanisms. It is recommended to use standard topic tests to compare and optimize the code logic. Follow the above steps to check and solve the location and solve the problem one by one.

Methods to optimize WordPress sites that do not rely on plug-ins include: 1. Use lightweight themes, such as Astra or GeneratePress, to avoid pile-up themes; 2. Manually compress and merge CSS and JS files to reduce HTTP requests; 3. Optimize images before uploading, use WebP format and control file size; 4. Configure.htaccess to enable browser cache, and connect to CDN to improve static resource loading speed; 5. Limit article revisions and regularly clean database redundant data.

Miniving JavaScript files can improve WordPress website loading speed by removing blanks, comments, and useless code. 1. Use cache plug-ins that support merge compression, such as W3TotalCache, enable and select compression mode in the "Minify" option; 2. Use a dedicated compression plug-in such as FastVelocityMinify to provide more granular control; 3. Manually compress JS files and upload them through FTP, suitable for users familiar with development tools. Note that some themes or plug-in scripts may conflict with the compression function, and you need to thoroughly test the website functions after activation.

TransientsAPI is a built-in tool in WordPress for temporarily storing automatic expiration data. Its core functions are set_transient, get_transient and delete_transient. Compared with OptionsAPI, transients supports setting time of survival (TTL), which is suitable for scenarios such as cache API request results and complex computing data. When using it, you need to pay attention to the uniqueness of key naming and namespace, cache "lazy deletion" mechanism, and the issue that may not last in the object cache environment. Typical application scenarios include reducing external request frequency, controlling code execution rhythm, and improving page loading performance.

Object cache assists persistent storage, suitable for high access and low updates, tolerating short-term lost data. 1. Data suitable for "persistence" in cache includes user configuration, popular product information, etc., which can be restored from the database but can be accelerated by using cache. 2. Select a cache backend that supports persistence such as Redis, enable RDB or AOF mode, and configure a reasonable expiration policy, but it cannot replace the main database. 3. Set long TTL or never expired keys, adopt clear key name structure such as user:1001:profile, and update the cache synchronously when modifying data. 4. It can combine local and distributed caches to store small data locally and big data Redis to store big data and use it for recovery after restart, while paying attention to consistency and resource usage issues.

The most effective way to prevent comment spam is to automatically identify and intercept it through programmatic means. 1. Use verification code mechanisms (such as Googler CAPTCHA or hCaptcha) to effectively distinguish between humans and robots, especially suitable for public websites; 2. Set hidden fields (Honeypot technology), and use robots to automatically fill in features to identify spam comments without affecting user experience; 3. Check the blacklist of comment content keywords, filter spam information through sensitive word matching, and pay attention to avoid misjudgment; 4. Judge the frequency and source IP of comments, limit the number of submissions per unit time and establish a blacklist; 5. Use third-party anti-spam services (such as Akismet, Cloudflare) to improve identification accuracy. Can be based on the website
