wp_register_script( string $handle, string|false $src, string[] $deps = array(), string|bool|null $ver = false, array|bool $args = array() ): bool

User Contributed Notes

1. Skip to note 7 content

   Peter Ph 9 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note

   Easy way to link to external JS library and use it easily in project:
   register:

    wp_register_script( 'someScript-js', 'https://domain.com/someScript.js' , '', '', true );

   this will put the someScript.js at the bottom of our HTML file before
   call:

   wp_enqueue_script( 'someScript-js' );
2. Skip to note 8 content

   tazotodua 7 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note

   Corrected code from Luizaris:

   add_action("wp_enqueue_scripts", "myscripts");
   function myscripts() { 
       wp_register_script('myfirstscript', 
                           get_template_directory_uri() .'/myscript.js',   //
                           array ('jquery', 'jquery-ui'),					//depends on these, however, they are registered by core already, so no need to enqueue them.
                           false, false);
       wp_enqueue_script('myfirstscript');
        
   }
3. Skip to note 9 content

   jhned 5 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note

   Note to moderator: if there’s a better place to report this feedback, please email me at josh@cnpagency.com. I checked WordPress Trac, but it didn’t seem to be the right place for documentation feedback.

   I disagree with this part of the documentation:

   “The function should be called using the wp_enqueue_scripts action hook if you want to call it on the front-end of the site. To call it on the administration screens, use the admin_enqueue_scripts action hook. For the login screen, use the login_enqueue_scripts action hook. Calling it outside of an action hook can often lead to unexpected results and should be avoided.”

   First off, according to _wp_scripts_maybe_doing_it_wrong, init is also an acceptable hook for registering scripts. The benefit we get from registering scripts on init is that plugins can get a comprehensive list of the registered scripts and styles in the WordPress Admin by accessing the “registered” property of the $wp_scripts and $wp_styles globals. If we’re going to register scripts and styles, we should be able to pull a full list of the registered scripts and styles. The recommended usage is only for code efficiency, and has no other useful aspect to it.

   • Thanks for your comment, I added init in the recommendations.

     Jb Audras 5 years ago
4. Skip to note 10 content

   ashishsthanp 7 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

   In a case where first script should be loaded only if another second script is loaded:

   function my_enqueue_scripts()
   {
       wp_register_script( 'first', get_template_directory_uri() . 'js/first.js' );
   
       wp_enqueue_script( 'second', get_template_directory_uri() . 'js/second.js', array( 'first' ) );
   }
   add_action( 'wp_enqueue_scripts', 'my_enqueue_scripts' );

   Here, first.js will load( before second.js ) only if second.js is enqueued/loaded.
5. Skip to note 11 content

   Parth Dodiya 12 months ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

   Clearing confusion between all three functions. wp_enqueue_script() , wp_register_script() , and wp_localize_script()

   wp_register_script()::
   Registers a script with WordPress.
   Does not load the script on the page.
   Useful when you want to define a script for later use with specific conditions or dependencies.
   Takes arguments like script handle (unique identifier), script path (URL or relative path to the file), and optional arguments like version number and dependencies on other scripts.

   wp_enqueue_script()::
   Enqueues a script that need to be loaded on the page.
   Can also register the script if it hasn’t been registered before.
   Useful for including scripts you need on a specific page or based on certain conditions (e.g., only on the front-end).
   Takes arguments like script handle (same as used with wp_register_script) and optional arguments like version number, dependencies, and placement (in the header or footer).
   Here’s a key difference:

   wp_enqueue_script can handle both registering and loading a script in one call.
   wp_register_script only registers the script for later use with wp_enqueue_script or another function that might need it.

   wp_localize_script()::
   Does not register or enqueue a script.
   Used to localize a registered script, meaning it injects PHP variables into the script as JavaScript objects.
   Useful for passing data from WordPress (PHP) to your JavaScript code.
   Takes arguments like script handle (of an already registered script), a variable name to hold the data in JavaScript, and the actual PHP data (array or object) you want to pass.

   In short,
   Use wp_register_script to define scripts for later use.
   Use wp_enqueue_script to load scripts on the page (can also register if needed).
   Use wp_localize_script to pass data from PHP to your registered JavaScript code.
6. Skip to note 12 content

   luizarios 9 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: -12You must log in to vote on the helpfulness of this note

   Using register_script() to add a script and its dependencies

   function myscripts() {
       //get some external script that is needed for this script
       wp_enqueue_script('jquery-ui', 'http://ajax.googleapis.com/ajax/libs/jqueryui/1.9.1/jquery-ui.min.js'); 
       $script = get_template_directory_uri() . '/library/myscript.js';
       wp_register_script('myfirstscript', 
                           $script, 
                           array ('jquery', 'jquery-ui'), 
                           false, false);
       //always enqueue the script after registering or nothing will happen
       wp_enqueue_script('fullpage-slimscroll');
       
   }
   add_action("wp_enqueue_scripts", "myscripts");

   • See note by @tazotodua — no need to enqueue jquery-ui, since it’s pre-enqueued already by core; you just need to list the dependencies.

     Gwyneth Llewelyn 4 years ago