シングルサイトインストールの場合（マルチサイトではテストしていません）、githubやgitlabなどの外部サービスから更新する必要があるフックは2つだけです。以下のコードでは、現在gitlabを使用しています。これは、現在コードをホストするために使用しているためです。おそらくgitlabの部品を抽象化する必要があります...
使用する必要がある最初のフックはpre_set_site_transient_update_themesです。これは、WordPressがsite_transientを設定して更新があるかどうかを示すために使用するフィルターです。このフックを使用してリモートバージョンに接続し、利用可能なアップデートがあるかどうかを確認します。存在する場合は、一時的なものを変更して、WordPressが更新があることを認識し、ユーザーに通知を表示できるようにします。
使用する必要があるもう1つのフックはupgrader_source_selectionです。いずれにしてもgitlabにはこのフィルターが必要です。ダウンロードしたフォルダーの名前がテーマと同じではないため、このフックを使用してフォルダーの名前を正しい名前に変更します。リモートリポジトリが正しい名前のzipを提供している場合、このフックは不要です。
使用できる3番目のオプションのフックはauto_update_theme、テーマを自動更新する場合です。以下の例では、このフックを使用して、この特定のテーマのみを自動更新します。
このコードはWordPress 4.9.xでのみテストされています。PHP> 7.0が必要です。
functions.php
//* Load the updater.
require PATH_TO . 'updater.php';
$updater = new updater();
\add_action( 'init', [ $updater, 'init' ] );
updater.php
/**
* @package StackExchange\WordPress
*/
declare( strict_types = 1 );
namespace StackExchange\WordPress;
/**
* Class for updating the theme.
*/
class updater {
/**
* @var Theme slug.
*/
protected $theme = 'theme';
/**
* @var Theme repository name.
*/
protected $repository = 'project/theme';
/**
* @var Repository domain.
*/
protected $domain = 'https://gitlab.com/';
/**
* @var CSS endpoint for repository.
*/
protected $css_endpoint = '/raw/master/style.css';
/**
* @var ZIP endpoint for repository.
*/
protected $zip_endpoint = '/repository/archive.zip';
/**
* @var Remote CSS URI.
*/
protected $remote_css_uri;
/**
* @var Remote ZIP URI.
*/
protected $remote_zip_uri;
/**
* @var Remote version.
*/
protected $remote_version;
/**
* @var Local version.
*/
protected $local_version;
/**
* Method called from the init hook to initiate the updater
*/
public function init() {
\add_filter( 'auto_update_theme', [ $this, 'auto_update_theme' ], 20, 2 );
\add_filter( 'upgrader_source_selection', [ $this, 'upgrader_source_selection' ], 10, 4 );
\add_filter( 'pre_set_site_transient_update_themes', [ $this, 'pre_set_site_transient_update_themes' ] );
}
/**
* Method called from the auto_update_theme hook.
* Only auto update this theme.
* This hook and method are only needed if you want to auto update the theme.
*
* @return bool Whether to update the theme.
*/
public function auto_update_theme( bool $update, \stdClass $item ) : bool {
return $this->theme === $item->theme;
}
/**
* Rename the unzipped folder to be the same as the existing folder
*
* @param string $source File source location
* @param string $remote_source Remote file source location
* @param \WP_Upgrader $upgrader \WP_Upgrader instance
* @param array $hook_extra Extra arguments passed to hooked filters
*
* @return string | \WP_Error The updated source location or a \WP_Error object on failure
*/
public function upgrader_source_selection( string $source, string $remote_source, \WP_Upgrader $upgrader, array $hook_extra ) {
global $wp_filesystem;
$update = [ 'update-selected', 'update-selected-themes', 'upgrade-theme' ];
if( ! isset( $_GET[ 'action' ] ) || ! in_array( $_GET[ 'action' ], $update, true ) ) {
return $source;
}
if( ! isset( $source, $remote_source ) ) {
return $source;
}
if( false === stristr( basename( $source ), $this->theme ) ) {
return $source;
}
$basename = basename( $source );
$upgrader->skin->feedback( esc_html_e( 'Renaming theme directory.', 'bootstrap' ) );
$corrected_source = str_replace( $basename, $this->theme, $source );
if( $wp_filesystem->move( $source, $corrected_source, true ) ) {
$upgrader->skin->feedback( esc_html_e( 'Rename successful.', 'bootstrap' ) );
return $corrected_source;
}
return new \WP_Error();
}
/**
* Add respoinse to update transient if theme has an update.
*
* @param $transient
*
* @return
*/
public function pre_set_site_transient_update_themes( $transient ) {
require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
$this->local_version = ( \wp_get_theme( $this->theme ) )->get( 'Version' );
if( $this->hasUpdate() ) {
$response = [
'theme' => $this->theme,
'new_version' => $this->remote_version,
'url' => $this->construct_repository_uri(),
'package' => $this->construct_remote_zip_uri(),
'branch' => 'master',
];
$transient->response[ $this->theme ] = $response;
}
return $transient;
}
/**
* Construct and return the URI to the remote stylesheet
*
* @return string The remote stylesheet URI
*/
protected function construct_remote_stylesheet_uri() : string {
return $this->remote_css_uri = $this->domain . $this->repository . $this->css_endpoint;
}
/**
* Construct and return the URI to the remote ZIP file
*
* @return string The remote ZIP URI
*/
protected function construct_remote_zip_uri() : string {
return $this->remote_zip_uri = $this->domain . $this->repository . $this->zip_endpoint;
}
/**
* Construct and return the URI to remote repository
*
* @access protected
* @since 1.0
*
* @return string The remote repository URI
*/
protected function construct_repository_uri() : string {
return $this->repository_uri = $this->domain . \trailingslashit( $this->repository );
}
/**
* Get and return the remote version
*
* @return string The remote version
*/
protected function get_remote_version() : string {
$this->remote_stylesheet_uri = $this->construct_remote_stylesheet_uri();
$response = $this->remote_get( $this->remote_stylesheet_uri );
$response = str_replace( "\r", "\n", \wp_remote_retrieve_body( $response ) );
$headers = [ 'Version' => 'Version' ];
foreach( $headers as $field => $regex ) {
if( preg_match( '/^[ \t\/*#@]*' . preg_quote( $regex, '/' ) . ':(.*)$/mi', $response, $match ) && $match[1] ) {
$headers[ $field ] = _cleanup_header_comment( $match[1] );
}
else {
$headers[ $field ] = '';
}
}
return $this->remote_version = ( '' === $headers[ 'Version' ] ) ? '' : $headers[ 'Version' ];
}
/**
* Return whether the theme has an update
*
* @return bool Whether the theme has an update
*/
protected function hasUpdate() : bool {
if( ! $this->remote_version ) $this->remote_version = $this->get_remote_version();
return version_compare( $this->remote_version, $this->local_version, '>' );
}
/**
* Wrapper for \wp_remote_get()
*
* @param string $url The URL to get
* @param array $args Array or arguments to pass through to \wp_remote_get()
*
* @return array|WP_Error Return the request or an error object
*/
protected function remote_get( string $url, array $args = [] ) {
return \wp_remote_get( $url, $args );
}
}