Plugins von Updates ausschließen

Disclaimer: Es gibt ein paar kritische Kommentare (was ich gut finde, danke dafür). Dieser Artikel empfiehlt NICHT Updates grundsätzlich zu verweigern. Ich bin FÜR Updates. Aber manchmal gibt es triftige Gründe das bewusst nicht zu wollen und dafür kann man das Plugin nutzen.

Ihr kennt das, man arbeitet und plötzlich hat man eine Idee für ein Projekt, Plugin, SaaS, you-name-it. Entweder man ist Entwickler und könnte die Idee umsetzen, hat aber gerade keine Zeit, oder man findet keinen Entwickler, der einem dabei hilft. Mir mangelt es oftmals an der Zeit, diese Projekt wirklich umzusetzen und so schwillt meine eigene Ideen-Liste immer weiter an 😀

So ging es wohl auch Daniel Bachhuber. Der twitterte vor ein paar Tagen eine Plugin Idee:

https://twitter.com/danielbachhuber/status/768907891294121984

Seine Idee ist gar nicht so doof: Ein WordPress Plugin mit dem man installierte Plugins daran hindert nach Updates zu suchen. Das klingt vielleicht erstmal verrückt. Warum sollte man das machen wollen? Es gibt aber durchaus einige Anwendungsfälle dafür.

1. Es wird eine ganz spezielle Version benötigt vom Plugin.
2. Der Plugin Slug (mit dem sucht das Plugin auf WordPress.org nach Updates) ist auf WordPress.org schon von einem anderem Plugin belegt. Somit wäre ein Update kein Update, sondern ein überschreiben mit einem anderen Plugin.
3. Man möchte, dass z.B. der Kunde bestimmte Plugins per se nicht updaten kann.

Das dachte sich wohl auch Jonathan Daggerhart und hat kurzerhand genau das Plugin geschrieben.

https://twitter.com/daggerhart/status/768917624939950080?s=09

Jonathan hat die erste Version des Plugin zu allererst als Gist veröffentlicht. Ich habe mir das Plugin mal geschnappt und für euch installiert und ausprobiert. Dabei habe ich allerdings ein paar Fehler schon gefunden und Jonathan darauf aufmerksam gemacht. Gists sind zwar schön zum Teilen von Snippets, aber nicht so gut um mit anderen dran zu arbeiten. So hat er kurzerhand gleich mal den Code in ein eigenes Repo auf GitHub geschoben.

https://twitter.com/daggerhart/status/770627188991328256

Lock Plugins

So nun aber mal Butter bei die Fische oder wie der Veganer sagen würde: Tofu bei die Blume. Wie funktioniert das Lock Plugin jetzt?

Der Code ist ziemlich kompakt und die Idee ist simple. WordPress checkt gelegentlich die installierten Plugins nach Update und fragt dabei im WordPress.org Repository nach. Das Plugin nutzt diesen HTTP Request aus. Dabei wird der Filter-Hook http_request_args verwendet. Jeder HTTP Request, den WordPress absetzt, läuft über diesen Filter. Dabei wird als erstes geprüft, ob es sich um einen Update Check handelt. Wenn das der Fall ist, werden die Plugins aus der Liste gestrichen für die keine Updates gesucht werden sollen. Dabei wendet das Lock Plugin einen eigenen Filter an: .

<?php
/*
 * Plugin Name:     Lock plugin updates
 * Description:     Prevent plugin updates
 * Version:         1.0.0
 * Author:          daggerhart
 */
add_filter( 'http_request_args', 'lock_plugins_http_request_args', 5, 2 );
/**
 * Prevent lookup of certain plugin updates
 * Source: https://markjaquith.wordpress.com/2009/12/14/excluding-your-plugin-or-theme-from-update-checks/
 *
 * @param $request
 * @param $url
 *
 * @return mixed
 */
function lock_plugins_http_request_args( $request, $url ) {
    if ( FALSE === strpos( $url, '//api.wordpress.org/plugins/update-check' ) ) {
        return $request; // Not a plugin update request. Bail immediately.
    }
    if ( empty($request['body']['plugins']) ){
        return $request;
    }
    $plugins = json_decode( $request['body']['plugins'], true );
    // get a list of locked plugins from somewhere
    $locked_plugins = apply_filters('lock_plugins-locked_plugins', array());
    foreach( $locked_plugins as $locked_plugin_basename )
    {
        $active_index = array_search( $locked_plugin_basename, $plugins['active'] );
        unset( $plugins['active'][ $active_index ] );
        unset( $plugins['plugins'][ $locked_plugin_basename ] );
    }
    $request['body']['plugins'] = wp_json_encode( $plugins );
    return $request;
}

Diesen Code kann man sich einfach in eine PHP Datei speichern und in wp-content/plugins/ ablegen und schon kann man es im WordPress Backend aktivieren. Nun muss man nur noch über den Filter Hook die Plugins aus der Liste streichen, die man nicht updaten möchte. Das macht man wie folgt:

add_filter('lock_plugins-locked_plugins', function($plugins){
  $plugins[] = 'akismet/akismet.php';

  return $plugins;
});

Diesen Code kann man in einem weiteren Plugin, in der functions.php seines Themes oder einfach in der selben Datei wie das Plugin ablegen. In diesem Beispiel wird nun Akismet aus der Liste gestrichen und somit wird dafür kein Update mehr angeboten im Backend. Das Schema ist ziemlich simple: <Ordnername>/<Plugin Datei>.php

Damit kann man jedes Plugin zu der „Lock-List“ hinzufügen.

Meine Meinung

Ich finde das Plugin sehr nützlich, denn seit der Bookmark Idee sind Latz und ich nach wie vor dran die Idee umzusetzen. Latz hat dafür extra schon mal einen Prototypen gebaut. Dummerweise verwendet er einen Plugin Slug, den es auf WordPress.org schon gibt und so weißt mich WordPress immer darauf hin, dass es ein Update dafür gibt. Was allerdings ja nicht stimmt, da es ein komplett anderes Plugin ist.

Mit Lock Plugin Updates konnte ich nun diesen Prototypen einfach aus der Update Liste streichen und nun herrscht ruhe im Backend 🙂

 

Jonathan gibt im Repo noch den Tipp, dass man das Plugin sogar als Must-Use-Plugin installiert. Somit ist sichergestellt, dass Kunden auch das Plugin selber nicht deaktivieren können um doch die Plugins zu aktualisieren.