rarst/update-blocker

Lightweight generic blocker of updates from official WordPress repositories

Update Blocker — for WP repositories

Update Blocker is a lightweight generic blocker of plugin, theme, and core updates from official WordPress repositories., _(*1)

It was created as shared reusable plugin for the sake of no longer reinventing that particular wheel., _(*2)

Goals

• single main file
• mu-plugins–friendly
• no hard dependencies

Not goals

• interface
• elaborate API
• as–library use
• unreasonable compat

Installation

Plugin

1. Download ZIP.
2. Unpack files from inside into wp-content/plugins/update-blocker.

MU-plugin

1. Download update-blocker.php.
2. Place into wp-content/mu-plugins.
3. Edit settings for blocks in the file.

Composer

Create project in the wp-content/plugins:, _(*3)

composer create-project rarst/update-blocker:~1.0

Or require in composer.json of site project:, _(*4)

{
    "require": {
        "rarst/update-blocker": "~1.0"
    }
}

Requiring on plugin/theme level is not implemented, use suggest:, _(*5)

{
    "suggest": {
        "rarst/update-blocker": "Prevents invalid updates from official repositories"
    }
}

Configuration

Plugin's settings have following structure:, _(*6)

array(
    'all'     => false,
    'files'   => array( '.git', '.svn', '.hg' ),
    'plugins' => array( 'update-blocker/update-blocker.php' ),
    'themes'  => array(),
    'core'    => false,
)

• all — boolean, disables updates completely
• files — array of plugin/theme root–relative files to detect for block
• plugins — array of plugin base names (folder-name/plugin-name.php) to block
• themes — array of theme slugs (theme-name) to block
• core — boolean, disables core updates

Settings pass through update_blocker_blocked filter., _(*7)

Processed data passes through update_blocker_plugins and update_blocker_themes filters during update checks., _(*8)

Plugin opt–in

add_filter( 'update_blocker_blocked', function( $blocked ) {
    $blocked['plugins'][] = plugin_basename( __FILE__ ); // or just folder-name/plugin-name.php string
    return $blocked;
} );

Theme opt–in

add_filter( 'update_blocker_blocked', function( $blocked ) {
    $blocked['themes'][] = 'theme-name';
    return $blocked;
} );

Core opt–in

add_filter( 'update_blocker_blocked', function ( $blocked ) {
    $blocked['core'] = true;
    return $blocked;
} );

License

• MIT