Problem/Motivation

A default theme region, "sidebar_first", is suggested in the shib_auth_block_info for the "Shibboleth Authentication" block. This hinders deployment to an existing site with such a named region because, once the module is enabled, it is automatically placed in the region and may appear in undesired places. While this is permitted in the hook's documentation (https://api.drupal.org/api/drupal/modules%21block%21block.api.php/functi...), it is not normally used.

This presents a particular issue in websites that use a test/stage/production methodology as then, depending on the deployment workflow, additional work is necessary to remove the block where it is not desired.

Proposed resolution

Remove the suggested region from shib_auth_block_info. Otherwise a site developer must manually remove the block from the undesired location or create a function utilizing the hook_block_info_alter to make it automatic.

Remaining tasks

None (Patch needs to be RTBC)

User interface changes

None for deployed installations, new installations of shib_auth would require placement of the block.

API changes

None.

CommentFileSizeAuthor
#2 default-block-region-2221633-2.patch568 bytespartyka

Comments

partyka’s picture

Issue summary: View changes
partyka’s picture

StatusFileSize
new568 bytes
partyka’s picture

Status: Active » Needs review

Changing issue status to needs review.

Also:

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
The patch is provided as noted in the terms of the copyright notice.

The purpose of this patch is: A bug fix (Removes default block placement)

This patch is being submitted by Argonne National Laboratory, March 19, 2014

+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

partyka’s picture

Issue summary: View changes
partyka’s picture

To the module maintainers: Will this patch be integrated into the next release?

  • bajnokk committed 27e7c98 on 7.x-4.x
    Issue #2221633 by partyka, disable default region for login link block
    
bajnokk’s picture

Status: Needs review » Fixed

Included in 4.3 (hotfix release).
Thanks!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.