Print this page
Wednesday, 27 October 2021 14:43

The Most Effective Method for Adding Inline Scripts in WordPress

Rate this item
(3 votes)

Inline scripts are a great way to add interactivity and functionality to your WordPress site. Understanding the right way to add them is key to achieving its merits. This post will discuss the most effective methods to add inline scripts in WordPress.

The Most Effective Method for Adding Inline Scripts in WordPress

Inline scripts are two simple words that send shivers down developers' spines. Inline Scripts are an easy way to add JavaScript (JS), CSS, and HTML in the text of your WordPress post. While they can be used for many purposes, one general use is to make changes on the fly when you publish a new WordPress article. Some might argue it isn't necessary, but doing so will ensure your website runs smoothly and efficiently.

One thing that most WordPress users overlook is supplementing scripts on their sites. Whether you want to implement an inline text on a single page or across your entire website, there are plenty of ways to accomplish it with WordPress. Adding inline scripts to your WordPress website can be as simple once you understand the proper methods to do it correctly. This blog post will discuss the most effective ways to add inline scripts in WordPress with ease. Keep reading to learn more.

Adding Via Wp_print_scripts

If you’re looking to add WordPress inline texts, then the WordPress wp_print_scripts or/and admin_print_scripts function is your answer. The WordPress wp_print_scripts can display text tags in the head of a document, which is typically done when including JS or CSS files. This WordPress function will allow you to make your site more interactive or add new functionality. As with any WordPress function, there are some simple rules to follow before using it on your website.

This function establishes three variables based upon WordPress plugin options and outputs them on the front-end (the head section) using the admin_print_scripts hook. To add the inline characters to the Admin area, you can also replace wp_print_scripts with the admin_print_scripts function and call it a day.

When WordPress is first installed, it comes with many texts that are automatically added to the site. This can lead to an increase in loading time and CPU usage on your server. One way to combat this is by using the wp_print_scripts function, so you only load texts when they're needed or desired. That said, let's take a quick look at some pros and cons of using the wp_print_script function to add inline characters in your WordPress post:

Pros:

  • It’s always straightforward to add any inline text to the “head section” of pages of WordPress;
  • The code you add won’t have any restrictions meaning you can add JS variables, functions, methods, conditionals, or anything you want to add to your site.

Cons:

  • There’s no specific way to associate your added code with registered scripts;
  • In most cases, the output code on various factors might not be a real and consistent way to control the output code location. However, you can always utilize the <priority> parameter under the <add_action> to control the location of your added code.

Use the wp_add_inline_script() Function

Recently, WordPress launched a new function applied to add inline JavaScript to WordPress posts. However, this new integration is compatible, starting with the 4.5 WordPress version, and it’s a more prominent way of adding inline texts compared to other available options. We’re defining the wp_add_inline_script() function, and you expect that it’ll get the job done flawlessly. Even the most experienced WordPress developer out there can confirm this fact.

The wp_add_inline_script() function is a way to add inline characters to your site without editing any code on the WordPress page. This allows you to make changes in real-time without needing FTP access or having to use a plugin. This function is also one of the essential integrations you can use to customize your WordPress site. The procedure allows you to add inline texts inside your website's code, which means they’ll be added directly into the HTML tags on your webpage. This concedes for a lot more customization than using external JS files or links to other websites.

Pros:

  • The wp_add_inline_script() function is a valuable way to add inline characters to your WordPress blog;
  • It can be an easy and convenient way for developers to add JS code without changing the WordPress theme or plugin files or editing the header.php template file;
  • This can be useful for adding scripts like Google Analytics code. It saves you from editing the header.php file every time there's an update with Google Analytics features or settings.

Cons:

  • The only drawback of the wp_add_inline_script() function is that it’s only available starting with the 4.5 WordPress version.

Use the wp_localize_script() Function

The wp_localize_script() function is a helpful WordPress utility to add inline characters to individual pages on your WordPress website. It's perfect if you need quick and temporary functionality on your sites, such as an event or promotion. This function accepts a variable number of arguments and outputs a list of JS strings added to the document's head. Doing so can be helpful if, for example, you’re using jQuery and want the script's code only on certain pages.

Wp_localize_script() enqueues your JS file and gives it an ID/handle of “shapeSpace_script,” which defines an associative array that contains your variables. Lastly, these JS variables are passed to wp_localize_script() to be included inline with registered shapeSpace_script. As a result, it enables you to apply any JS variables such as shapeSpace.varl, among others. This function is dedicated to localizing JS variables for use with language translation and internationalization. However, most WordPress developers use it as a common way to add inline characters to their sites.

Pros:

  • Wp_localize_script() enables the “read:require” association with your existing registered script. This means it provides an excellent and consistent way to control the relative location of your website’s custom text output.

Cons:

  • The only drawback is that you can only add JS variables (var = ‘value’). So it’s impossible to add other inline scripts such as functions, conditionals, equations, among others, using wp_localize_script().

Use Fallback

As mentioned earlier, specific methods such as wp_add_inline_script() are only available starting from the 4.5 WordPress Version or higher. However, by putting everything together, you can fashion a fail-proof method of adding inline characters to your WordPress files regardless of which WordPress version you’re using. The most effective way to do this is via three functions in the head section (front-end) post plugin.

The first essential thing to do is enqueue your JS file and call for the following function to add inline lines through the wp_add_inline_script() function. The third function is the fallback to anything older than the 4.5 version. This will undoubtedly work on WordPress 4.5 and any distinctive version. This is where the real magic happens. You can proceed with the fallback method that’ll get your job done on the WordPress variant of your choice going back to 2.1 or whatever.

Pros:

  • You can have multiple JS files on your website without adding additional HTTP requests to load them at once. This means you’ll be able to reduce loading time for your website visitors.
  • If one script fails, other scripts within the same fallback functionality will still work because they’re being loaded asynchronously from different threads due to their dependency on each other.

Cons:

  • When the script fails, the user will see an empty space instead of the code in a few cases. This might seem like it's not that big of a deal, but it’s a crucial thing to note as a WordPress developer.

A Recap on Adding Inline Script in WordPress

The limitation of alternative techniques available at your disposal makes the wp_add_inline_script() function the superior method for adding WordPress inline characters. This is considered the most effective solution nowadays, and contrary to popular belief, this function can be utilized on any Version of WordPress if you use the fallback technique. For your information, below is a quick recap on the most effective ways to add inline scripts in WordPress core:

    • wp_add_inline_script() allows you to add any JS code to any registered script;
    • wp_print_scripts or admin_print_scripts allows you to install any code on the front-end or header section;
  • wp_localize_script() also allows you to add JS variables to any registered script;
  • Fallback allows you to fashion a complete technique that works precisely with any version of WordPress.

Note: If you want to add inline style/CSS instead of JavaScript, WordPress provides you with a set of “add style” functions that resemble those used to add scripts. For instance, check out wp_print_styles and wp_add_inline_styles.

Conclusion

Inline scripts are a quick and easy way to add functionality to your WordPress website. By writing the script in JavaScript, you can create an inline script that does whatever you want it to do on the page without requiring additional plugins or code. This tutorial outlines the most effective methods to add inline scripts in WordPress.

Are you a WordPress editor with some experience adding scripts to WP sites? Which method would you recommend for a novice developer looking to get the job done quickly? Please feel free to use the comment section to share your opinion and ask any troubling questions.

Author's bio:

Arthur is a digital marketing specialist and business blogger. He develops interesting startups through various social media and shares his experience with clients to better promote their business. In his spare time, Arthur studies Japanese and writes articles on digital transformation trends.

Read 877 times Last modified on Monday, 29 November 2021 15:07
x

Looking for a FREE WooCommerce Theme?

WooVina is an intuitive & flexible, free WordPress theme offering deep integration with WooCommerce. 100% Love It Guarantee!