Admin Hot Keys

Recommended Posts

ProcessWire2.+ Admin Hot Keys 0.0.7

This modules adds hot keys functionality to PW backend. The keys can be configured in the module settings in the admin.

I created a repo here for download and if anyone interested in picking it up.

Currently it supports

  • Save : ctrl+s
  • Add New : ctrl+n
  • View Page : ctrl+v
  • Open Pages search : alt+q (search field can be configured)
  • Open Templates search : ctrl+shift+t
  • Open Fields search : ctrl+shift+f
  • Goto Pages : ctrl+shift+p
  • Goto Setup : ctrl+shift+s
  • Goto Modules : ctrl+shift+m
  • Goto Access : ctrl+shift+a

Note: If you're inside a text input it will ignore the hot keys, as to avoid problems with already defined key.

Tip: If you open up templates or fields autocomplete search `ctrl+shift+f|t` press `shift+tab` to focus on the link in the label previous to the search input box. Now hit enter to get right to the template or field screen. (If using FF make sure to enable tab focus for all elements in MacOSX: http://support.mozil...enus or buttons)

  • Like 14

Share this post

Link to post
Share on other sites

Your welcome. Thanks.

Little update after playing around a little.

  • changed to use save hot key for all edit screens to save not only page.
  • added "Add new" hot key support for Template, Fields, Users, anything that has a "Add new" button.

Have fun.

  • Like 1

Share this post

Link to post
Share on other sites

Hi Philipp,

Chrome on OS X likes it but I get some strange things happening in Firefox (13). I can't collapse any fields or use the PageListSelect.



Share this post

Link to post
Share on other sites

Added several new actions.

Added shortcuts to admin main pages.

The most fun is to open a autcomplete search to find and edit templates or fields. Now you can wherever you are press "ctrl+shift+t" or "ctrl+shift+f" and get something like this:


Once open you can type and select, hit enter and directly go to edit screen.

Enter a char and hit backspace to show all.

Have fun.

Share this post

Link to post
Share on other sites

Wow, this is a nice little helper. Great work!

One suggestion. Is it possible to go to the templates / field main page if I just press enter in the empty modal? This way we dont't need a additonal shortcut for these pages.

  • Like 1

Share this post

Link to post
Share on other sites

Thanks all!

Little update for 0.0.6

- added View Page to the list "ctrl+v".

- Also, I was thinking about adding a shortcut to the Template and Field pages.

I figured simplest is to add a link in the label in front of the searchfield. If you open the dialog, you can now simply press "shift+tab" to focus on that link and hit enter.

Edit: lol, just figured that "shift+tab" doesn't seem to work in FF. Back to the drawingboard :D¨

Edit2: Ok this seem related to OS setting in MacOSX. If in FF make sure this in enabled http://support.mozil...enus or buttons

Share this post

Link to post
Share on other sites

Soma - CTRL+V is paste on a windows PC so not sure whether there are any issues there? Just a thought.

Share this post

Link to post
Share on other sites

Soma - CTRL+V is paste on a windows PC so not sure whether there are any issues there? Just a thought.

Yeah I know, you can change it in the settings. I also thought the same but couldn't decide what would be best.

Share this post

Link to post
Share on other sites

I don't know whether you could work around it by checking if an input field or textures is selected before deciding on the action? If a field is selected it would make sense to leave it as paste, else view page in a new window maybe.

Share this post

Link to post
Share on other sites

Ok lol funny, it seems the hotkey jquery plugin already is ignoring commands if inside text inputs! So this already is solved this way. I thought it would be unnecessary to implement and I'm not sure it really is the best solution, but will help avoid problems in first place (as it also stated in Resigs plugin) . It would be nice to not needing to leave input focus to be able to save or do other actions while typing. But guess not really an issue.

Share this post

Link to post
Share on other sites

Soma, you have swapped the labels of "Goto Setup" and "Goto Pages" in AdminHotkeys.module

Your module is now part of my default processwire setup. Really useful..

Share this post

Link to post
Share on other sites

Hello, just commited a new update.

  • Added new action to search for Pages using PW internal ajax search "alt+q". You can even select template to filter.
  • Added setting to change the fields used in page search. Default "title body". Search uses %= (SQL like)
  • Changed dialogs to position fixed so they appear right where you are and page doesn't jump
  • Added check so it doesn't get initialized on login screen



  • Like 1

Share this post

Link to post
Share on other sites

Great update Soma! I'm really liking the new ajax page search. Only thing I wanted to mention though was the default key assigned to this ALT+Q can't be assigned in OS X because it's the application Quit command. I did it, and it immediately quit the browser, closed all windows, etc. I changed it to CTRL+Q, which seems to work well, but am thinking you chose alt+q because ctrl+q has the same problem on windows? Maybe there is some other default for this that would be safe across platforms? Maybe something like CTRL+. or CTRL+[ or CTRL+-

I love everything about this module, except that I'm confused by the templates/fields search. Probably because I'm just accustomed to clicking, rather than typing template/field names in the admin. In most sites, the quantities here are small enough to make the search seem overkill. So if there were a most wished for feature on my part, it would be that either: 1) it showed a list of templates/fields rather than a search box. Or; 2) that the field/template search boxes showed all of the fields/templates (that you could click to edit) and then filtered (rather than created) in the list as you type.

  • Like 1

Share this post

Link to post
Share on other sites

Oddly in Windows it's Alt+F4 to quit an application, so Alt+Q probably starts your car by that logic ;)

Not saying Macs make any more sense mind, requiring a key with a fruit on when they ran out of letters and numbers that by all rights should produce an apple when pressed. :P

Share this post

Link to post
Share on other sites

Thanks Ryan for the suggestions. I'm not sure what u mean by this is quit application. On my mac command q is quit alt q is a special char. I sent you from my phone so keeping it short.

Share this post

Link to post
Share on other sites

I'm actually using a 1987 IBM Model-M keyboard with my Mac, so I have an ALT key rather than an Command (Apple) key. But unless I'm mistaken, ALT and Command (Apple) are just platform specific names for the same thing. Macs also have something called the Option key, which I don't think has an equivalent on the PC. In my case, I just have Option mapped to my caps-lock key since I'm using an elderly PC keyboard. Regardless, I think that anyone on a Mac that uses this module would find the default search command (ALT-Q) causes their browser to quit. :) Though given that my setup isn't conventional Mac, it might be good for someone else on OS X to confirm.

Share this post

Link to post
Share on other sites

The Alt key (also called the Option key) on Macs is normally used for special characters and adding umlauts and accents on letters. The default command for quit is CMD + Q. For me, the Alt + Q is not used for anything important (well it creates this nice character - œ )

Great module soma - very useful.

Did you think of a way around the issue with it not working when the field is in focus? I’d really like to be able to edit a field and then Ctrl + S to save - at present there is no way to quickly get out of the field so the shortcuts will work, without using the mouse. Maybe if you could press escape to exit the field and then use the shortcut? Or could you bind the plugin to all input fields? I am guessing you might also have some issues with Tinymce which has its own keyboard shortcuts. Probably not a simple solution to this one.

I like the search overlays, it’s like a quick launcher - pressing Escape to close the overlay dialog would be useful.

If you are looking for inspiration for more shortcuts I always thought the Gmail ones were very good

A way to navigate the tree would be great (although the “quick launcher” way is probably much better). Or a way to open next and previous items in the tree.

And a help overlay mapped to ? which shows current shortcuts would be useful during the Shortcut learning phase (and for clients)

Share this post

Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By horst
      Wire Mail SMTP

      An extension to the new WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
      Here are Ryans announcement.

      Current Version 0.3.0
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.

      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('', '', '')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('', '', '') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; } Following are a ...

      List of all options and features

      testConnection () - returns true on success, false on failures

      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)

      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

      from = '' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here

      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification

      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
      (only available if a signature is defined in the config screen)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename

      send () - send the message(s) and return number of successful sent messages

      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,

      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
    • By Robin S
      An experimental module for adding images to a field via pasting one or more URLs.
      Add Image URLs
      Allows images to be added to an images field by pasting URLs.

      Install the Add Image URLs module.
      A "Paste URLs" button will be added to all image fields. Use the button to show a textarea where image URLs may be pasted, one per line. Images are added when the page is saved.
    • By netcarver
      This module provides a very simple interface to a set of named counters. You simply call a single function, next('name'), to pull the next value out of a counter - or to set it up if it does not yet exist. Next() takes a few extra parameters to allow you to increment by values other than 1 or to start at a certain number.
      This provides some similar functionality to the built-in page naming feature of PW, and to this module recently posted by Stikki but I think it offers a little more flexibility than either. Having said that, I do like the simplicity of Stikki's new auto-increment module.
      Module Availability
      Here is my module on Github.
      Here it is in the module repository.
      Example Usage
      Here's how this module can be used to title and name a new page by adding a couple of simple hooks to site/ready.php. This example applies to new pages using a template called 'invoice' that can be quick-added to the page tree. In order to get the following to work, you must edit the template that will be the parent of the 'invoice' template and setup the template for children to "invoice" and set the "Name Format for Children" field to something other than the default blank value (I use  title  as my value.)
      <?php /** * Function to recognise our special template. */ function isInvoiceTemplate($template) { return ($template == 'invoice'); } /** * Pre-load the page title for invoice pages with a unique value * which includes a counter component. */ $pages->addHookBefore("Pages::setupNew", function($event) { $page = $event->arguments(0); $is_invoice = isInvoiceTemplate($page->template); $no_inv_num = $page->title == ''; if ($is_invoice && $no_inv_num) { $counter_name = 'WR-' . date('Y'); $number = $this->modules->get('DatabaseCounters')->next($counter_name, 10, 5000); $page->title = $counter_name . '-' . sprintf("%06u", $number); } }); /** * Prevent ProcessPageEdit from forcing an edit of the name if we got here * through a quickAdd from ProcessPageAdd. We can do this because we * preset the title field in the Pages::setupNew hook. */ $pages->addHookAfter("ProcessPageEdit::loadPage", function($event) { $page = $event->return; $is_invoice = isInvoiceTemplate($page->template); $is_temp = $page->hasStatus(Page::statusTemp); if ($is_invoice && $is_temp) { $page->removeStatus(Page::statusTemp); $event->return = $page; } }); Note, the above code + module is one direct solution to the problem posted here by RyanJ.

      Version History
      1.0.0 The initial release.
    • By flydev
      Send "push" from ProcessWire to Pulseway.
      PulsewayPush simply send a push to a Pulseway instance. If you are using this module, you probably installed Pulseway on your mobile device: you will receive notification on your mobile.
      To get more information about Pulseway, please visit their website.
      They have a free plan which include 10 notifications (push) each day.
      Install the PulsewayPush module.
      Then call the module where you like in your module/template code :
      <?php $modules->get("PulsewayPush")->push("The title", "The notification message.", "elevated"); ?>  
      Hookable function
      ___push() ___notify() (the two function do the same thing)
      Github: Modules Directory:  
      Examples of use case
      I needed for our work a system which send notification to mobile device in case of a client request immediate support. Pulseway was choosen because it is already used to monitor our infrastructure.
      An idea, you could use the free plan to monitor your blog or website regarding the number of failed logins attempts (hooking Login/Register?), the automated tool then block the attacker's IP with firewall rules and send you a notification.

      - - -
      2017-11-22: added the module to the modules directory
    • By cosmicsafari
      Hi all,
      Just wondering if its possible to just add some basic output to my modules config page.
      I was wanting to output a bulleted list of some information which I will be pulling from a third party.
      Retrieving the data is fine i'm just not sure how to output it to the config page?
      From what I can see in the link below, it only seems like you can append form items to the page.