Jump to content

[SOLVED] Show permanent message in admin when option is selected by user


Andi
 Share

Recommended Posts

Getting a little deeper into the ProcessWire state-of-mind here. I seriously think I wouldn't have come back to webdev if it wasn't for this wonderful little gem of a CMS.

I have an "Options" field added to all users on a site. If the user has anything other then "default" selected, I would like to show a permanent message in the admin like the one in the screenshot, only so that the user can't close it. As a friendly reminder that he changed that option from default to something crazy 🙂

I've read up on how to send messages to users, but where would I hook into to make this show up all the time in the backend?

https://processwire.com/api/ref/wire/message/

Thanks in advance!

2020-04-17 09_40_37-Seiten.png

Link to comment
Share on other sites

You could just put it into templates/admin.php. The file should already be there. Here is the entire default file plus a line for the notice:

<?php namespace ProcessWire;

/**
 * Admin template just loads the admin application controller, 
 * and admin is just an application built on top of ProcessWire. 
 *
 * This demonstrates how you can use ProcessWire as a front-end 
 * to another application. 
 *
 * Feel free to hook admin-specific functionality from this file, 
 * but remember to leave the require() statement below at the end.
 * 
 */
if ($user->isLoggedin() && $myCrazySetting) $this->message("This is the notice text");
require($config->paths->adminTemplates . 'controller.php'); 

 

  • Like 1
  • Thanks 1
Link to comment
Share on other sites

Thanks a bunch @Jan Romero that was quick 🙂

Very elegant and simple. And works almost perfectly, but when I set the option from "crazy" back to "default", the message pops up one more time. When I refresh the backend or navigate to a different page in admin it's gone..

Going the other way around, from "default" to "crazy", the message pops up right away.

Nothing too major but I'm wondering how to work around that..

Link to comment
Share on other sites

Indeed, that’s because the the message is set before the admin controller actually runs and saves the the change.

Basically, every page in the admin backend executes a specific “Process”. You can hook into the base Process class to add your message only after a process has been executed:

$this->addHookAfter('Process::execute', function($event) {
    if ($this->wire('user')->isLoggedin() && $this->wire('config')->myCrazySetting)
        $this->message("Hope you know what you’re doing with that setting!");
});

This can be put in the same file, above the controller line.

  • Like 3
  • Thanks 1
Link to comment
Share on other sites

Works a treat. Thanks for explaining, that was very helpful!

Here's the finished hook for future reference.

In templates/admin.php

// user template switch warning in backend
$this->addHookAfter('Process::execute', function($event) {
	// only works for logged in users that have a custom frontend template enabled
	if ($this->wire('user')->isLoggedin() && $this->wire('user')->template_switch->value != 'default') {
		$u = $this->wire('user')->name;
		$t = $this->wire('user')->template_switch->title;
		$p = $this->wire('config')->urls->admin . "profile";
		$this->wire->warning("Frontend der Seite wird für User $u aktuell mit dem Template \"$t\" ausgegeben. <small>Einstellung \"Frontend Template\"im <a href='$p'>Benutzer-Profil</a></small>", Notice::allowMarkup);
	}
});

 

  • Like 3
Link to comment
Share on other sites

As it seems you are quite new to PW and motivated I suggest to avoid if(this AND that AND that):

// user template switch warning in backend
$this->addHookAfter('Process::execute', function($event) {
	$user = $this->wire('user');

	// early exit if user is not logged in
	if(!$user->isLoggedin()) return;

	// early exit if template is default
	if($user->template_switch->value == 'default') return;

	// show message to change template
	$u = $user->name;
	$t = $user->template_switch->title;
	$p = $this->wire('config')->urls->admin . "profile";
	$this->wire->warning("...", Notice::allowMarkup);
});

Of course this is totally up to you or anybody but IMHO this improves readability a lot. 🙂 

  • Like 2
Link to comment
Share on other sites

Hey again,

following @bernhard's suggestion of making stuff a little more readable, and after some refactoring, here's the result:

In templates/admin.php

// user custom theme warning in backend
$this->addHookAfter('Process::execute', function($event) {
	// make stuff more readable
	$user = $this->wire('user');
	// early exit if user is not logged in
	if(!$user->isLoggedin()) return;
	// array of themes that will be excluded
	$x = array('', 'default');
	// early exit if current user theme is in excluded array
	if(in_array($user->custom_theme->value, $x)) return;
	// set up message
	$u = $user->name;
	$t = $user->custom_theme->title;
	// set up path for profile link
	$p = $this->wire('config')->urls->admin . "profile";
	// send message
	$this->wire->warning("Frontend wird für Benutzer \"$u\" aktuell mit dem Theme \"$t\" ausgegeben.
						<small>Einstellung \"Frontend Theme\"im <a href=\"$p\">Benutzer-Profil</a></small>", Notice::allowMarkup);
});

Also added an array of values to be excluded to make this more reusable in the future.

1042169837_2020-04-1807_54_22-ProfilProcessWirelocalhost.thumb.png.2769f4a1466aec1a26d444afcaadf63c.png

Looking neat, working as expected. Thanks again and servus from Bavaria!

 

  • Like 2
Link to comment
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
 Share

  • Recently Browsing   0 members

    • No registered users viewing this page.
  • Similar Content

    • By Robin S
      This module lets you add some custom menu items to the main admin menu, and you can set the dropdown links dynamically in a hook if needed.
      Sidenote: the module config uses some repeatable/sortable rows for the child link settings, similar to the ProFields Table interface. The data gets saved as JSON in a hidden textarea field. Might be interesting to other module developers?
      Custom Admin Menus
      Adds up to three custom menu items with optional dropdowns to the main admin menu.
      The menu items can link to admin pages, front-end pages, or pages on external websites.
      The links can be set to open in a new browser tab, and child links in the dropdown can be given an icon.
      Requires ProcessWire v3.0.178 or newer.
      Screenshots
      Example of menu items

      Module config for the menus

      Link list shown when parent menu item is not given a URL

      Advanced
      Setting child menu items dynamically
      If needed you can set the child menu items dynamically using a hook.
      Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); if($menu_number === 1) { $colours = $event->wire()->pages->findRaw('template=colour', ['title', 'url', 'page_icon']); $children = []; foreach($colours as $colour) { // Each child item should be an array with the following keys $children[] = [ 'icon' => $colour['page_icon'], 'label' => $colour['title'], 'url' => $colour['url'], 'newtab' => false, ]; } $event->return = $children; } }); Create multiple levels of flyout menus
      It's also possible to create multiple levels of flyout submenus using a hook.

      For each level a submenu can be defined in a "children" item. Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); if($menu_number === 1) { $children = [ [ 'icon' => 'adjust', 'label' => 'One', 'url' => '/one/', 'newtab' => false, ], [ 'icon' => 'anchor', 'label' => 'Two', 'url' => '/two/', 'newtab' => false, 'children' => [ [ 'icon' => 'child', 'label' => 'Red', 'url' => '/red/', 'newtab' => false, ], [ 'icon' => 'bullhorn', 'label' => 'Green', 'url' => '/green/', 'newtab' => false, 'children' => [ [ 'icon' => 'wifi', 'label' => 'Small', 'url' => '/small/', 'newtab' => true, ], [ 'icon' => 'codepen', 'label' => 'Medium', 'url' => '/medium/', 'newtab' => false, ], [ 'icon' => 'cogs', 'label' => 'Large', 'url' => '/large/', 'newtab' => false, ], ] ], [ 'icon' => 'futbol-o', 'label' => 'Blue', 'url' => '/blue/', 'newtab' => true, ], ] ], [ 'icon' => 'hand-o-left', 'label' => 'Three', 'url' => '/three/', 'newtab' => false, ], ]; $event->return = $children; } }); Showing/hiding menus according to user role
      You can determine which menu items can be seen by a role by checking the user's role in the hook.
      For example, if a user has or lacks a role you could include different child menu items in the hook return value. Or if you want to conditionally hide a custom menu altogether you can set the return value to false. Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); $user = $event->wire()->user; // For custom menu number 1... if($menu_number === 1) { // ...if user does not have some particular role... if(!$user->hasRole('foo')) { // ...do not show the menu $event->return = false; } } });  
      https://github.com/Toutouwai/CustomAdminMenus
      https://processwire.com/modules/custom-admin-menus/
    • By sambadave
      Hi there
      Short version of question
      Let's say I have a page in the admin that contains a field... Is it possible to output the content from that field on another page in the admin? Almost like a reference.
      Longer version of question (with example)
      A house builder with multiple (60+) developments. They want to be able to create notices/messages that can be added to one or many developments. Handy for things like regional covid lockdowns or temporary office closures due to bad weather.
      My approach for the admin editing options:
      Add each message to each development
      Pros: You edit the message on the development page in context
      Cons: Very time consuming and repetitive if the same message needs to be applied to 60+ developments
        Control all the messages from one admin page and say which development each message should be applied to
      Pros: Easier to add/remove messages to more than one development at a time. Control all messages from one place.
      Cons: Content is not added on development page, which is where typical admin users may expect to find it I went for option 2 due to flexibility, and created a page within the admin for global development notices. This contains a repeater with:
      Field for message to display Checkbox list of all developments. The user can select which ones to apply each message to It's working really well but the only thing is that if the user goes to a specific development in the admin, the relevant messages aren't displayed in context (as they aren't edited on that page and instead on the global development notices page)... which may cause confusion when a new staff member / content admin tries to edit the text but there is no field when they go to the development admin page where they expect to see it...
      Solution???
      I don't require the message(s) to also be editable on the development page, but I wondered if there was a nice way to show it/them somehow. I feel like I am missing something really simple as I'm sure ProcessWire will have a nice way of achieving this, or maybe there are field settings that allow this kind of thing to happen?
      Any ideas on approaches or similar experiences would be much appreciated, even if it is just a much simpler example with the content from one field being shown on another admin page to get the ball rolling.
      Thanks in advance for any advice :)
    • By rjgamer
      Hi,
      is there a hook after the current (active) page got created? Or which method got called in the Page class after the Constructor of the current page got initialized?
      Thanks.
       
    • By Kiwi Chris
      I need to restrict editing access based on both the user role, and the value of a sub-field in a page reference field.
      eg $page->competition->closingDate 
      There's some discussion about restricting editing access based on role, and that works, but when I try to access the page via the method @Robin S suggests, the page returned is an admin page rather than the page being edited, so I don't have access to the edited page's fields.
       
    • By humanafterall
      Hi,
      I would like to set an admin template to 'https only' as recommended in the Processwire security docs.
      However if I do this it forces this setting locally too, resulting in https://localhost requests which result in an error page.
      Is there a simple way round this? Setting https for templates in the config?
      Thanks!
×
×
  • Create New...