Jump to content
Juergen

Module to add 2 additional save buttons and unpublish button to page edit

Recommended Posts

Today I want to share a little module that adds 2 additional save buttons with redirect and 1 unpublish button to the page edit.

2 additional save buttons:

My intention was that it would be nice if someone saves an article in the backend and will be redirected after saving directly to the frontend page of the article. This module adds 1additional save button at the bottom next to the default save button and 1 at the top. So you can choose if you want to save the article with the default save button or you will save it with the custom save button and you will get redirected to the frontend article.

1 unpublish button:

The idea behind this was that I want to disable the setting tab for non superuser. The problem was if I hide it, then non superusers are no longer able to unpublish an article.

Therefore this module adds an additional unpublish button at the bottom - the user clicks it and the page will be saved with status unpublished.

All pages under the admin section will not be affected of this module.

Module is multilingual, so you can set the button texts in all languages.

Top view page status published:

post-2257-0-69050200-1455041771_thumb.pn

Bottom view page status published:

post-2257-0-77381200-1455041807_thumb.pn

Bottom view page status unpublished:

post-2257-0-60266900-1455041842_thumb.pn

Here is the code:

<?php
/**
 * Adding 2 additional save buttons with redirect to frontend and 1 unpublish button for page edit form.
 *
 * ProcessWire 2.x
 * Copyright (C) 2010 by Ryan Cramer
 * Licensed under GNU/GPL v2, see LICENSE.TXT
 *
 * http://www.processwire.com
 * http://www.ryancramer.com
 *
 */
class CustomPageSaveAndUnpublish extends WireData implements Module
{
    /**
     * getModuleInfo is a module required by all modules to tell ProcessWire about them
     *
     * @return array
     *
     */
    public static function getModuleInfo()
    {
        return array(
            'title' => 'Custom page save and unpublish module',
            'version' => 1,
            'summary' => 'Example for adding 2 additional save buttons with redirect and 1 unpublish button to page edit',
            'href' => 'http://www.processwire.com',
            'singular' => true,
            'autoload' => true
        );
    }
    /**
     * Initialize the module
     *
     * ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called
     * when ProcessWire's API is ready. As a result, this is a good place to attach hooks.
     *
     */
    public function init()
    {
        $this->addHookAfter("ProcessPageEdit::buildForm", $this, "addSaveButton");
        $this->addHookAfter("ProcessPageEdit::buildForm", $this, "addUnpublishButton");
        // tell processwire that this is a page save
        if ($this->input->post->submit_save_minor) {
            $this->input->post->submit_save = 1;
            // attach hook on page save
            $this->addHookAfter("Pages::saved", $this, "hookPageSave");
        }
        if ($this->input->post->submit_unpublish) {
            $this->input->post->submit_save = 1;
            // attach hook on page save
            $this->addHookAfter("Pages::saveReady", $this, "hookPageSaveReadyUnpublish");
        }
    }
    public function hookPageSave($event)
    {
        //function to redirect to the frontend after save
        $page = $event->arguments("page");
        if ($this->input->post->submit_save_minor) {
            // this will get saved after this saveReady hook so no need to save here            
            $pageid = $page->id;
            $goto   = wire("pages")->get("id=$pageid")->url; //get url of frontend article
            wire("session")->redirect($goto);
        }
    }
    public function hookPageSaveReadyUnpublish($event)
    {
        //function to change the status to unpublished 
        $page             = $event->arguments("page");
        $status           = $page->status;
        $unpublishmessage = __("Status of the page is set to unpublished");
        if ($this->input->post->submit_unpublish) {
            if ($status == 1) {
                $page->status = "2049";
                $this->message($unpublishmessage);
            }
        }
    }
    public function addSaveButton($event)
    {
        //function to add the 2 additional save button with redirect at the top and at the bottom
        $page   = $event->object->getPage();
        $status = $page->status;
        if (($page->rootParent->id != "2") AND ($status == 1)) { //dont show on all pages which are under the admin section and which are not published
            $form       = $event->return;
            $buttontext = __("Save and go to page");
            // new submit button
            $f          = $f2 = $this->modules->InputfieldSubmit;
            $f->attr("name", "submit_save_minor");
            $f->attr("value", $buttontext);
            $f2->attr("name", "submit_save_minor");
            $f2->attr("value", $buttontext);
            $f2->class .= ' ui-priority-secondary head_button_clone';
            // add submit button after the regular save button only if page is published            
            $form->insertAfter($f, $form->get("submit_save"));
            $form->insertAfter($f2, $form->get("submit_save"));
        }
    }
    public function addUnpublishButton($event)
    {
        //function to add the unpublish button at the bottom if page has status published
        $page = $event->object->getPage();
        if ($page->rootParent->id != 2) { //dont show on all pages which are under the admin and dont show the button under the delete tab
            $form                = $event->return;
            $unpublishbuttontext = __("Unpublish");
            // new submit button
            $f                   = $this->modules->InputfieldSubmit;
            $f->attr("name", "submit_unpublish");
            $f->attr("value", $unpublishbuttontext);
            // add unpublish button after the save button
            if ($page->status == 1) {
                $form->insertAfter($f, $form->get("submit_save"));
            }
        }
    }
}

Everybody who is interested can download the modul here:

CustomPageSaveAndUnpublish.zip

Best regards Jürgen

  • Like 10
  • Thanks 1

Share this post


Link to post
Share on other sites

Glad to hear that :)! Now the "save the page and go to the frontend" button is not necessary anymore if you use PW3, because this functionality is integrated in the core.

  • Like 1

Share this post


Link to post
Share on other sites
On 3/21/2016 at 5:09 PM, Juergen said:

Glad to hear that :)! Now the "save the page and go to the frontend" button is not necessary anymore if you use PW3, because this functionality is integrated in the core.

Newbie question: where? How to access it?

Your module looks to be just what I need. I recently converted my brass band's site to Processwire (from Clipper, using Latte templating, but that's another story), and am extending it to allow a private Members area. I'd like some others to be able to add notices about rehearsals etc. I've managed to make a simple front-end form that lets them create a new post comfortably from the front end, entering date and a brief title; it then takes them to the back end if required to add full details and file attachments. I want them to get back to the main members page on completion, so the module looks a good fit for that. I'm just curious what and where the built-in functionality is.

Share this post


Link to post
Share on other sites
On 9/2/2018 at 10:13 AM, kp52 said:

Newbie question: where? How to access it?

919375677_pw_saveview.thumb.png.8f9ddb1b4d64b5a5e50a9dec4b810bce.png

Hi Keith,

Would love to see your site when it's done. Hope you are keeping well.

/k

Share this post


Link to post
Share on other sites

Thanks for the tip! The big bold button is what I need.

Site is Ascot Brass, which I converted from a gruesome heap of tables within tables to Clipper a couple of years ago when asked to become webmaster. I decided to try it out as my first Clipper to PW conversion when faced with creating the Members page. Use of templating in Clipper made it reasonably easy to do the original conversion; and I've found the TemplateLatteReplace module suits my way of working in PW.

KP

  • Like 1

Share this post


Link to post
Share on other sites

Thx @Juergen that also helped me today.

This is what I came up with (for future reference) when I needed to add a page clone button:

  /**
   * Add clone button to form
   */
  public function addCloneButton() {

    // add button to form
    $this->addHookAfter("ProcessPageEdit::buildForm", function($event) {
      $form = $event->arguments(0);
      $form->add([
        'type' => 'submit',
        'name' => 'btn_clone_plan',
        'value' => __('Clone'),
        'icon' => 'clone',
      ]);
      $form->get('btn_clone_plan')->addClass('ui-priority-secondary');
    });

    // process input
    $this->addHookAfter("ProcessPageEdit::processInput", function($event) {
      $form = $event->arguments(0);
      if($form != "InputfieldForm") return; // dont fire on inputfields
      if($this->input->post('btn_clone_plan')) {
        // tell PW to save the page
        $this->input->post->submit_save = 1;
      }
      if(count($form->getErrors())) {
        // clone only if there are no errors, otherwise do a regular save
        unset($this->input->post->btn_clone_plan);
      }
    });

    // do the clone
    $this->addHookAfter("Pages::saved", function($event) {
      if(!$this->input->post->btn_clone_plan) return;
      unset($this->input->post->btn_clone_plan); // prevent endless loop!
      $clone = $this->pages->clone($event->arguments(0));
      $this->session->redirect($clone->editUrl);
    });
  }

PS: This approach might be easier, but I wanted an extra button:

 

  • Like 2

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 teppo
      Needed a really simple solution to embed audio files within page content and couldn't find a module for that, so here we go. Textformatter Audio Embed works a bit like Textformatter Video Embed, converting this:
      <p>https://www.domain.tld/path/to/file.mp3</p> Into this:
      <audio controls class="TextformatterAudioEmbed"> <source src="https://www.domain.tld/path/to/file.mp3" type="audio/mpeg"> </audio> The audio element has pretty good browser support, so quite often this should be enough to get things rolling 🙂
      GitHub repository: https://github.com/teppokoivula/TextformatterAudioEmbed Modules directory: https://modules.processwire.com/modules/textformatter-audio-embed/
    • By Richard Jedlička
      Tense    
      Tense (Test ENvironment Setup & Execution) is a command-line tool to easily run tests agains multiple versions of ProcessWire CMF.
      Are you building a module, or a template and you need to make sure it works in all supported ProcessWire versions? Then Tense is exactly what you need. Write the tests in any testing framework, tell Tense which ProcessWire versions you are interested in and it will do the rest for you.

      See example or see usage in a real project.
      How to use?
      1. Install it: 
      composer global require uiii/tense 2. Create tense.yml config:
      tense init 3. Run it:
      tense run  
      For detailed instructions see Github page: https://github.com/uiii/tense
       
      This is made possible thanks to the great wireshell tool by @justb3a, @marcus and others.
       
      What do you think about it? Do you find it useful? Do you have some idea? Did you find some bug? Tell me you opinion. Write it here or in the issue tracker.
    • By Chris Bennett
      Hi all, I am going round and round in circles and would greatly appreciate if anyone can point me in the right direction.
      I am sure I am doing something dumb, or missing something I should know, but don't. Story of my life 😉

      Playing round with a module and my basic problem is I want to upload an image and also use InputfieldMarkup and other Inputfields.
      Going back and forth between trying an api generated page defining Fieldgroup, Template, Fields, Page and the InputfieldWrapper method.

      InputfieldWrapper method works great for all the markup stuff, but I just can't wrap my head around what I need to do to save the image to the database.
      Can generate a Field for it (thanks to the api investigations) but not sure what I need to do to link the Inputfield to that. Tried a lot of stuff from various threads, of varying dates without luck.
      Undoubtedly not helped by me not knowing enough.

      Defining Fieldgroup etc through the api seems nice and clean and works great for the images but I can't wrap my head around how/if I can add/append/hook the InputfieldWrapper/InputfieldMarkup stuff I'd like to include on that template as well. Not even sure if it should be where it is on ___install with the Fieldtype stuff or later on . Not getting Tracy errors, just nothing seems to happen.
      If anyone has any ideas or can point me in the right direction, that would be great because at the moment I am stumbling round in the dark.
       
      public function ___install() { parent::___install(); $page = $this->pages->get('name='.self::PAGE_NAME); if (!$page->id) { // Create fieldgroup, template, fields and page // Create new fieldgroup $fmFieldgroup = new Fieldgroup(); $fmFieldgroup->name = MODULE_NAME.'-fieldgroup'; $fmFieldgroup->add($this->fields->get('title')); // needed title field $fmFieldgroup->save(); // Create new template using the fieldgroup $fmTemplate = new Template(); $fmTemplate->name = MODULE_NAME; $fmTemplate->fieldgroup = $fmFieldgroup; $fmTemplate->noSettings = 1; $fmTemplate->noChildren = 1; $fmTemplate->allowNewPages = 0; $fmTemplate->tabContent = MODULE_NAME; $fmTemplate->noChangeTemplate = 1; $fmTemplate->setIcon(ICON); $fmTemplate->save(); // Favicon source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFavicon'; $fmField->label = 'Favicon'; $fmField->focusMode = 'off'; $fmField->gridMode = 'grid'; $fmField->extensions = 'svg png'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Favicon Silhouette source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFaviconSilhouette'; $fmField->label = 'SVG Silhouette'; $fmField->notes = 'When creating a silhouette/mask svg version for Safari Pinned Tabs and Windows Tiles, we recommend setting your viewbox for 0 0 16 16, as this is what Apple requires. In many cases, the easiest way to do this in something like illustrator is a sacrificial rectangle with no fill, and no stroke at 16 x 16. This forces the desired viewbox and can then be discarded easily using something as simple as notepad. Easy is good, especially when you get the result you want without a lot of hassle.'; $fmField->focusMode = 'off'; $fmField->extensions = 'svg'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Create: Open Settings Tab $tabOpener = new Field(); $tabOpener->type = new FieldtypeFieldsetTabOpen(); $tabOpener->name = 'fmTab1'; $tabOpener->label = "Favicon Settings"; $tabOpener->collapsed = Inputfield::collapsedNever; $tabOpener->addTag(MODULE_NAME); $tabOpener->save(); // Create: Close Settings Tab $tabCloser = new Field(); $tabCloser->type = new FieldtypeFieldsetClose; $tabCloser->name = 'fmTab1' . FieldtypeFieldsetTabOpen::fieldsetCloseIdentifier; $tabCloser->label = "Close open tab"; $tabCloser->addTag(MODULE_NAME); $tabCloser->save(); // Create: Opens wrapper for Favicon Folder Name $filesOpener = new Field(); $filesOpener->type = new FieldtypeFieldsetOpen(); $filesOpener->name = 'fmOpenFolderName'; $filesOpener->label = 'Wrap Folder Name'; $filesOpener->class = 'inline'; $filesOpener->collapsed = Inputfield::collapsedNever; $filesOpener->addTag(MODULE_NAME); $filesOpener->save(); // Create: Close wrapper for Favicon Folder Name $filesCloser = new Field(); $filesCloser->type = new FieldtypeFieldsetClose(); $filesCloser->name = 'fmOpenFolderName' . FieldtypeFieldsetOpen::fieldsetCloseIdentifier; $filesCloser->label = "Close open fieldset"; $filesCloser->addTag(MODULE_NAME); $filesCloser->save(); // Create Favicon Folder Name $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeText"); $fmField->name = 'folderName'; $fmField->label = 'Favicon Folder:'; $fmField->description = $this->config->urls->files; $fmField->placeholder = 'Destination Folder for your generated favicons, webmanifest and browserconfig'; $fmField->columnWidth = 100; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon('folder'); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($tabOpener); $fmFieldgroup->add($filesOpener); $fmFieldgroup->add($fmField); $fmFieldgroup->add($filesCloser); $fmFieldgroup->add($tabCloser); $fmFieldgroup->save(); /////////////////////////////////////////////////////////////// // Experimental Markup Tests $wrapperFaviconMagic = new InputfieldWrapper(); $wrapperFaviconMagic->attr('id','faviconMagicWrapper'); $wrapperFaviconMagic->attr('title',$this->_('Favicon Magic')); // field show info what $field = $this->modules->get('InputfieldMarkup'); $field->name = 'use'; $field->label = __('How do I use it?'); $field->collapsed = Inputfield::collapsedNever; $field->icon('info'); $field->attr('value', 'Does this even begin to vaguely work?'); $field->columnWidth = 50; $wrapperFaviconMagic->add($field); $fmTemplate->fields->add($wrapperFaviconMagic); $fmTemplate->fields->save(); ///////////////////////////////////////////////////////////// // Create page $page = $this->wire( new Page() ); $page->template = MODULE_NAME; $page->parent = $this->wire('pages')->get('/'); $page->addStatus(Page::statusHidden); $page->title = 'Favicons'; $page->name = self::PAGE_NAME; $page->process = $this; $page->save(); } }  
    • By Sebi
      Since it's featured in ProcessWire Weekly #310, now is the time to make it official:
      Here is Twack!
      I really like the following introduction from ProcessWire Weekly, so I hope it is ok if I use it here, too. Look at the project's README for more details!
      Twack is a new — or rather newish — third party module for ProcessWire that provides support for reusable components in an Angular-inspired way. Twack is implemented as an installable module, and a collection of helper and base classes. Key concepts introduced by this module are:
      Components, which have separate views and controllers. Views are simple PHP files that handle the output for the component, whereas controllers extend the TwackComponent base class and provide additional data handling capabilities. Services, which are singletons that provide a shared service where components can request data. The README for Twack uses a NewsService, which returns data related to news items, as an example of a service. Twack components are designed for reusability and encapsulating a set of features for easy maintainability, can handle hierarchical or recursive use (child components), and are simple to integrate with an existing site — even when said site wasn't originally developed with Twack.
      A very basic Twack component view could look something like this:
      <?php namespace ProcessWire; ?> <h1>Hello World!</h1> And here's how you could render it via the API:
      <?php namespace Processwire; $twack = $modules->get('Twack'); $hello = $twack->getNewComponent('HelloWorld'); ?> <html> <head> <title>Hello World</title> </head> <body> <?= $hello->render() ?> </body> </html> Now, just to add a bit more context, here's a simple component controller:
      <?php namespace ProcessWire; class HelloWorld extends TwackComponent { public function __construct($args) { parent::__construct($args); $this->title = 'Hello World!'; if(isset($args['title'])) { $this->title = $args['title']; } } } As you can see, there's not a whole lot new stuff to learn here if you'd like to give Twack a try in one of your projects. The Twack README provides a really informative and easy to follow introduction to all the key concepts (as well as some additional examples) so be sure to check that out before getting started. 
      Twack is in development for several years and I use it for every new project I build. Also integrated is an easy to handle workflow to make outputs as JSON, so it can be used to build responses for a REST-api as well. I will work that out in one section in the readme as well. 
      If you want to see the module in an actual project, I have published the code of www.musical-fabrik.de in a repository. It runs completely with Twack and has an app-endpoint with ajax-output as well.
      I really look forward to hear, what you think of Twack🥳!
      Features Installation Usage Quickstart: Creating a component Naming conventions & component variants Component Parameters directory page parameters viewname Asset handling Services Named components Global components Ajax-Output Configuration Versioning License Changelog
    • By Robin S
      Page Reference Default Value
      Most ProcessWire core inputfield types that can be used with a Page Reference field support a "Default value" setting. This module extends support for default values to the following core inputfield types:
      Page List Select Page List Select Multiple Page Autocomplete (single and multiple) Seeing as these inputfield types only support the selection of pages a Page List Select / Page List Select Multiple is used for defining the default value instead of the Text / Textarea field used by the core for other inputfield types. This makes defining a default value a bit more user-friendly.
      Note that as per the core "Default value" setting, the Page Reference field must be set to "required" in order for the default value to be used.
      Screenshot

       
      https://github.com/Toutouwai/PageReferenceDefaultValue
      https://modules.processwire.com/modules/page-reference-default-value/
×
×
  • Create New...