Jump to content

MarkupSEO - The all-in-one SEO solution for ProcessWire.


Nico Knoll

Recommended Posts

@mike: 

Thanks for adding it. I'll take a look.

@ceberlin:

Select a custom field with a fallback to title?

You can use multiple smart titles. So the first one will be used if filled (https://github.com/NicoKnoll/MarkupSEO/blob/master/MarkupSEO.module#L182-L187). If not the second one is used and so on. "Smart title" will be used in case you leave the "Title" field in the SEO tab empty.

post-140-0-92619200-1422108590_thumb.png

Canonical

Yes it's $page->httpUrl by default (https://github.com/NicoKnoll/MarkupSEO/blob/master/MarkupSEO.module#L233). But you're right. I should add a comment.

URL Segments

I'm not sure either how to handle them. But as they are not "real" pages I guess this module isn't able to handle them anyway (you can't add SEO fields to non existing pages...)

link rel="alternate" hreflang

I'll add an option to include this :)

  • Like 1
Link to comment
Share on other sites

Hi Nico,

Thanks for this module! Love it much :)

I think I may have found a conflicting issue when this module is installed along side with ProcessBackup (DB Backup module). There is an error when you try to view the Database Backup detail and I believe it may be caused by the following line:

$editedPage = wire('pages')->get($this->config->input->get->id);

The SEO module kicks in when trying to view the database backup page because there is a querystring id in the url.

setup/db-backups/info/?id=0:dev.cc26012015-01.sql

The fix is pretty simple:

    public function ready() {
      // backend hooks
      if(@$this->page->process == 'ProcessPageEdit') {
        $editedPage = wire('pages')->get($this->config->input->get->id);

        if(in_array($editedPage->template->name, $this->includeTemplates)) {
          $this->addHookAfter("ProcessPageEdit::buildFormContent", $this, 'hookCustomizeSeoTab');
        }
      }

      // frontend hooks
      if($this->page->template != 'admin' && in_array($this->page->template->name, $this->includeTemplates)) {
        $this->addHookProperty("Page::seo", $this, 'hookFrontendPage');
        $this->addHookProperty("Config::seo", $this, 'hookFrontendConfig');
      }
    }

Check the ProcessEditPage first before look for the edited page object. But anyway, I thought I let you know :) Thanks much again!

  • Like 3
Link to comment
Share on other sites

Hi Nico,

>Canonical

>Yes it's $page->httpUrl

I see a potential double content problem here:

A page can exist in http and in https mode. Especially after a https page was called (admin area, or a form in the frontend for example) a user stays in https mode until a next page which is set as http-only was opened.

Do you agree that a double content issue is possible?

If so, my idea would be using this checking order:

1. is the whole site https only (the brand new setting option in the latest dev) ->https

2. fallback: is there a strict setting in the URL part of the template for https? ->https

3. fallback: use the common way to display a website ->http

What Do you think?

Link to comment
Share on other sites

If so, my idea would be using this checking order:

1. is the whole site https only (the brand new setting option in the latest dev) ->https

2. fallback: is there a strict setting in the URL part of the template for https? ->https

3. fallback: use the common way to display a website ->http

I would support such a process, as google is suggesting webmasters to use https. I don't know for sure about the state of improved rankings from https, but as it's a possible factor, it should be taken care of as best as possible.

Link to comment
Share on other sites

URL Segments

I'm not sure either how to handle them. But as they are not "real" pages I guess this module isn't able to handle them anyway (you can't add SEO fields to non existing pages...)

Personally I'm not using the SEO module, I set it up in my _init.php, and when using URL Segments I add it in my templates.

Correct me if I'm wrong, but using URLSegments you actually have to edit the template, since it's not an actual page and doesn't have a title and/or meta_descriptions can't you create some default fall-back when URL Segments are used?

Then in the template itself:

SeoModule->fallback_string(__('%1$s is part of %2$s and contains %3$s subpages'),$URLSegment1, $page->parent->title, count($page->children));

or as matter as fact any default outcome when a $page->name/$page->core.title doesn't exist at all...?

BTW above "code" is just fiction, but I guess you know where I'm going...

Now we're at it, URL Segments aren't included in the current sitmap xml module either, which is not ideal on a SEO point of view.

Link to comment
Share on other sites

@makari: You now have to define which templates should get a SEO-tab in the module's settings :)

I did it. But no SEO-tab anywere... :mellow:

I guess, some of the old versions data is left in the database - but how can I find that - and where?

Link to comment
Share on other sites

Version 0.7.0:

Hey, I added the https option you asked for:

post-140-0-95031700-1422794809_thumb.png

$config->https will be set to true in runtime I guess if the template is set to use https, too. So all of the fallbacks should be covered.

And I added the fix by @peterfoeng.

  • Like 1
Link to comment
Share on other sites

I'm not getting an SEO tab appear on my publish/edit pages. I'm also not seeing any seo_xxxx fields in my fields list. So I thought I should maybe uninstall and reinstall, but when I try to uninstall I get:

Recoverable Fatal Error: Argument 1 passed to Fields::___delete() must implement interface Saveable, null given (line 265 of /wire/core/Fields.php) 
This error message was shown because you are logged in as a Superuser. Error has been logged.

And yes, I have specified templates to get the tab in the module's settings.

Link to comment
Share on other sites

Thanks for this module.

I use smart fields and got a little bit trouble using the description field. Because I chose fields which include html tags. Even if if I check "Strip Tags" in the field settings for seo_description. I guess that this setting doesn't take effect if the field was left blank. This results in:

<meta name="og:description" content="<h2>KF Interactive GmbH</h2>
	
	<p>
	D-04107 Leipzig</p>
	
	<p>Tel.: +<br />
	Fax: +<br />
	Mail: <a href=" mailto:info@kf-interactive.com"="">
<p><strong>Konzeption und Gestaltung der Website:</strong><br>
	<a href=""></a> & KF Interactive</p>
">
	

.. and breaks the layout.

I changed line 206:

-             $pageData['description'] = $page->get(implode('|', $configData['descriptionSmart']));
+             $pageData['description'] = strip_tags($page->get(implode('|', $configData['descriptionSmart']))); 

.. and everything works  :)

Maybe you could include this litte fix in a later version?

  • Like 4
Link to comment
Share on other sites

Regarding the HTTPS option:

$pageData['canonical'] = preg_replace('%^http%Uis', 'https', $page->httpUrl);

should be

$pageData['canonical'] = preg_replace('%^https?%i', 'https', $page->httpUrl);

This way the regex will capture all of the protocol string regardless of whether it is http or https at this stage. In my case I got a httpss in the resulting links from the first one as it matched the http, when the input was https.

Tried a few other regexes (e.g. https?, etc.) as well which logically should've worked, but preg_replace in its true self proved to be inconsistent.

Scratch that - read over the U modifier.

Fix returns https for both http and https as input, so covers both eventualities in the context of where it's called in the codebase.

  • Like 1
Link to comment
Share on other sites

Had to add a character counter with limiting functionality for one of my projects. Take a look and let me know what you think for now https://github.com/pjguk/MarkupSEO

No guarantees given - this was "hacked" straight into a production environment which already utilises the module and therefore uninstalling and reinstalling was not an option for the time being.

Particulars that are most likely not working as expected for now (Couldn't reliably test yet):

  • Default character limits are not set on install
  • Default character limits do not set should the limit field be empty when the page is saved
  • Hard character limits do not apply to pages unless the fields are being edited and the page subsequently saved (requirement for my project, may not be the behaviour everybody wants/needs)

So still some teething problems with the config on that part, but works well enough for me for the time being.

The modifications allow the following:

post-1687-0-78764400-1423414963_thumb.pn

Counter added to the title and description fields in the SEO tab. Counting down from the limit to 0 - and beyond to show how many characters you are over.

post-1687-0-54384900-1423414472_thumb.pn

Config options in the module settings to set the character limits for title and description as well as toggling hard limits. Hard limits disable the ability to enter more than the limit number of characters. Useful if multiple authors work with the SEO tabs and you want to ensure nobody goes over the limits.

post-1687-0-89385900-1423414964_thumb.pn

With hard limiting disabled the character counter simply goes into the negative and ignores the limit for the actual input and render.

post-1687-0-36572600-1423414966_thumb.pn

With hard limiting enabled the input cuts off at 0 characters left.

  • Like 1
Link to comment
Share on other sites

@tyssen: if you can't delete it go to fields and delete all of the (remaining) seo fields manually. Then go to the modules code and delete the whole ___delete() function. Then uninstall the module and delete the .module file. Then download the most recent version (0.8.1), install it and let me now if it works better afterwards :)

Link to comment
Share on other sites

This module cause a conflict with pages on the front end that use the id variable.

"../json_pages/?id=234|434"  will crash processwire. 

this seems to be the caused by: LINE: 92.

$editedPage = wire('pages')->get($this->config->input->get->id)

I think checking that you are in the backend before running the above query might solve the issue.

btw, great plugin. 

  • Like 1
Link to comment
Share on other sites

All good now, thanks. And very nice module, previewing feature especially.

Just one small request: it would be useful to have a way to override the Title Format on certain pages, e.g. the home page. For most pages I'll want to have Page Name – Site Name, but on the home page I'll want to have Site Name – Site Description, but with title format enabled I get Site Name – Site Description – Site Name.

  • Like 1
Link to comment
Share on other sites

Thanks for adding strip_tags for smart fields  :)

I got a little bit of trouble regarding the new piwik including. Still after re-saving the module settings I get the following error:

Notice: Undefined index: piwikAnalyticsUrl in /.../public/site/modules/MarkupSEO/MarkupSEO.module on line 311

On line 311 you need to check first if this array key exists because in the database there is just an entry for "piwikAnalytics":"" initially. As a quick fix I added ,"piwikAnalyticsUrl":"" manually.

Changing line 311 to

if (array_key_exists('piwikAnalyticsUrl', $configData) && $configData['piwikAnalyticsUrl']) 

or  check if piwikAnalytics is not empty

if (!empty($configData['piwikAnalytics']) && $configData['piwikAnalyticsUrl'])

should solve this issue.

Link to comment
Share on other sites

You corrected the names and therefore an empty entry will be saved. That's on line 767  ;) So you don't have to extend the if condition I suggested (on line 311) because you know that there is always an entry with this key.  ;) Thanks for the quick fix.

(I've been waiting for the strip_tags fix to be able to reset my deployment script because your module is included as a git submodule and I didn't want to change this. So I was quite sure to use the latest master version.)

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
  • 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 tcnet
      This module for ProcessWire sends a notification email for each failed login attempt. Similar modules exists already in the module directory of ProcessWire. However, this module is designed to notify, even if specified user doesn't exist.
      Settings
      The settings for this module are located in the menu Modules=>Configure=>LoginFailNotifier.
      Notification email
      Specifies the email address to which the notification emails should be sent.
        Email subject
      Specifies the subject line for the notification email.
        Post variables
      Specifies the $_POST variables to be included in the notification email. Each variable must be separated by a comma. For example: login_name,login_pass
        Server variables
      Specifies the $_SERVER variables to be included in the notification email. Each variable must be separated by a comma. For example: REMOTE_ADDR,HTTP_USER_AGENT
      Link to ProcessWire module directory:
      https://processwire.com/modules/login-fail-notifier/
      Link to github.com:
      https://github.com/techcnet/LoginFailNotifier
    • By Fokke
      ProcessWire 3.x markup module for rendering meta tags in HTML document head section. Note that this module is not a full-blown SEO solution, but rather a simple tool for rendering meta tags based on module configuration. Adding custom meta tags is also supported.
      Built-in meta tags
      The following meta tags are supported out-of-the-box:
      Document title consisting of page title and site name Character set Canonical Viewport Description Keywords Hreflang tags Open Graph og:title og:site_name og:type og:url og:description og:image og:image:width og:image:height Twitter meta tags twitter:card twitter:site twitter:creator twitter:title twitter:description twitter:image Facebook meta tags fb:app_id The full documentation with configurable options can be found here: https://github.com/Fokke-/MarkupMetadata
       
      Requirements:
      ProcessWire>=3.0.0 PHP >=7.1 Installation using Composer
      composer require fokke/markup-metadata Manual installation
      Download latest version from https://github.com/Fokke-/MarkupMetadata/archive/master.zip Extract module files to site/modules/MarkupMetadata directory.
    • By m.sieber
      ITRK-Service for ProcessWire
      Module for the automated transfer of imprint, data protection declaration and terms and conditions from IT-Recht Kanzlei to your ProcessWire installation
      What is ITRK Service for ProcessWire?
      ITRK-Service for ProcessWire is a free module for ProcessWire CMS. It provides an interface to the update service of IT-Recht Kanzlei, via which the legal texts of your online presence are automatically updated. In this way, the texts remain legally secure and warning-proof in the long term. Imprint, data protection declaration, revocation and general terms and conditions are currently supported.
      You can find our documentation (in german language) here: https://www.pupit.de/itrk-service-for-processwire/dokumentation/

      Download: https://www.pupit.de/itrk-service-for-processwire/
      Github: https://github.com/pupit-de/pwItrkServiceConnector
    • By LuisM
      Symprowire is a PHP MVC Framework based and built on Symfony using ProcessWire 3.x as DBAL and Service-Provider
      It acts as a Drop-In Replacement Module to handle the Request/Response outside the ProcessWire Admin. Even tough Symfony or any other mature MVC Framework could be intimidating at first, Symprowire tries to abstract Configuration and Symfony Internals away as much as possible to give you a quick start and lift the heavy work for you.
      The main Goal is to give an easy path to follow an MVC Approach during development with ProcessWire and open up the available eco-system.
      You can find the GitHub Repo and more Information here: https://github.com/Luis85/symprowire
      Documentation
      The Symprowire Wiki https://github.com/Luis85/symprowire/wiki How to create a simple Blog with Symprowire https://github.com/Luis85/symprowire/wiki/Symprowire-Blog-Tutorial Last Update
      16.07.2021 // RC 1 v0.6.0 centralized ProcessWire access trough out the Application by wrapping to a Service https://github.com/Luis85/symprowire/releases/tag/v0.6.0-rc-1 Requirements
      PHP ^7.4 Fresh ProcessWire ^3.0.181 with a Blank Profile Composer 2 (v1 should work, not recommended) The usual Symfony Requirements Features
      Twig Dependency Injection Monolog for Symprowire Support for .env YAML Configuration Symfony Console and Console Commands Symfony Webprofiler Full ProcessWire access inside your Controller and Services Webpack Encore support Caveats
      Symfony is no small Framework and will come with a price in terms of Memory Usage and added Overhead. To give you a taste I installed Tracy Debugger alongside to compare ProcessWire profiling with the included Symfony Webprofiler

      So in a fresh install Symprowire would atleast add another 2MB of Memory usage and around 40ms in response time, should be less in production due to the added overhead of the Webprofiler in dev env
       
×
×
  • Create New...