Home » Functions » wp_localize_script

Function Name: wp_localize_script

WordPress is a platform that relies heavily on JavaScript to provide an interactive experience for users. In order to make the communication between PHP and JavaScript possible, WordPress has a function known as "wp_localize_script". This function is used to pass WordPress data from PHP to JavaScript in a way that is safe and easy to use.

The wp_localize_script function takes three parameters: the handle of the script being localized, the name of the object that will contain the localized data, and the data to be localized. The handle is the name of the script as it was registered with wp_enqueue_script. The name of the object is used to hold the localized data, and the data is an array of key/value pairs.

The purpose of wp_localize_script is to create a JavaScript object that can be used to store data for a particular script. This data can then be accessed by JavaScript code without the need for an AJAX call or reloading the page.

Here is an example of how to use wp_localize_script:

First, register and enqueue a script using wp_enqueue_script:

wp_enqueue_script( 'my-script', 'path/to/my/script.js' );

Then, use wp_localize_script to make the data available to the script:

$data = array(
    'foo' => 'bar',
    'baz' => 'qux'

wp_localize_script( 'my-script', 'my_script_data', $data );

Now, in your JavaScript file, you can access the data like this:

console.log( my_script_data.foo ); // Output: 'bar'
console.log( my_script_data.baz ); // Output: 'qux'

In summary, wp_localize_script is a powerful function in WordPress that enables developers to easily pass data from PHP to JavaScript in a safe and efficient way.

Learn More on WordPress.org

Register an account to save your snippets or go Pro to get more features.