<?php
/**
* Common hooks for all admin contexts
*/
class Loco_hooks_AdminHooks extends Loco_hooks_Hookable {
private ?Loco_hooks_Hookable $router = null;
/**
* "admin_notices" callback,
* If this is hooked and not unhooked then auto-hooks using annotations have failed.
*/
public static function print_hook_failure(){
echo '<div class="notice error"><p><strong>Error:</strong> Loco Translate failed to start up</p></div>';
}
/**
* Autoloader for polyfills and warnings when important classes are requested, but missing.
* This must be loaded after `loco_autoload` which is responsible for loading Loco_* classes.
*/
public static function autoload_compat( $name ){
if( strlen($name) < 20 && 'Loco_' !== substr($name,0,5) ){
$path = loco_plugin_root().'/src/compat/'.$name.'.php';
if( file_exists($path) ){
require $path;
}
}
}
/**
* {@inheritdoc}
*/
public function __construct(){
// renders failure notice if plugin failed to start up admin hooks.
add_action( 'admin_notices', [__CLASS__,'print_hook_failure'] );
// initialize hooks
parent::__construct();
// Ajax router will be called directly in tests
// @codeCoverageIgnoreStart
if( loco_doing_ajax() ){
$action = $_REQUEST['action'] ?? '';
// initialize Ajax router before hook fired so we can handle output buffering
if( isset($_REQUEST['route']) && str_starts_with($action,'loco_') ){
spl_autoload_register( [__CLASS__,'autoload_compat'] );
$this->router = new Loco_mvc_AjaxRouter;
Loco_package_Listener::create();
}
}
// @codeCoverageIgnoreEnd
// page router required on all pages as it hooks in the menu
else {
$this->router = new Loco_mvc_AdminRouter;
// we don't know we will render a page yet, but we know it'll be ours if it exists.
if( isset($_GET['page']) && 'loco' === substr($_GET['page'],0,4) ){
spl_autoload_register( [__CLASS__,'autoload_compat'] );
Loco_package_Listener::create();
// trigger post-upgrade process if required
Loco_data_Settings::get()->migrate();
}
}
}
/**
* @inheritdoc
*/
public function unhook(){
spl_autoload_unregister( [__CLASS__,'autoload_compat'] );
$this->router instanceof Loco_hooks_Hookable and $this->router->unhook();
parent::unhook();
}
/**
* Expose the router constructed for the current request context (admin page or ajax) No route if null.
* @return Loco_mvc_AdminRouter|Loco_mvc_AjaxRouter|null
*/
public function getRouter():?Loco_hooks_Hookable {
return $this->router;
}
/**
* "admin_init" callback.
*/
public function on_admin_init(){
// This should fire just before WP_Privacy_Policy_Content::privacy_policy_guide is called
// View this content at /wp-admin/privacy-policy-guide.php#wp-privacy-policy-guide-loco-translate
if( function_exists('wp_add_privacy_policy_content') ) {
$url = apply_filters('loco_external','https://localise.biz/wordpress/plugin/privacy');
wp_add_privacy_policy_content(
__('Loco Translate','loco-translate'),
esc_html( __("This plugin doesn't collect any data from public website visitors.",'loco-translate') ).'<br />'.
wp_kses(
// translators: %s will be replaced with a URL which may change without affecting the translation.
sprintf( __('Administrators and auditors may wish to review Loco\'s <a href="%s">plugin privacy notice</a>.','loco-translate'), esc_url($url) ),
['a'=>['href'=>true]], ['https']
)
);
}
}
/**
* "admin_menu" callback.
*/
public function on_admin_menu(){
// This earliest we need translations, and admin user locale should be set by now
if( $this->router ){
$domainPath = dirname( loco_plugin_self() ).'/languages';
load_plugin_textdomain( 'loco-translate', false, $domainPath );
}
// Unhook failure notice that would fire if this hook was not successful
remove_action( 'admin_notices', [__CLASS__,'print_hook_failure'] );
}
/**
* "user_has_cap" filter callback.
* Grants in-memory `loco_admin` to site administrators, so their access never depends on concrete capabilities.
* All other users must inherit loco_admin from a role assigned in plugin settings, explicitly granted by an admin.
*/
public function filter_user_has_cap( $allcaps = null, $caps = null , $args = null, $user = null ):array {
if( ! is_array($allcaps) ){
$allcaps = [];
}
if( $user instanceof WP_User && is_array($caps) && in_array('loco_admin',$caps,true) ){
$granted = $allcaps['loco_admin']??false;
if( ! $granted && Loco_data_Permissions::isSuperAdmin($user) ){
$allcaps['loco_admin'] = true;
}
}
return $allcaps;
}
/**
* plugin_action_links action callback
*/
public function on_plugin_action_links( $links, $plugin = '' ){
try {
if( $plugin && current_user_can('loco_admin') && Loco_package_Plugin::get_plugin($plugin) ){
// coerce links to array
if( ! is_array($links) ){
$links = $links && is_string($links) ? (array) $links : [];
}
// ok to add "translate" link into meta row
$href = Loco_mvc_AdminRouter::generate('plugin-view', [ 'bundle' => $plugin] );
$links[] = '<a href="'.esc_attr($href).'">'.esc_html__('Translate','loco-translate').'</a>';
}
}
catch( Throwable $e ){
// $links[] = esc_html( 'Debug: '.$e->getMessage() );
}
return $links;
}
/**
* Purge in-memory caches that may be persisted by object caching plugins
*/
private function purge_wp_cache(){
global $wp_object_cache;
if( function_exists('wp_cache_delete') && is_object($wp_object_cache) && method_exists($wp_object_cache,'delete') ){
wp_cache_delete('plugins','loco');
}
}
/**
* pre_update_option_{$option} filter callback for $option = "active_plugins"
*/
public function filter_pre_update_option_active_plugins( ?array $value = null ){
$this->purge_wp_cache();
return $value;
}
/**
* pre_update_site_option_{$option} filter callback for $option = "active_sitewide_plugins"
*/
public function filter_pre_update_site_option_active_sitewide_plugins( ?array $value = null ){
$this->purge_wp_cache();
return $value;
}
/**
* heartbeat_received filter callback
*/
public function filter_heartbeat_received( ?array $response = null, ?array $data = null ){
if( is_array($data) && array_key_exists('loco-translate',$data) ){
$nonces = $data['loco-translate']['nonces'] ?? [];
foreach( $nonces as $action => $value ){
// Refresh nonce if it's either expired, or in its second tick.
// Ajax controllers check user permissions before nonce is checked.
if( 1 !== wp_verify_nonce($value,$action) ){
$nonces[$action] = wp_create_nonce($action);
}
}
$response['loco-translate']['nonces'] = $nonces;
}
return $response;
}
/**
* deactivate_plugin action callback
*
public function on_deactivate_plugin( $plugin, $network = false ){
if( loco_plugin_self() === $plugin ){
// TODO flush all our transient cache entries
// "DELETE FROM ___ WHERE `option_name` LIKE '_transient_loco_%' OR `option_name` LIKE '_transient_timeout_loco_%'";
}
}*/
/*public function filter_all( $hook ){
error_log( $hook, 0 );
}*/
}