1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853 |
- <?php
- /**
- * Plugin installation and activation for WordPress themes.
- *
- * Please note that this is a drop-in library for a theme or plugin.
- * The authors of this library (Thomas, Gary and Juliette) are NOT responsible
- * for the support of your plugin or theme. Please contact the plugin
- * or theme author for support.
- *
- * @package TGM-Plugin-Activation
- * @version 2.6.1
- * @link http://tgmpluginactivation.com/
- * @author Thomas Griffin, Gary Jones, Juliette Reinders Folmer
- * @copyright Copyright (c) 2011, Thomas Griffin
- * @license GPL-2.0+
- */
- /*
- Copyright 2011 Thomas Griffin (thomasgriffinmedia.com)
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License, version 2, as
- published by the Free Software Foundation.
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
- */
- if ( ! class_exists( 'TGM_Plugin_Activation' ) ) {
- /**
- * Automatic plugin installation and activation library.
- *
- * Creates a way to automatically install and activate plugins from within themes.
- * The plugins can be either bundled, downloaded from the WordPress
- * Plugin Repository or downloaded from another external source.
- *
- * @since 1.0.0
- *
- * @package TGM-Plugin-Activation
- * @author Thomas Griffin
- * @author Gary Jones
- */
- class TGM_Plugin_Activation {
- /**
- * TGMPA version number.
- *
- * @since 2.5.0
- *
- * @const string Version number.
- */
- const TGMPA_VERSION = '2.6.1';
- /**
- * Regular expression to test if a URL is a WP plugin repo URL.
- *
- * @const string Regex.
- *
- * @since 2.5.0
- */
- const WP_REPO_REGEX = '|^http[s]?://wordpress\.org/(?:extend/)?plugins/|';
- /**
- * Arbitrary regular expression to test if a string starts with a URL.
- *
- * @const string Regex.
- *
- * @since 2.5.0
- */
- const IS_URL_REGEX = '|^http[s]?://|';
- /**
- * Holds a copy of itself, so it can be referenced by the class name.
- *
- * @since 1.0.0
- *
- * @var TGM_Plugin_Activation
- */
- public static $instance;
- /**
- * Holds arrays of plugin details.
- *
- * @since 1.0.0
- * @since 2.5.0 the array has the plugin slug as an associative key.
- *
- * @var array
- */
- public $plugins = array();
- /**
- * Holds arrays of plugin names to use to sort the plugins array.
- *
- * @since 2.5.0
- *
- * @var array
- */
- protected $sort_order = array();
- /**
- * Whether any plugins have the 'force_activation' setting set to true.
- *
- * @since 2.5.0
- *
- * @var bool
- */
- protected $has_forced_activation = false;
- /**
- * Whether any plugins have the 'force_deactivation' setting set to true.
- *
- * @since 2.5.0
- *
- * @var bool
- */
- protected $has_forced_deactivation = false;
- /**
- * Name of the unique ID to hash notices.
- *
- * @since 2.4.0
- *
- * @var string
- */
- public $id = 'tgmpa';
- /**
- * Name of the query-string argument for the admin page.
- *
- * @since 1.0.0
- *
- * @var string
- */
- protected $menu = 'tgmpa-install-plugins';
- /**
- * Parent menu file slug.
- *
- * @since 2.5.0
- *
- * @var string
- */
- public $parent_slug = 'themes.php';
- /**
- * Capability needed to view the plugin installation menu item.
- *
- * @since 2.5.0
- *
- * @var string
- */
- public $capability = 'edit_theme_options';
- /**
- * Default absolute path to folder containing bundled plugin zip files.
- *
- * @since 2.0.0
- *
- * @var string Absolute path prefix to zip file location for bundled plugins. Default is empty string.
- */
- public $default_path = '';
- /**
- * Flag to show admin notices or not.
- *
- * @since 2.1.0
- *
- * @var boolean
- */
- public $has_notices = true;
- /**
- * Flag to determine if the user can dismiss the notice nag.
- *
- * @since 2.4.0
- *
- * @var boolean
- */
- public $dismissable = true;
- /**
- * Message to be output above nag notice if dismissable is false.
- *
- * @since 2.4.0
- *
- * @var string
- */
- public $dismiss_msg = '';
- /**
- * Flag to set automatic activation of plugins. Off by default.
- *
- * @since 2.2.0
- *
- * @var boolean
- */
- public $is_automatic = false;
- /**
- * Optional message to display before the plugins table.
- *
- * @since 2.2.0
- *
- * @var string Message filtered by wp_kses_post(). Default is empty string.
- */
- public $message = '';
- /**
- * Holds configurable array of strings.
- *
- * Default values are added in the constructor.
- *
- * @since 2.0.0
- *
- * @var array
- */
- public $strings = array();
- /**
- * Holds the version of WordPress.
- *
- * @since 2.4.0
- *
- * @var int
- */
- public $wp_version;
- /**
- * Holds the hook name for the admin page.
- *
- * @since 2.5.0
- *
- * @var string
- */
- public $page_hook;
- /**
- * Adds a reference of this object to $instance, populates default strings,
- * does the tgmpa_init action hook, and hooks in the interactions to init.
- *
- * {@internal This method should be `protected`, but as too many TGMPA implementations
- * haven't upgraded beyond v2.3.6 yet, this gives backward compatibility issues.
- * Reverted back to public for the time being.}}
- *
- * @since 1.0.0
- *
- * @see TGM_Plugin_Activation::init()
- */
- public function __construct() {
- // Set the current WordPress version.
- $this->wp_version = $GLOBALS['wp_version'];
- // Announce that the class is ready, and pass the object (for advanced use).
- do_action_ref_array( 'tgmpa_init', array( $this ) );
- /*
- * Load our text domain and allow for overloading the fall-back file.
- *
- * {@internal IMPORTANT! If this code changes, review the regex in the custom TGMPA
- * generator on the website.}}
- */
- add_action( 'init', array( $this, 'load_textdomain' ), 5 );
- add_filter( 'load_textdomain_mofile', array( $this, 'overload_textdomain_mofile' ), 10, 2 );
- // When the rest of WP has loaded, kick-start the rest of the class.
- add_action( 'init', array( $this, 'init' ) );
- }
- /**
- * Magic method to (not) set protected properties from outside of this class.
- *
- * {@internal hackedihack... There is a serious bug in v2.3.2 - 2.3.6 where the `menu` property
- * is being assigned rather than tested in a conditional, effectively rendering it useless.
- * This 'hack' prevents this from happening.}}
- *
- * @see https://github.com/TGMPA/TGM-Plugin-Activation/blob/2.3.6/tgm-plugin-activation/class-tgm-plugin-activation.php#L1593
- *
- * @since 2.5.2
- *
- * @param string $name Name of an inaccessible property.
- * @param mixed $value Value to assign to the property.
- * @return void Silently fail to set the property when this is tried from outside of this class context.
- * (Inside this class context, the __set() method if not used as there is direct access.)
- */
- public function __set( $name, $value ) {
- return;
- }
- /**
- * Magic method to get the value of a protected property outside of this class context.
- *
- * @since 2.5.2
- *
- * @param string $name Name of an inaccessible property.
- * @return mixed The property value.
- */
- public function __get( $name ) {
- return $this->{$name};
- }
- /**
- * Initialise the interactions between this class and WordPress.
- *
- * Hooks in three new methods for the class: admin_menu, notices and styles.
- *
- * @since 2.0.0
- *
- * @see TGM_Plugin_Activation::admin_menu()
- * @see TGM_Plugin_Activation::notices()
- * @see TGM_Plugin_Activation::styles()
- */
- public function init() {
- /**
- * By default TGMPA only loads on the WP back-end and not in an Ajax call. Using this filter
- * you can overrule that behaviour.
- *
- * @since 2.5.0
- *
- * @param bool $load Whether or not TGMPA should load.
- * Defaults to the return of `is_admin() && ! defined( 'DOING_AJAX' )`.
- */
- if ( true !== apply_filters( 'tgmpa_load', ( is_admin() && ! defined( 'DOING_AJAX' ) ) ) ) {
- return;
- }
- // Load class strings.
- $this->strings = array(
- 'page_title' => __( 'Install Required Plugins', 'tgmpa' ),
- 'menu_title' => __( 'Install Plugins', 'tgmpa' ),
- /* translators: %s: plugin name. */
- 'installing' => __( 'Installing Plugin: %s', 'tgmpa' ),
- /* translators: %s: plugin name. */
- 'updating' => __( 'Updating Plugin: %s', 'tgmpa' ),
- 'oops' => __( 'Something went wrong with the plugin API.', 'tgmpa' ),
- 'notice_can_install_required' => _n_noop(
- /* translators: 1: plugin name(s). */
- 'This theme requires the following plugin: %1$s.',
- 'This theme requires the following plugins: %1$s.',
- 'tgmpa'
- ),
- 'notice_can_install_recommended' => _n_noop(
- /* translators: 1: plugin name(s). */
- 'This theme recommends the following plugin: %1$s.',
- 'This theme recommends the following plugins: %1$s.',
- 'tgmpa'
- ),
- 'notice_ask_to_update' => _n_noop(
- /* translators: 1: plugin name(s). */
- 'The following plugin needs to be updated to its latest version to ensure maximum compatibility with this theme: %1$s.',
- 'The following plugins need to be updated to their latest version to ensure maximum compatibility with this theme: %1$s.',
- 'tgmpa'
- ),
- 'notice_ask_to_update_maybe' => _n_noop(
- /* translators: 1: plugin name(s). */
- 'There is an update available for: %1$s.',
- 'There are updates available for the following plugins: %1$s.',
- 'tgmpa'
- ),
- 'notice_can_activate_required' => _n_noop(
- /* translators: 1: plugin name(s). */
- 'The following required plugin is currently inactive: %1$s.',
- 'The following required plugins are currently inactive: %1$s.',
- 'tgmpa'
- ),
- 'notice_can_activate_recommended' => _n_noop(
- /* translators: 1: plugin name(s). */
- 'The following recommended plugin is currently inactive: %1$s.',
- 'The following recommended plugins are currently inactive: %1$s.',
- 'tgmpa'
- ),
- 'install_link' => _n_noop(
- 'Begin installing plugin',
- 'Begin installing plugins',
- 'tgmpa'
- ),
- 'update_link' => _n_noop(
- 'Begin updating plugin',
- 'Begin updating plugins',
- 'tgmpa'
- ),
- 'activate_link' => _n_noop(
- 'Begin activating plugin',
- 'Begin activating plugins',
- 'tgmpa'
- ),
- 'return' => __( 'Return to Required Plugins Installer', 'tgmpa' ),
- 'dashboard' => __( 'Return to the Dashboard', 'tgmpa' ),
- 'plugin_activated' => __( 'Plugin activated successfully.', 'tgmpa' ),
- 'activated_successfully' => __( 'The following plugin was activated successfully:', 'tgmpa' ),
- /* translators: 1: plugin name. */
- 'plugin_already_active' => __( 'No action taken. Plugin %1$s was already active.', 'tgmpa' ),
- /* translators: 1: plugin name. */
- 'plugin_needs_higher_version' => __( 'Plugin not activated. A higher version of %s is needed for this theme. Please update the plugin.', 'tgmpa' ),
- /* translators: 1: dashboard link. */
- 'complete' => __( 'All plugins installed and activated successfully. %1$s', 'tgmpa' ),
- 'dismiss' => __( 'Dismiss this notice', 'tgmpa' ),
- 'notice_cannot_install_activate' => __( 'There are one or more required or recommended plugins to install, update or activate.', 'tgmpa' ),
- 'contact_admin' => __( 'Please contact the administrator of this site for help.', 'tgmpa' ),
- );
- do_action( 'tgmpa_register' );
- /* After this point, the plugins should be registered and the configuration set. */
- // Proceed only if we have plugins to handle.
- if ( empty( $this->plugins ) || ! is_array( $this->plugins ) ) {
- return;
- }
- // Set up the menu and notices if we still have outstanding actions.
- if ( true !== $this->is_tgmpa_complete() ) {
- // Sort the plugins.
- array_multisort( $this->sort_order, SORT_ASC, $this->plugins );
- add_action( 'admin_menu', array( $this, 'admin_menu' ) );
- add_action( 'admin_head', array( $this, 'dismiss' ) );
- // Prevent the normal links from showing underneath a single install/update page.
- add_filter( 'install_plugin_complete_actions', array( $this, 'actions' ) );
- add_filter( 'update_plugin_complete_actions', array( $this, 'actions' ) );
- if ( $this->has_notices ) {
- add_action( 'admin_notices', array( $this, 'notices' ) );
- add_action( 'admin_init', array( $this, 'admin_init' ), 1 );
- add_action( 'admin_enqueue_scripts', array( $this, 'thickbox' ) );
- }
- }
- // If needed, filter plugin action links.
- add_action( 'load-plugins.php', array( $this, 'add_plugin_action_link_filters' ), 1 );
- // Make sure things get reset on switch theme.
- add_action( 'switch_theme', array( $this, 'flush_plugins_cache' ) );
- if ( $this->has_notices ) {
- add_action( 'switch_theme', array( $this, 'update_dismiss' ) );
- }
- // Setup the force activation hook.
- if ( true === $this->has_forced_activation ) {
- add_action( 'admin_init', array( $this, 'force_activation' ) );
- }
- // Setup the force deactivation hook.
- if ( true === $this->has_forced_deactivation ) {
- add_action( 'switch_theme', array( $this, 'force_deactivation' ) );
- }
- }
- /**
- * Load translations.
- *
- * @since 2.6.0
- *
- * (@internal Uses `load_theme_textdomain()` rather than `load_plugin_textdomain()` to
- * get round the different ways of handling the path and deprecated notices being thrown
- * and such. For plugins, the actual file name will be corrected by a filter.}}
- *
- * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
- * generator on the website.}}
- */
- public function load_textdomain() {
- if ( is_textdomain_loaded( 'tgmpa' ) ) {
- return;
- }
- if ( false !== strpos( __FILE__, WP_PLUGIN_DIR ) || false !== strpos( __FILE__, WPMU_PLUGIN_DIR ) ) {
- // Plugin, we'll need to adjust the file name.
- add_action( 'load_textdomain_mofile', array( $this, 'correct_plugin_mofile' ), 10, 2 );
- load_theme_textdomain( 'tgmpa', dirname( __FILE__ ) . '/languages' );
- remove_action( 'load_textdomain_mofile', array( $this, 'correct_plugin_mofile' ), 10 );
- } else {
- load_theme_textdomain( 'tgmpa', dirname( __FILE__ ) . '/languages' );
- }
- }
- /**
- * Correct the .mo file name for (must-use) plugins.
- *
- * Themese use `/path/{locale}.mo` while plugins use `/path/{text-domain}-{locale}.mo`.
- *
- * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
- * generator on the website.}}
- *
- * @since 2.6.0
- *
- * @param string $mofile Full path to the target mofile.
- * @param string $domain The domain for which a language file is being loaded.
- * @return string $mofile
- */
- public function correct_plugin_mofile( $mofile, $domain ) {
- // Exit early if not our domain (just in case).
- if ( 'tgmpa' !== $domain ) {
- return $mofile;
- }
- return preg_replace( '`/([a-z]{2}_[A-Z]{2}.mo)$`', '/tgmpa-$1', $mofile );
- }
- /**
- * Potentially overload the fall-back translation file for the current language.
- *
- * WP, by default since WP 3.7, will load a local translation first and if none
- * can be found, will try and find a translation in the /wp-content/languages/ directory.
- * As this library is theme/plugin agnostic, translation files for TGMPA can exist both
- * in the WP_LANG_DIR /plugins/ subdirectory as well as in the /themes/ subdirectory.
- *
- * This method makes sure both directories are checked.
- *
- * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
- * generator on the website.}}
- *
- * @since 2.6.0
- *
- * @param string $mofile Full path to the target mofile.
- * @param string $domain The domain for which a language file is being loaded.
- * @return string $mofile
- */
- public function overload_textdomain_mofile( $mofile, $domain ) {
- // Exit early if not our domain, not a WP_LANG_DIR load or if the file exists and is readable.
- if ( 'tgmpa' !== $domain || false === strpos( $mofile, WP_LANG_DIR ) || @is_readable( $mofile ) ) {
- return $mofile;
- }
- // Current fallback file is not valid, let's try the alternative option.
- if ( false !== strpos( $mofile, '/themes/' ) ) {
- return str_replace( '/themes/', '/plugins/', $mofile );
- } elseif ( false !== strpos( $mofile, '/plugins/' ) ) {
- return str_replace( '/plugins/', '/themes/', $mofile );
- } else {
- return $mofile;
- }
- }
- /**
- * Hook in plugin action link filters for the WP native plugins page.
- *
- * - Prevent activation of plugins which don't meet the minimum version requirements.
- * - Prevent deactivation of force-activated plugins.
- * - Add update notice if update available.
- *
- * @since 2.5.0
- */
- public function add_plugin_action_link_filters() {
- foreach ( $this->plugins as $slug => $plugin ) {
- if ( false === $this->can_plugin_activate( $slug ) ) {
- add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_activate' ), 20 );
- }
- if ( true === $plugin['force_activation'] ) {
- add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_deactivate' ), 20 );
- }
- if ( false !== $this->does_plugin_require_update( $slug ) ) {
- add_filter( 'plugin_action_links_' . $plugin['file_path'], array( $this, 'filter_plugin_action_links_update' ), 20 );
- }
- }
- }
- /**
- * Remove the 'Activate' link on the WP native plugins page if the plugin does not meet the
- * minimum version requirements.
- *
- * @since 2.5.0
- *
- * @param array $actions Action links.
- * @return array
- */
- public function filter_plugin_action_links_activate( $actions ) {
- unset( $actions['activate'] );
- return $actions;
- }
- /**
- * Remove the 'Deactivate' link on the WP native plugins page if the plugin has been set to force activate.
- *
- * @since 2.5.0
- *
- * @param array $actions Action links.
- * @return array
- */
- public function filter_plugin_action_links_deactivate( $actions ) {
- unset( $actions['deactivate'] );
- return $actions;
- }
- /**
- * Add a 'Requires update' link on the WP native plugins page if the plugin does not meet the
- * minimum version requirements.
- *
- * @since 2.5.0
- *
- * @param array $actions Action links.
- * @return array
- */
- public function filter_plugin_action_links_update( $actions ) {
- $actions['update'] = sprintf(
- '<a href="%1$s" title="%2$s" class="edit">%3$s</a>',
- esc_url( $this->get_tgmpa_status_url( 'update' ) ),
- esc_attr__( 'This plugin needs to be updated to be compatible with your theme.', 'tgmpa' ),
- esc_html__( 'Update Required', 'tgmpa' )
- );
- return $actions;
- }
- /**
- * Handles calls to show plugin information via links in the notices.
- *
- * We get the links in the admin notices to point to the TGMPA page, rather
- * than the typical plugin-install.php file, so we can prepare everything
- * beforehand.
- *
- * WP does not make it easy to show the plugin information in the thickbox -
- * here we have to require a file that includes a function that does the
- * main work of displaying it, enqueue some styles, set up some globals and
- * finally call that function before exiting.
- *
- * Down right easy once you know how...
- *
- * Returns early if not the TGMPA page.
- *
- * @since 2.1.0
- *
- * @global string $tab Used as iframe div class names, helps with styling
- * @global string $body_id Used as the iframe body ID, helps with styling
- *
- * @return null Returns early if not the TGMPA page.
- */
- public function admin_init() {
- if ( ! $this->is_tgmpa_page() ) {
- return;
- }
- if ( isset( $_REQUEST['tab'] ) && 'plugin-information' === $_REQUEST['tab'] ) {
- // Needed for install_plugin_information().
- require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
- wp_enqueue_style( 'plugin-install' );
- global $tab, $body_id;
- $body_id = 'plugin-information';
- // @codingStandardsIgnoreStart
- $tab = 'plugin-information';
- // @codingStandardsIgnoreEnd
- install_plugin_information();
- exit;
- }
- }
- /**
- * Enqueue thickbox scripts/styles for plugin info.
- *
- * Thickbox is not automatically included on all admin pages, so we must
- * manually enqueue it for those pages.
- *
- * Thickbox is only loaded if the user has not dismissed the admin
- * notice or if there are any plugins left to install and activate.
- *
- * @since 2.1.0
- */
- public function thickbox() {
- if ( ! get_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, true ) ) {
- add_thickbox();
- }
- }
- /**
- * Adds submenu page if there are plugin actions to take.
- *
- * This method adds the submenu page letting users know that a required
- * plugin needs to be installed.
- *
- * This page disappears once the plugin has been installed and activated.
- *
- * @since 1.0.0
- *
- * @see TGM_Plugin_Activation::init()
- * @see TGM_Plugin_Activation::install_plugins_page()
- *
- * @return null Return early if user lacks capability to install a plugin.
- */
- public function admin_menu() {
- // Make sure privileges are correct to see the page.
- if ( ! current_user_can( 'install_plugins' ) ) {
- return;
- }
- $args = apply_filters(
- 'tgmpa_admin_menu_args',
- array(
- 'parent_slug' => $this->parent_slug, // Parent Menu slug.
- 'page_title' => $this->strings['page_title'], // Page title.
- 'menu_title' => $this->strings['menu_title'], // Menu title.
- 'capability' => $this->capability, // Capability.
- 'menu_slug' => $this->menu, // Menu slug.
- 'function' => array( $this, 'install_plugins_page' ), // Callback.
- )
- );
- $this->add_admin_menu( $args );
- }
- /**
- * Add the menu item.
- *
- * {@internal IMPORTANT! If this function changes, review the regex in the custom TGMPA
- * generator on the website.}}
- *
- * @since 2.5.0
- *
- * @param array $args Menu item configuration.
- */
- protected function add_admin_menu( array $args ) {
- if ( has_filter( 'tgmpa_admin_menu_use_add_theme_page' ) ) {
- _deprecated_function( 'The "tgmpa_admin_menu_use_add_theme_page" filter', '2.5.0', esc_html__( 'Set the parent_slug config variable instead.', 'tgmpa' ) );
- }
- if ( 'themes.php' === $this->parent_slug ) {
- $this->page_hook = call_user_func( 'add_theme_page', $args['page_title'], $args['menu_title'], $args['capability'], $args['menu_slug'], $args['function'] );
- } else {
- $this->page_hook = call_user_func( 'add_submenu_page', $args['parent_slug'], $args['page_title'], $args['menu_title'], $args['capability'], $args['menu_slug'], $args['function'] );
- }
- }
- /**
- * Echoes plugin installation form.
- *
- * This method is the callback for the admin_menu method function.
- * This displays the admin page and form area where the user can select to install and activate the plugin.
- * Aborts early if we're processing a plugin installation action.
- *
- * @since 1.0.0
- *
- * @return null Aborts early if we're processing a plugin installation action.
- */
- public function install_plugins_page() {
- // Store new instance of plugin table in object.
- $plugin_table = new TGMPA_List_Table;
- // Return early if processing a plugin installation action.
- if ( ( ( 'tgmpa-bulk-install' === $plugin_table->current_action() || 'tgmpa-bulk-update' === $plugin_table->current_action() ) && $plugin_table->process_bulk_actions() ) || $this->do_plugin_install() ) {
- return;
- }
- // Force refresh of available plugin information so we'll know about manual updates/deletes.
- wp_clean_plugins_cache( false );
- ?>
- <div class="tgmpa wrap">
- <h1><?php echo esc_html( get_admin_page_title() ); ?></h1>
- <?php $plugin_table->prepare_items(); ?>
- <?php
- if ( ! empty( $this->message ) && is_string( $this->message ) ) {
- echo wp_kses_post( $this->message );
- }
- ?>
- <?php $plugin_table->views(); ?>
- <form id="tgmpa-plugins" action="" method="post">
- <input type="hidden" name="tgmpa-page" value="<?php echo esc_attr( $this->menu ); ?>" />
- <input type="hidden" name="plugin_status" value="<?php echo esc_attr( $plugin_table->view_context ); ?>" />
- <?php $plugin_table->display(); ?>
- </form>
- </div>
- <?php
- }
- /**
- * Installs, updates or activates a plugin depending on the action link clicked by the user.
- *
- * Checks the $_GET variable to see which actions have been
- * passed and responds with the appropriate method.
- *
- * Uses WP_Filesystem to process and handle the plugin installation
- * method.
- *
- * @since 1.0.0
- *
- * @uses WP_Filesystem
- * @uses WP_Error
- * @uses WP_Upgrader
- * @uses Plugin_Upgrader
- * @uses Plugin_Installer_Skin
- * @uses Plugin_Upgrader_Skin
- *
- * @return boolean True on success, false on failure.
- */
- protected function do_plugin_install() {
- if ( empty( $_GET['plugin'] ) ) {
- return false;
- }
- // All plugin information will be stored in an array for processing.
- $slug = $this->sanitize_key( urldecode( $_GET['plugin'] ) );
- if ( ! isset( $this->plugins[ $slug ] ) ) {
- return false;
- }
- // Was an install or upgrade action link clicked?
- if ( ( isset( $_GET['tgmpa-install'] ) && 'install-plugin' === $_GET['tgmpa-install'] ) || ( isset( $_GET['tgmpa-update'] ) && 'update-plugin' === $_GET['tgmpa-update'] ) ) {
- $install_type = 'install';
- if ( isset( $_GET['tgmpa-update'] ) && 'update-plugin' === $_GET['tgmpa-update'] ) {
- $install_type = 'update';
- }
- check_admin_referer( 'tgmpa-' . $install_type, 'tgmpa-nonce' );
- // Pass necessary information via URL if WP_Filesystem is needed.
- $url = wp_nonce_url(
- add_query_arg(
- array(
- 'plugin' => urlencode( $slug ),
- 'tgmpa-' . $install_type => $install_type . '-plugin',
- ),
- $this->get_tgmpa_url()
- ),
- 'tgmpa-' . $install_type,
- 'tgmpa-nonce'
- );
- $method = ''; // Leave blank so WP_Filesystem can populate it as necessary.
- if ( false === ( $creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, array() ) ) ) {
- return true;
- }
- if ( ! WP_Filesystem( $creds ) ) {
- request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, array() ); // Setup WP_Filesystem.
- return true;
- }
- /* If we arrive here, we have the filesystem. */
- // Prep variables for Plugin_Installer_Skin class.
- $extra = array();
- $extra['slug'] = $slug; // Needed for potentially renaming of directory name.
- $source = $this->get_download_url( $slug );
- $api = ( 'repo' === $this->plugins[ $slug ]['source_type'] ) ? $this->get_plugins_api( $slug ) : null;
- $api = ( false !== $api ) ? $api : null;
- $url = add_query_arg(
- array(
- 'action' => $install_type . '-plugin',
- 'plugin' => urlencode( $slug ),
- ),
- 'update.php'
- );
- if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
- require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
- }
- $title = ( 'update' === $install_type ) ? $this->strings['updating'] : $this->strings['installing'];
- $skin_args = array(
- 'type' => ( 'bundled' !== $this->plugins[ $slug ]['source_type'] ) ? 'web' : 'upload',
- 'title' => sprintf( $title, $this->plugins[ $slug ]['name'] ),
- 'url' => esc_url_raw( $url ),
- 'nonce' => $install_type . '-plugin_' . $slug,
- 'plugin' => '',
- 'api' => $api,
- 'extra' => $extra,
- );
- unset( $title );
- if ( 'update' === $install_type ) {
- $skin_args['plugin'] = $this->plugins[ $slug ]['file_path'];
- $skin = new Plugin_Upgrader_Skin( $skin_args );
- } else {
- $skin = new Plugin_Installer_Skin( $skin_args );
- }
- // Create a new instance of Plugin_Upgrader.
- $upgrader = new Plugin_Upgrader( $skin );
- // Perform the action and install the plugin from the $source urldecode().
- add_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1, 3 );
- if ( 'update' === $install_type ) {
- // Inject our info into the update transient.
- $to_inject = array( $slug => $this->plugins[ $slug ] );
- $to_inject[ $slug ]['source'] = $source;
- $this->inject_update_info( $to_inject );
- $upgrader->upgrade( $this->plugins[ $slug ]['file_path'] );
- } else {
- $upgrader->install( $source );
- }
- remove_filter( 'upgrader_source_selection', array( $this, 'maybe_adjust_source_dir' ), 1 );
- // Make sure we have the correct file path now the plugin is installed/updated.
- $this->populate_file_path( $slug );
- // Only activate plugins if the config option is set to true and the plugin isn't
- // already active (upgrade).
- if ( $this->is_automatic && ! $this->is_plugin_active( $slug ) ) {
- $plugin_activate = $upgrader->plugin_info(); // Grab the plugin info from the Plugin_Upgrader method.
- if ( false === $this->activate_single_plugin( $plugin_activate, $slug, true ) ) {
- return true; // Finish execution of the function early as we encountered an error.
- }
- }
- $this->show_tgmpa_version();
- // Display message based on if all plugins are now active or not.
- if ( $this->is_tgmpa_complete() ) {
- echo '<p>', sprintf( esc_html( $this->strings['complete'] ), '<a href="' . esc_url( self_admin_url() ) . '">' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>' ), '</p>';
- echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
- } else {
- echo '<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>';
- }
- return true;
- } elseif ( isset( $this->plugins[ $slug ]['file_path'], $_GET['tgmpa-activate'] ) && 'activate-plugin' === $_GET['tgmpa-activate'] ) {
- // Activate action link was clicked.
- check_admin_referer( 'tgmpa-activate', 'tgmpa-nonce' );
- if ( false === $this->activate_single_plugin( $this->plugins[ $slug ]['file_path'], $slug ) ) {
- return true; // Finish execution of the function early as we encountered an error.
- }
- }
- return false;
- }
- /**
- * Inject information into the 'update_plugins' site transient as WP checks that before running an update.
- *
- * @since 2.5.0
- *
- * @param array $plugins The plugin information for the plugins which are to be updated.
- */
- public function inject_update_info( $plugins ) {
- $repo_updates = get_site_transient( 'update_plugins' );
- if ( ! is_object( $repo_updates ) ) {
- $repo_updates = new stdClass;
- }
- foreach ( $plugins as $slug => $plugin ) {
- $file_path = $plugin['file_path'];
- if ( empty( $repo_updates->response[ $file_path ] ) ) {
- $repo_updates->response[ $file_path ] = new stdClass;
- }
- // We only really need to set package, but let's do all we can in case WP changes something.
- $repo_updates->response[ $file_path ]->slug = $slug;
- $repo_updates->response[ $file_path ]->plugin = $file_path;
- $repo_updates->response[ $file_path ]->new_version = $plugin['version'];
- $repo_updates->response[ $file_path ]->package = $plugin['source'];
- if ( empty( $repo_updates->response[ $file_path ]->url ) && ! empty( $plugin['external_url'] ) ) {
- $repo_updates->response[ $file_path ]->url = $plugin['external_url'];
- }
- }
- set_site_transient( 'update_plugins', $repo_updates );
- }
- /**
- * Adjust the plugin directory name if necessary.
- *
- * The final destination directory of a plugin is based on the subdirectory name found in the
- * (un)zipped source. In some cases - most notably GitHub repository plugin downloads -, this
- * subdirectory name is not the same as the expected slug and the plugin will not be recognized
- * as installed. This is fixed by adjusting the temporary unzipped source subdirectory name to
- * the expected plugin slug.
- *
- * @since 2.5.0
- *
- * @param string $source Path to upgrade/zip-file-name.tmp/subdirectory/.
- * @param string $remote_source Path to upgrade/zip-file-name.tmp.
- * @param \WP_Upgrader $upgrader Instance of the upgrader which installs the plugin.
- * @return string $source
- */
- public function maybe_adjust_source_dir( $source, $remote_source, $upgrader ) {
- if ( ! $this->is_tgmpa_page() || ! is_object( $GLOBALS['wp_filesystem'] ) ) {
- return $source;
- }
- // Check for single file plugins.
- $source_files = array_keys( $GLOBALS['wp_filesystem']->dirlist( $remote_source ) );
- if ( 1 === count( $source_files ) && false === $GLOBALS['wp_filesystem']->is_dir( $source ) ) {
- return $source;
- }
- // Multi-file plugin, let's see if the directory is correctly named.
- $desired_slug = '';
- // Figure out what the slug is supposed to be.
- if ( false === $upgrader->bulk && ! empty( $upgrader->skin->options['extra']['slug'] ) ) {
- $desired_slug = $upgrader->skin->options['extra']['slug'];
- } else {
- // Bulk installer contains less info, so fall back on the info registered here.
- foreach ( $this->plugins as $slug => $plugin ) {
- if ( ! empty( $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) && $plugin['name'] === $upgrader->skin->plugin_names[ $upgrader->skin->i ] ) {
- $desired_slug = $slug;
- break;
- }
- }
- unset( $slug, $plugin );
- }
- if ( ! empty( $desired_slug ) ) {
- $subdir_name = untrailingslashit( str_replace( trailingslashit( $remote_source ), '', $source ) );
- if ( ! empty( $subdir_name ) && $subdir_name !== $desired_slug ) {
- $from_path = untrailingslashit( $source );
- $to_path = trailingslashit( $remote_source ) . $desired_slug;
- if ( true === $GLOBALS['wp_filesystem']->move( $from_path, $to_path ) ) {
- return trailingslashit( $to_path );
- } else {
- return new WP_Error( 'rename_failed', esc_html__( 'The remote plugin package does not contain a folder with the desired slug and renaming did not work.', 'tgmpa' ) . ' ' . esc_html__( 'Please contact the plugin provider and ask them to package their plugin according to the WordPress guidelines.', 'tgmpa' ), array( 'found' => $subdir_name, 'expected' => $desired_slug ) );
- }
- } elseif ( empty( $subdir_name ) ) {
- return new WP_Error( 'packaged_wrong', esc_html__( 'The remote plugin package consists of more than one file, but the files are not packaged in a folder.', 'tgmpa' ) . ' ' . esc_html__( 'Please contact the plugin provider and ask them to package their plugin according to the WordPress guidelines.', 'tgmpa' ), array( 'found' => $subdir_name, 'expected' => $desired_slug ) );
- }
- }
- return $source;
- }
- /**
- * Activate a single plugin and send feedback about the result to the screen.
- *
- * @since 2.5.0
- *
- * @param string $file_path Path within wp-plugins/ to main plugin file.
- * @param string $slug Plugin slug.
- * @param bool $automatic Whether this is an automatic activation after an install. Defaults to false.
- * This determines the styling of the output messages.
- * @return bool False if an error was encountered, true otherwise.
- */
- protected function activate_single_plugin( $file_path, $slug, $automatic = false ) {
- if ( $this->can_plugin_activate( $slug ) ) {
- $activate = activate_plugin( $file_path );
- if ( is_wp_error( $activate ) ) {
- echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>',
- '<p><a href="', esc_url( $this->get_tgmpa_url() ), '" target="_parent">', esc_html( $this->strings['return'] ), '</a></p>';
- return false; // End it here if there is an error with activation.
- } else {
- if ( ! $automatic ) {
- // Make sure message doesn't display again if bulk activation is performed
- // immediately after a single activation.
- if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK.
- echo '<div id="message" class="updated"><p>', esc_html( $this->strings['activated_successfully'] ), ' <strong>', esc_html( $this->plugins[ $slug ]['name'] ), '.</strong></p></div>';
- }
- } else {
- // Simpler message layout for use on the plugin install page.
- echo '<p>', esc_html( $this->strings['plugin_activated'] ), '</p>';
- }
- }
- } elseif ( $this->is_plugin_active( $slug ) ) {
- // No simpler message format provided as this message should never be encountered
- // on the plugin install page.
- echo '<div id="message" class="error"><p>',
- sprintf(
- esc_html( $this->strings['plugin_already_active'] ),
- '<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>'
- ),
- '</p></div>';
- } elseif ( $this->does_plugin_require_update( $slug ) ) {
- if ( ! $automatic ) {
- // Make sure message doesn't display again if bulk activation is performed
- // immediately after a single activation.
- if ( ! isset( $_POST['action'] ) ) { // WPCS: CSRF OK.
- echo '<div id="message" class="error"><p>',
- sprintf(
- esc_html( $this->strings['plugin_needs_higher_version'] ),
- '<strong>' . esc_html( $this->plugins[ $slug ]['name'] ) . '</strong>'
- ),
- '</p></div>';
- }
- } else {
- // Simpler message layout for use on the plugin install page.
- echo '<p>', sprintf( esc_html( $this->strings['plugin_needs_higher_version'] ), esc_html( $this->plugins[ $slug ]['name'] ) ), '</p>';
- }
- }
- return true;
- }
- /**
- * Echoes required plugin notice.
- *
- * Outputs a message telling users that a specific plugin is required for
- * their theme. If appropriate, it includes a link to the form page where
- * users can install and activate the plugin.
- *
- * Returns early if we're on the Install page.
- *
- * @since 1.0.0
- *
- * @global object $current_screen
- *
- * @return null Returns early if we're on the Install page.
- */
- public function notices() {
- // Remove nag on the install page / Return early if the nag message has been dismissed or user < author.
- if ( ( $this->is_tgmpa_page() || $this->is_core_update_page() ) || get_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, true ) || ! current_user_can( apply_filters( 'tgmpa_show_admin_notice_capability', 'publish_posts' ) ) ) {
- return;
- }
- // Store for the plugin slugs by message type.
- $message = array();
- // Initialize counters used to determine plurality of action link texts.
- $install_link_count = 0;
- $update_link_count = 0;
- $activate_link_count = 0;
- $total_required_action_count = 0;
- foreach ( $this->plugins as $slug => $plugin ) {
- if ( $this->is_plugin_active( $slug ) && false === $this->does_plugin_have_update( $slug ) ) {
- continue;
- }
- if ( ! $this->is_plugin_installed( $slug ) ) {
- if ( current_user_can( 'install_plugins' ) ) {
- $install_link_count++;
- if ( true === $plugin['required'] ) {
- $message['notice_can_install_required'][] = $slug;
- } else {
- $message['notice_can_install_recommended'][] = $slug;
- }
- }
- if ( true === $plugin['required'] ) {
- $total_required_action_count++;
- }
- } else {
- if ( ! $this->is_plugin_active( $slug ) && $this->can_plugin_activate( $slug ) ) {
- if ( current_user_can( 'activate_plugins' ) ) {
- $activate_link_count++;
- if ( true === $plugin['required'] ) {
- $message['notice_can_activate_required'][] = $slug;
- } else {
- $message['notice_can_activate_recommended'][] = $slug;
- }
- }
- if ( true === $plugin['required'] ) {
- $total_required_action_count++;
- }
- }
- if ( $this->does_plugin_require_update( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
- if ( current_user_can( 'update_plugins' ) ) {
- $update_link_count++;
- if ( $this->does_plugin_require_update( $slug ) ) {
- $message['notice_ask_to_update'][] = $slug;
- } elseif ( false !== $this->does_plugin_have_update( $slug ) ) {
- $message['notice_ask_to_update_maybe'][] = $slug;
- }
- }
- if ( true === $plugin['required'] ) {
- $total_required_action_count++;
- }
- }
- }
- }
- unset( $slug, $plugin );
- // If we have notices to display, we move forward.
- if ( ! empty( $message ) || $total_required_action_count > 0 ) {
- krsort( $message ); // Sort messages.
- $rendered = '';
- // As add_settings_error() wraps the final message in a <p> and as the final message can't be
- // filtered, using <p>'s in our html would render invalid html output.
- $line_template = '<span style="display: block; margin: 0.5em 0.5em 0 0; clear: both;">%s</span>' . "\n";
- if ( ! current_user_can( 'activate_plugins' ) && ! current_user_can( 'install_plugins' ) && ! current_user_can( 'update_plugins' ) ) {
- $rendered = esc_html( $this->strings['notice_cannot_install_activate'] ) . ' ' . esc_html( $this->strings['contact_admin'] );
- $rendered .= $this->create_user_action_links_for_notice( 0, 0, 0, $line_template );
- } else {
- // If dismissable is false and a message is set, output it now.
- if ( ! $this->dismissable && ! empty( $this->dismiss_msg ) ) {
- $rendered .= sprintf( $line_template, wp_kses_post( $this->dismiss_msg ) );
- }
- // Render the individual message lines for the notice.
- foreach ( $message as $type => $plugin_group ) {
- $linked_plugins = array();
- // Get the external info link for a plugin if one is available.
- foreach ( $plugin_group as $plugin_slug ) {
- $linked_plugins[] = $this->get_info_link( $plugin_slug );
- }
- unset( $plugin_slug );
- $count = count( $plugin_group );
- $linked_plugins = array_map( array( 'TGMPA_Utils', 'wrap_in_em' ), $linked_plugins );
- $last_plugin = array_pop( $linked_plugins ); // Pop off last name to prep for readability.
- $imploded = empty( $linked_plugins ) ? $last_plugin : ( implode( ', ', $linked_plugins ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
- $rendered .= sprintf(
- $line_template,
- sprintf(
- translate_nooped_plural( $this->strings[ $type ], $count, 'tgmpa' ),
- $imploded,
- $count
- )
- );
- }
- unset( $type, $plugin_group, $linked_plugins, $count, $last_plugin, $imploded );
- $rendered .= $this->create_user_action_links_for_notice( $install_link_count, $update_link_count, $activate_link_count, $line_template );
- }
- // Register the nag messages and prepare them to be processed.
- add_settings_error( 'tgmpa', 'tgmpa', $rendered, $this->get_admin_notice_class() );
- }
- // Admin options pages already output settings_errors, so this is to avoid duplication.
- if ( 'options-general' !== $GLOBALS['current_screen']->parent_base ) {
- $this->display_settings_errors();
- }
- }
- /**
- * Generate the user action links for the admin notice.
- *
- * @since 2.6.0
- *
- * @param int $install_count Number of plugins to install.
- * @param int $update_count Number of plugins to update.
- * @param int $activate_count Number of plugins to activate.
- * @param int $line_template Template for the HTML tag to output a line.
- * @return string Action links.
- */
- protected function create_user_action_links_for_notice( $install_count, $update_count, $activate_count, $line_template ) {
- // Setup action links.
- $action_links = array(
- 'install' => '',
- 'update' => '',
- 'activate' => '',
- 'dismiss' => $this->dismissable ? '<a href="' . esc_url( wp_nonce_url( add_query_arg( 'tgmpa-dismiss', 'dismiss_admin_notices' ), 'tgmpa-dismiss-' . get_current_user_id() ) ) . '" class="dismiss-notice" target="_parent">' . esc_html( $this->strings['dismiss'] ) . '</a>' : '',
- );
- $link_template = '<a href="%2$s">%1$s</a>';
- if ( current_user_can( 'install_plugins' ) ) {
- if ( $install_count > 0 ) {
- $action_links['install'] = sprintf(
- $link_template,
- translate_nooped_plural( $this->strings['install_link'], $install_count, 'tgmpa' ),
- esc_url( $this->get_tgmpa_status_url( 'install' ) )
- );
- }
- if ( $update_count > 0 ) {
- $action_links['update'] = sprintf(
- $link_template,
- translate_nooped_plural( $this->strings['update_link'], $update_count, 'tgmpa' ),
- esc_url( $this->get_tgmpa_status_url( 'update' ) )
- );
- }
- }
- if ( current_user_can( 'activate_plugins' ) && $activate_count > 0 ) {
- $action_links['activate'] = sprintf(
- $link_template,
- translate_nooped_plural( $this->strings['activate_link'], $activate_count, 'tgmpa' ),
- esc_url( $this->get_tgmpa_status_url( 'activate' ) )
- );
- }
- $action_links = apply_filters( 'tgmpa_notice_action_links', $action_links );
- $action_links = array_filter( (array) $action_links ); // Remove any empty array items.
- if ( ! empty( $action_links ) ) {
- $action_links = sprintf( $line_template, implode( ' | ', $action_links ) );
- return apply_filters( 'tgmpa_notice_rendered_action_links', $action_links );
- } else {
- return '';
- }
- }
- /**
- * Get admin notice class.
- *
- * Work around all the changes to the various admin notice classes between WP 4.4 and 3.7
- * (lowest supported version by TGMPA).
- *
- * @since 2.6.0
- *
- * @return string
- */
- protected function get_admin_notice_class() {
- if ( ! empty( $this->strings['nag_type'] ) ) {
- return sanitize_html_class( strtolower( $this->strings['nag_type'] ) );
- } else {
- if ( version_compare( $this->wp_version, '4.2', '>=' ) ) {
- return 'notice-warning';
- } elseif ( version_compare( $this->wp_version, '4.1', '>=' ) ) {
- return 'notice';
- } else {
- return 'updated';
- }
- }
- }
- /**
- * Display settings errors and remove those which have been displayed to avoid duplicate messages showing
- *
- * @since 2.5.0
- */
- protected function display_settings_errors() {
- global $wp_settings_errors;
- settings_errors( 'tgmpa' );
- foreach ( (array) $wp_settings_errors as $key => $details ) {
- if ( 'tgmpa' === $details['setting'] ) {
- unset( $wp_settings_errors[ $key ] );
- break;
- }
- }
- }
- /**
- * Register dismissal of admin notices.
- *
- * Acts on the dismiss link in the admin nag messages.
- * If clicked, the admin notice disappears and will no longer be visible to this user.
- *
- * @since 2.1.0
- */
- public function dismiss() {
- if ( isset( $_GET['tgmpa-dismiss'] ) && check_admin_referer( 'tgmpa-dismiss-' . get_current_user_id() ) ) {
- update_user_meta( get_current_user_id(), 'tgmpa_dismissed_notice_' . $this->id, 1 );
- }
- }
- /**
- * Add individual plugin to our collection of plugins.
- *
- * If the required keys are not set or the plugin has already
- * been registered, the plugin is not added.
- *
- * @since 2.0.0
- *
- * @param array|null $plugin Array of plugin arguments or null if invalid argument.
- * @return null Return early if incorrect argument.
- */
- public function register( $plugin ) {
- if ( empty( $plugin['slug'] ) || empty( $plugin['name'] ) ) {
- return;
- }
- if ( empty( $plugin['slug'] ) || ! is_string( $plugin['slug'] ) || isset( $this->plugins[ $plugin['slug'] ] ) ) {
- return;
- }
- $defaults = array(
- 'name' => '', // String
- 'slug' => '', // String
- 'source' => 'repo', // String
- 'required' => false, // Boolean
- 'version' => '', // String
- 'force_activation' => false, // Boolean
- 'force_deactivation' => false, // Boolean
- 'external_url' => '', // String
- 'is_callable' => '', // String|Array.
- );
- // Prepare the received data.
- $plugin = wp_parse_args( $plugin, $defaults );
- // Standardize the received slug.
- $plugin['slug'] = $this->sanitize_key( $plugin['slug'] );
- // Forgive users for using string versions of booleans or floats for version number.
- $plugin['version'] = (string) $plugin['version'];
- $plugin['source'] = empty( $plugin['source'] ) ? 'repo' : $plugin['source'];
- $plugin['required'] = TGMPA_Utils::validate_bool( $plugin['required'] );
- $plugin['force_activation'] = TGMPA_Utils::validate_bool( $plugin['force_activation'] );
- $plugin['force_deactivation'] = TGMPA_Utils::validate_bool( $plugin['force_deactivation'] );
- // Enrich the received data.
- $plugin['file_path'] = $this->_get_plugin_basename_from_slug( $plugin['slug'] );
- $plugin['source_type'] = $this->get_plugin_source_type( $plugin['source'] );
- // Set the class properties.
- $this->plugins[ $plugin['slug'] ] = $plugin;
- $this->sort_order[ $plugin['slug'] ] = $plugin['name'];
- // Should we add the force activation hook ?
- if ( true === $plugin['force_activation'] ) {
- $this->has_forced_activation = true;
- }
- // Should we add the force deactivation hook ?
- if ( true === $plugin['force_deactivation'] ) {
- $this->has_forced_deactivation = true;
- }
- }
- /**
- * Determine what type of source the plugin comes from.
- *
- * @since 2.5.0
- *
- * @param string $source The source of the plugin as provided, either empty (= WP repo), a file path
- * (= bundled) or an external URL.
- * @return string 'repo', 'external', or 'bundled'
- */
- protected function get_plugin_source_type( $source ) {
- if ( 'repo' === $source || preg_match( self::WP_REPO_REGEX, $source ) ) {
- return 'repo';
- } elseif ( preg_match( self::IS_URL_REGEX, $source ) ) {
- return 'external';
- } else {
- return 'bundled';
- }
- }
- /**
- * Sanitizes a string key.
- *
- * Near duplicate of WP Core `sanitize_key()`. The difference is that uppercase characters *are*
- * allowed, so as not to break upgrade paths from non-standard bundled plugins using uppercase
- * characters in the plugin directory path/slug. Silly them.
- *
- * @see https://developer.wordpress.org/reference/hooks/sanitize_key/
- *
- * @since 2.5.0
- *
- * @param string $key String key.
- * @return string Sanitized key
- */
- public function sanitize_key( $key ) {
- $raw_key = $key;
- $key = preg_replace( '`[^A-Za-z0-9_-]`', '', $key );
- /**
- * Filter a sanitized key string.
- *
- * @since 2.5.0
- *
- * @param string $key Sanitized key.
- * @param string $raw_key The key prior to sanitization.
- */
- return apply_filters( 'tgmpa_sanitize_key', $key, $raw_key );
- }
- /**
- * Amend default configuration settings.
- *
- * @since 2.0.0
- *
- * @param array $config Array of config options to pass as class properties.
- */
- public function config( $config ) {
- $keys = array(
- 'id',
- 'default_path',
- 'has_notices',
- 'dismissable',
- 'dismiss_msg',
- 'menu',
- 'parent_slug',
- 'capability',
- 'is_automatic',
- 'message',
- 'strings',
- );
- foreach ( $keys as $key ) {
- if ( isset( $config[ $key ] ) ) {
- if ( is_array( $config[ $key ] ) ) {
- $this->$key = array_merge( $this->$key, $config[ $key ] );
- } else {
- $this->$key = $config[ $key ];
- }
- }
- }
- }
- /**
- * Amend action link after plugin installation.
- *
- * @since 2.0.0
- *
- * @param array $install_actions Existing array of actions.
- * @return false|array Amended array of actions.
- */
- public function actions( $install_actions ) {
- // Remove action links on the TGMPA install page.
- if ( $this->is_tgmpa_page() ) {
- return false;
- }
- return $install_actions;
- }
- /**
- * Flushes the plugins cache on theme switch to prevent stale entries
- * from remaining in the plugin table.
- *
- * @since 2.4.0
- *
- * @param bool $clear_update_cache Optional. Whether to clear the Plugin updates cache.
- * Parameter added in v2.5.0.
- */
- public function flush_plugins_cache( $clear_update_cache = true ) {
- wp_clean_plugins_cache( $clear_update_cache );
- }
- /**
- * Set file_path key for each installed plugin.
- *
- * @since 2.1.0
- *
- * @param string $plugin_slug Optional. If set, only (re-)populates the file path for that specific plugin.
- * Parameter added in v2.5.0.
- */
- public function populate_file_path( $plugin_slug = '' ) {
- if ( ! empty( $plugin_slug ) && is_string( $plugin_slug ) && isset( $this->plugins[ $plugin_slug ] ) ) {
- $this->plugins[ $plugin_slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $plugin_slug );
- } else {
- // Add file_path key for all plugins.
- foreach ( $this->plugins as $slug => $values ) {
- $this->plugins[ $slug ]['file_path'] = $this->_get_plugin_basename_from_slug( $slug );
- }
- }
- }
- /**
- * Helper function to extract the file path of the plugin file from the
- * plugin slug, if the plugin is installed.
- *
- * @since 2.0.0
- *
- * @param string $slug Plugin slug (typically folder name) as provided by the developer.
- * @return string Either file path for plugin if installed, or just the plugin slug.
- */
- protected function _get_plugin_basename_from_slug( $slug ) {
- $keys = array_keys( $this->get_plugins() );
- foreach ( $keys as $key ) {
- if ( preg_match( '|^' . $slug . '/|', $key ) ) {
- return $key;
- }
- }
- return $slug;
- }
- /**
- * Retrieve plugin data, given the plugin name.
- *
- * Loops through the registered plugins looking for $name. If it finds it,
- * it returns the $data from that plugin. Otherwise, returns false.
- *
- * @since 2.1.0
- *
- * @param string $name Name of the plugin, as it was registered.
- * @param string $data Optional. Array key of plugin data to return. Default is slug.
- * @return string|boolean Plugin slug if found, false otherwise.
- */
- public function _get_plugin_data_from_name( $name, $data = 'slug' ) {
- foreach ( $this->plugins as $values ) {
- if ( $name === $values['name'] && isset( $values[ $data ] ) ) {
- return $values[ $data ];
- }
- }
- return false;
- }
- /**
- * Retrieve the download URL for a package.
- *
- * @since 2.5.0
- *
- * @param string $slug Plugin slug.
- * @return string Plugin download URL or path to local file or empty string if undetermined.
- */
- public function get_download_url( $slug ) {
- $dl_source = '';
- switch ( $this->plugins[ $slug ]['source_type'] ) {
- case 'repo':
- return $this->get_wp_repo_download_url( $slug );
- case 'external':
- return $this->plugins[ $slug ]['source'];
- case 'bundled':
- return $this->default_path . $this->plugins[ $slug ]['source'];
- }
- return $dl_source; // Should never happen.
- }
- /**
- * Retrieve the download URL for a WP repo package.
- *
- * @since 2.5.0
- *
- * @param string $slug Plugin slug.
- * @return string Plugin download URL.
- */
- protected function get_wp_repo_download_url( $slug ) {
- $source = '';
- $api = $this->get_plugins_api( $slug );
- if ( false !== $api && isset( $api->download_link ) ) {
- $source = $api->download_link;
- }
- return $source;
- }
- /**
- * Try to grab information from WordPress API.
- *
- * @since 2.5.0
- *
- * @param string $slug Plugin slug.
- * @return object Plugins_api response object on success, WP_Error on failure.
- */
- protected function get_plugins_api( $slug ) {
- static $api = array(); // Cache received responses.
- if ( ! isset( $api[ $slug ] ) ) {
- if ( ! function_exists( 'plugins_api' ) ) {
- require_once ABSPATH . 'wp-admin/includes/plugin-install.php';
- }
- $response = plugins_api( 'plugin_information', array( 'slug' => $slug, 'fields' => array( 'sections' => false ) ) );
- $api[ $slug ] = false;
- if ( is_wp_error( $response ) ) {
- wp_die( esc_html( $this->strings['oops'] ) );
- } else {
- $api[ $slug ] = $response;
- }
- }
- return $api[ $slug ];
- }
- /**
- * Retrieve a link to a plugin information page.
- *
- * @since 2.5.0
- *
- * @param string $slug Plugin slug.
- * @return string Fully formed html link to a plugin information page if available
- * or the plugin name if not.
- */
- public function get_info_link( $slug ) {
- if ( ! empty( $this->plugins[ $slug ]['external_url'] ) && preg_match( self::IS_URL_REGEX, $this->plugins[ $slug ]['external_url'] ) ) {
- $link = sprintf(
- '<a href="%1$s" target="_blank">%2$s</a>',
- esc_url( $this->plugins[ $slug ]['external_url'] ),
- esc_html( $this->plugins[ $slug ]['name'] )
- );
- } elseif ( 'repo' === $this->plugins[ $slug ]['source_type'] ) {
- $url = add_query_arg(
- array(
- 'tab' => 'plugin-information',
- 'plugin' => urlencode( $slug ),
- 'TB_iframe' => 'true',
- 'width' => '640',
- 'height' => '500',
- ),
- self_admin_url( 'plugin-install.php' )
- );
- $link = sprintf(
- '<a href="%1$s" class="thickbox">%2$s</a>',
- esc_url( $url ),
- esc_html( $this->plugins[ $slug ]['name'] )
- );
- } else {
- $link = esc_html( $this->plugins[ $slug ]['name'] ); // No hyperlink.
- }
- return $link;
- }
- /**
- * Determine if we're on the TGMPA Install page.
- *
- * @since 2.1.0
- *
- * @return boolean True when on the TGMPA page, false otherwise.
- */
- protected function is_tgmpa_page() {
- return isset( $_GET['page'] ) && $this->menu === $_GET['page'];
- }
- /**
- * Determine if we're on a WP Core installation/upgrade page.
- *
- * @since 2.6.0
- *
- * @return boolean True when on a WP Core installation/upgrade page, false otherwise.
- */
- protected function is_core_update_page() {
- // Current screen is not always available, most notably on the customizer screen.
- if ( ! function_exists( 'get_current_screen' ) ) {
- return false;
- }
- $screen = get_current_screen();
- if ( 'update-core' === $screen->base ) {
- // Core update screen.
- return true;
- } elseif ( 'plugins' === $screen->base && ! empty( $_POST['action'] ) ) { // WPCS: CSRF ok.
- // Plugins bulk update screen.
- return true;
- } elseif ( 'update' === $screen->base && ! empty( $_POST['action'] ) ) { // WPCS: CSRF ok.
- // Individual updates (ajax call).
- return true;
- }
- return false;
- }
- /**
- * Retrieve the URL to the TGMPA Install page.
- *
- * I.e. depending on the config settings passed something along the lines of:
- * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins
- *
- * @since 2.5.0
- *
- * @return string Properly encoded URL (not escaped).
- */
- public function get_tgmpa_url() {
- static $url;
- if ( ! isset( $url ) ) {
- $parent = $this->parent_slug;
- if ( false === strpos( $parent, '.php' ) ) {
- $parent = 'admin.php';
- }
- $url = add_query_arg(
- array(
- 'page' => urlencode( $this->menu ),
- ),
- self_admin_url( $parent )
- );
- }
- return $url;
- }
- /**
- * Retrieve the URL to the TGMPA Install page for a specific plugin status (view).
- *
- * I.e. depending on the config settings passed something along the lines of:
- * http://example.com/wp-admin/themes.php?page=tgmpa-install-plugins&plugin_status=install
- *
- * @since 2.5.0
- *
- * @param string $status Plugin status - either 'install', 'update' or 'activate'.
- * @return string Properly encoded URL (not escaped).
- */
- public function get_tgmpa_status_url( $status ) {
- return add_query_arg(
- array(
- 'plugin_status' => urlencode( $status ),
- ),
- $this->get_tgmpa_url()
- );
- }
- /**
- * Determine whether there are open actions for plugins registered with TGMPA.
- *
- * @since 2.5.0
- *
- * @return bool True if complete, i.e. no outstanding actions. False otherwise.
- */
- public function is_tgmpa_complete() {
- $complete = true;
- foreach ( $this->plugins as $slug => $plugin ) {
- if ( ! $this->is_plugin_active( $slug ) || false !== $this->does_plugin_have_update( $slug ) ) {
- $complete = false;
- break;
- }
- }
- return $complete;
- }
- /**
- * Check if a plugin is installed. Does not take must-use plugins into account.
- *
- * @since 2.5.0
- *
- * @param string $slug Plugin slug.
- * @return bool True if installed, false otherwise.
- */
- public function is_plugin_installed( $slug ) {
- $installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
- return ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ] ) );
- }
- /**
- * Check if a plugin is active.
- *
- * @since 2.5.0
- *
- * @param string $slug Plugin slug.
- * @return bool True if active, false otherwise.
- */
- public function is_plugin_active( $slug ) {
- return ( ( ! empty( $this->plugins[ $slug ]['is_callable'] ) && is_callable( $this->plugins[ $slug ]['is_callable'] ) ) || is_plugin_active( $this->plugins[ $slug ]['file_path'] ) );
- }
- /**
- * Check if a plugin can be updated, i.e. if we have information on the minimum WP version required
- * available, check whether the current install meets them.
- *
- * @since 2.5.0
- *
- * @param string $slug Plugin slug.
- * @return bool True if OK to update, false otherwise.
- */
- public function can_plugin_update( $slug ) {
- // We currently can't get reliable info on non-WP-repo plugins - issue #380.
- if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
- return true;
- }
- $api = $this->get_plugins_api( $slug );
- if ( false !== $api && isset( $api->requires ) ) {
- return version_compare( $this->wp_version, $api->requires, '>=' );
- }
- // No usable info received from the plugins API, presume we can update.
- return true;
- }
- /**
- * Check to see if the plugin is 'updatetable', i.e. installed, with an update available
- * and no WP version requirements blocking it.
- *
- * @since 2.6.0
- *
- * @param string $slug Plugin slug.
- * @return bool True if OK to proceed with update, false otherwise.
- */
- public function is_plugin_updatetable( $slug ) {
- if ( ! $this->is_plugin_installed( $slug ) ) {
- return false;
- } else {
- return ( false !== $this->does_plugin_have_update( $slug ) && $this->can_plugin_update( $slug ) );
- }
- }
- /**
- * Check if a plugin can be activated, i.e. is not currently active and meets the minimum
- * plugin version requirements set in TGMPA (if any).
- *
- * @since 2.5.0
- *
- * @param string $slug Plugin slug.
- * @return bool True if OK to activate, false otherwise.
- */
- public function can_plugin_activate( $slug ) {
- return ( ! $this->is_plugin_active( $slug ) && ! $this->does_plugin_require_update( $slug ) );
- }
- /**
- * Retrieve the version number of an installed plugin.
- *
- * @since 2.5.0
- *
- * @param string $slug Plugin slug.
- * @return string Version number as string or an empty string if the plugin is not installed
- * or version unknown (plugins which don't comply with the plugin header standard).
- */
- public function get_installed_version( $slug ) {
- $installed_plugins = $this->get_plugins(); // Retrieve a list of all installed plugins (WP cached).
- if ( ! empty( $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'] ) ) {
- return $installed_plugins[ $this->plugins[ $slug ]['file_path'] ]['Version'];
- }
- return '';
- }
- /**
- * Check whether a plugin complies with the minimum version requirements.
- *
- * @since 2.5.0
- *
- * @param string $slug Plugin slug.
- * @return bool True when a plugin needs to be updated, otherwise false.
- */
- public function does_plugin_require_update( $slug ) {
- $installed_version = $this->get_installed_version( $slug );
- $minimum_version = $this->plugins[ $slug ]['version'];
- return version_compare( $minimum_version, $installed_version, '>' );
- }
- /**
- * Check whether there is an update available for a plugin.
- *
- * @since 2.5.0
- *
- * @param string $slug Plugin slug.
- * @return false|string Version number string of the available update or false if no update available.
- */
- public function does_plugin_have_update( $slug ) {
- // Presume bundled and external plugins will point to a package which meets the minimum required version.
- if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
- if ( $this->does_plugin_require_update( $slug ) ) {
- return $this->plugins[ $slug ]['version'];
- }
- return false;
- }
- $repo_updates = get_site_transient( 'update_plugins' );
- if ( isset( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version ) ) {
- return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->new_version;
- }
- return false;
- }
- /**
- * Retrieve potential upgrade notice for a plugin.
- *
- * @since 2.5.0
- *
- * @param string $slug Plugin slug.
- * @return string The upgrade notice or an empty string if no message was available or provided.
- */
- public function get_upgrade_notice( $slug ) {
- // We currently can't get reliable info on non-WP-repo plugins - issue #380.
- if ( 'repo' !== $this->plugins[ $slug ]['source_type'] ) {
- return '';
- }
- $repo_updates = get_site_transient( 'update_plugins' );
- if ( ! empty( $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice ) ) {
- return $repo_updates->response[ $this->plugins[ $slug ]['file_path'] ]->upgrade_notice;
- }
- return '';
- }
- /**
- * Wrapper around the core WP get_plugins function, making sure it's actually available.
- *
- * @since 2.5.0
- *
- * @param string $plugin_folder Optional. Relative path to single plugin folder.
- * @return array Array of installed plugins with plugin information.
- */
- public function get_plugins( $plugin_folder = '' ) {
- if ( ! function_exists( 'get_plugins' ) ) {
- require_once ABSPATH . 'wp-admin/includes/plugin.php';
- }
- return get_plugins( $plugin_folder );
- }
- /**
- * Delete dismissable nag option when theme is switched.
- *
- * This ensures that the user(s) is/are again reminded via nag of required
- * and/or recommended plugins if they re-activate the theme.
- *
- * @since 2.1.1
- */
- public function update_dismiss() {
- delete_metadata( 'user', null, 'tgmpa_dismissed_notice_' . $this->id, null, true );
- }
- /**
- * Forces plugin activation if the parameter 'force_activation' is
- * set to true.
- *
- * This allows theme authors to specify certain plugins that must be
- * active at all times while using the current theme.
- *
- * Please take special care when using this parameter as it has the
- * potential to be harmful if not used correctly. Setting this parameter
- * to true will not allow the specified plugin to be deactivated unless
- * the user switches themes.
- *
- * @since 2.2.0
- */
- public function force_activation() {
- foreach ( $this->plugins as $slug => $plugin ) {
- if ( true === $plugin['force_activation'] ) {
- if ( ! $this->is_plugin_installed( $slug ) ) {
- // Oops, plugin isn't there so iterate to next condition.
- continue;
- } elseif ( $this->can_plugin_activate( $slug ) ) {
- // There we go, activate the plugin.
- activate_plugin( $plugin['file_path'] );
- }
- }
- }
- }
- /**
- * Forces plugin deactivation if the parameter 'force_deactivation'
- * is set to true and adds the plugin to the 'recently active' plugins list.
- *
- * This allows theme authors to specify certain plugins that must be
- * deactivated upon switching from the current theme to another.
- *
- * Please take special care when using this parameter as it has the
- * potential to be harmful if not used correctly.
- *
- * @since 2.2.0
- */
- public function force_deactivation() {
- $deactivated = array();
- foreach ( $this->plugins as $slug => $plugin ) {
- /*
- * Only proceed forward if the parameter is set to true and plugin is active
- * as a 'normal' (not must-use) plugin.
- */
- if ( true === $plugin['force_deactivation'] && is_plugin_active( $plugin['file_path'] ) ) {
- deactivate_plugins( $plugin['file_path'] );
- $deactivated[ $plugin['file_path'] ] = time();
- }
- }
- if ( ! empty( $deactivated ) ) {
- update_option( 'recently_activated', $deactivated + (array) get_option( 'recently_activated' ) );
- }
- }
- /**
- * Echo the current TGMPA version number to the page.
- *
- * @since 2.5.0
- */
- public function show_tgmpa_version() {
- echo '<p style="float: right; padding: 0em 1.5em 0.5em 0;"><strong><small>',
- esc_html(
- sprintf(
- /* translators: %s: version number */
- __( 'TGMPA v%s', 'tgmpa' ),
- self::TGMPA_VERSION
- )
- ),
- '</small></strong></p>';
- }
- /**
- * Returns the singleton instance of the class.
- *
- * @since 2.4.0
- *
- * @return \TGM_Plugin_Activation The TGM_Plugin_Activation object.
- */
- public static function get_instance() {
- if ( ! isset( self::$instance ) && ! ( self::$instance instanceof self ) ) {
- self::$instance = new self();
- }
- return self::$instance;
- }
- }
- if ( ! function_exists( 'load_tgm_plugin_activation' ) ) {
- /**
- * Ensure only one instance of the class is ever invoked.
- *
- * @since 2.5.0
- */
- function load_tgm_plugin_activation() {
- $GLOBALS['tgmpa'] = TGM_Plugin_Activation::get_instance();
- }
- }
- if ( did_action( 'plugins_loaded' ) ) {
- load_tgm_plugin_activation();
- } else {
- add_action( 'plugins_loaded', 'load_tgm_plugin_activation' );
- }
- }
- if ( ! function_exists( 'tgmpa' ) ) {
- /**
- * Helper function to register a collection of required plugins.
- *
- * @since 2.0.0
- * @api
- *
- * @param array $plugins An array of plugin arrays.
- * @param array $config Optional. An array of configuration values.
- */
- function tgmpa( $plugins, $config = array() ) {
- $instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
- foreach ( $plugins as $plugin ) {
- call_user_func( array( $instance, 'register' ), $plugin );
- }
- if ( ! empty( $config ) && is_array( $config ) ) {
- // Send out notices for deprecated arguments passed.
- if ( isset( $config['notices'] ) ) {
- _deprecated_argument( __FUNCTION__, '2.2.0', 'The `notices` config parameter was renamed to `has_notices` in TGMPA 2.2.0. Please adjust your configuration.' );
- if ( ! isset( $config['has_notices'] ) ) {
- $config['has_notices'] = $config['notices'];
- }
- }
- if ( isset( $config['parent_menu_slug'] ) ) {
- _deprecated_argument( __FUNCTION__, '2.4.0', 'The `parent_menu_slug` config parameter was removed in TGMPA 2.4.0. In TGMPA 2.5.0 an alternative was (re-)introduced. Please adjust your configuration. For more information visit the website: http://tgmpluginactivation.com/configuration/#h-configuration-options.' );
- }
- if ( isset( $config['parent_url_slug'] ) ) {
- _deprecated_argument( __FUNCTION__, '2.4.0', 'The `parent_url_slug` config parameter was removed in TGMPA 2.4.0. In TGMPA 2.5.0 an alternative was (re-)introduced. Please adjust your configuration. For more information visit the website: http://tgmpluginactivation.com/configuration/#h-configuration-options.' );
- }
- call_user_func( array( $instance, 'config' ), $config );
- }
- }
- }
- /**
- * WP_List_Table isn't always available. If it isn't available,
- * we load it here.
- *
- * @since 2.2.0
- */
- if ( ! class_exists( 'WP_List_Table' ) ) {
- require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
- }
- if ( ! class_exists( 'TGMPA_List_Table' ) ) {
- /**
- * List table class for handling plugins.
- *
- * Extends the WP_List_Table class to provide a future-compatible
- * way of listing out all required/recommended plugins.
- *
- * Gives users an interface similar to the Plugin Administration
- * area with similar (albeit stripped down) capabilities.
- *
- * This class also allows for the bulk install of plugins.
- *
- * @since 2.2.0
- *
- * @package TGM-Plugin-Activation
- * @author Thomas Griffin
- * @author Gary Jones
- */
- class TGMPA_List_Table extends WP_List_Table {
- /**
- * TGMPA instance.
- *
- * @since 2.5.0
- *
- * @var object
- */
- protected $tgmpa;
- /**
- * The currently chosen view.
- *
- * @since 2.5.0
- *
- * @var string One of: 'all', 'install', 'update', 'activate'
- */
- public $view_context = 'all';
- /**
- * The plugin counts for the various views.
- *
- * @since 2.5.0
- *
- * @var array
- */
- protected $view_totals = array(
- 'all' => 0,
- 'install' => 0,
- 'update' => 0,
- 'activate' => 0,
- );
- /**
- * References parent constructor and sets defaults for class.
- *
- * @since 2.2.0
- */
- public function __construct() {
- $this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
- parent::__construct(
- array(
- 'singular' => 'plugin',
- 'plural' => 'plugins',
- 'ajax' => false,
- )
- );
- if ( isset( $_REQUEST['plugin_status'] ) && in_array( $_REQUEST['plugin_status'], array( 'install', 'update', 'activate' ), true ) ) {
- $this->view_context = sanitize_key( $_REQUEST['plugin_status'] );
- }
- add_filter( 'tgmpa_table_data_items', array( $this, 'sort_table_items' ) );
- }
- /**
- * Get a list of CSS classes for the <table> tag.
- *
- * Overruled to prevent the 'plural' argument from being added.
- *
- * @since 2.5.0
- *
- * @return array CSS classnames.
- */
- public function get_table_classes() {
- return array( 'widefat', 'fixed' );
- }
- /**
- * Gathers and renames all of our plugin information to be used by WP_List_Table to create our table.
- *
- * @since 2.2.0
- *
- * @return array $table_data Information for use in table.
- */
- protected function _gather_plugin_data() {
- // Load thickbox for plugin links.
- $this->tgmpa->admin_init();
- $this->tgmpa->thickbox();
- // Categorize the plugins which have open actions.
- $plugins = $this->categorize_plugins_to_views();
- // Set the counts for the view links.
- $this->set_view_totals( $plugins );
- // Prep variables for use and grab list of all installed plugins.
- $table_data = array();
- $i = 0;
- // Redirect to the 'all' view if no plugins were found for the selected view context.
- if ( empty( $plugins[ $this->view_context ] ) ) {
- $this->view_context = 'all';
- }
- foreach ( $plugins[ $this->view_context ] as $slug => $plugin ) {
- $table_data[ $i ]['sanitized_plugin'] = $plugin['name'];
- $table_data[ $i ]['slug'] = $slug;
- $table_data[ $i ]['plugin'] = '<strong>' . $this->tgmpa->get_info_link( $slug ) . '</strong>';
- $table_data[ $i ]['source'] = $this->get_plugin_source_type_text( $plugin['source_type'] );
- $table_data[ $i ]['type'] = $this->get_plugin_advise_type_text( $plugin['required'] );
- $table_data[ $i ]['status'] = $this->get_plugin_status_text( $slug );
- $table_data[ $i ]['installed_version'] = $this->tgmpa->get_installed_version( $slug );
- $table_data[ $i ]['minimum_version'] = $plugin['version'];
- $table_data[ $i ]['available_version'] = $this->tgmpa->does_plugin_have_update( $slug );
- // Prep the upgrade notice info.
- $upgrade_notice = $this->tgmpa->get_upgrade_notice( $slug );
- if ( ! empty( $upgrade_notice ) ) {
- $table_data[ $i ]['upgrade_notice'] = $upgrade_notice;
- add_action( "tgmpa_after_plugin_row_{$slug}", array( $this, 'wp_plugin_update_row' ), 10, 2 );
- }
- $table_data[ $i ] = apply_filters( 'tgmpa_table_data_item', $table_data[ $i ], $plugin );
- $i++;
- }
- return $table_data;
- }
- /**
- * Categorize the plugins which have open actions into views for the TGMPA page.
- *
- * @since 2.5.0
- */
- protected function categorize_plugins_to_views() {
- $plugins = array(
- 'all' => array(), // Meaning: all plugins which still have open actions.
- 'install' => array(),
- 'update' => array(),
- 'activate' => array(),
- );
- foreach ( $this->tgmpa->plugins as $slug => $plugin ) {
- if ( $this->tgmpa->is_plugin_active( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
- // No need to display plugins if they are installed, up-to-date and active.
- continue;
- } else {
- $plugins['all'][ $slug ] = $plugin;
- if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
- $plugins['install'][ $slug ] = $plugin;
- } else {
- if ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
- $plugins['update'][ $slug ] = $plugin;
- }
- if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
- $plugins['activate'][ $slug ] = $plugin;
- }
- }
- }
- }
- return $plugins;
- }
- /**
- * Set the counts for the view links.
- *
- * @since 2.5.0
- *
- * @param array $plugins Plugins order by view.
- */
- protected function set_view_totals( $plugins ) {
- foreach ( $plugins as $type => $list ) {
- $this->view_totals[ $type ] = count( $list );
- }
- }
- /**
- * Get the plugin required/recommended text string.
- *
- * @since 2.5.0
- *
- * @param string $required Plugin required setting.
- * @return string
- */
- protected function get_plugin_advise_type_text( $required ) {
- if ( true === $required ) {
- return __( 'Required', 'tgmpa' );
- }
- return __( 'Recommended', 'tgmpa' );
- }
- /**
- * Get the plugin source type text string.
- *
- * @since 2.5.0
- *
- * @param string $type Plugin type.
- * @return string
- */
- protected function get_plugin_source_type_text( $type ) {
- $string = '';
- switch ( $type ) {
- case 'repo':
- $string = __( 'WordPress Repository', 'tgmpa' );
- break;
- case 'external':
- $string = __( 'External Source', 'tgmpa' );
- break;
- case 'bundled':
- $string = __( 'Pre-Packaged', 'tgmpa' );
- break;
- }
- return $string;
- }
- /**
- * Determine the plugin status message.
- *
- * @since 2.5.0
- *
- * @param string $slug Plugin slug.
- * @return string
- */
- protected function get_plugin_status_text( $slug ) {
- if ( ! $this->tgmpa->is_plugin_installed( $slug ) ) {
- return __( 'Not Installed', 'tgmpa' );
- }
- if ( ! $this->tgmpa->is_plugin_active( $slug ) ) {
- $install_status = __( 'Installed But Not Activated', 'tgmpa' );
- } else {
- $install_status = __( 'Active', 'tgmpa' );
- }
- $update_status = '';
- if ( $this->tgmpa->does_plugin_require_update( $slug ) && false === $this->tgmpa->does_plugin_have_update( $slug ) ) {
- $update_status = __( 'Required Update not Available', 'tgmpa' );
- } elseif ( $this->tgmpa->does_plugin_require_update( $slug ) ) {
- $update_status = __( 'Requires Update', 'tgmpa' );
- } elseif ( false !== $this->tgmpa->does_plugin_have_update( $slug ) ) {
- $update_status = __( 'Update recommended', 'tgmpa' );
- }
- if ( '' === $update_status ) {
- return $install_status;
- }
- return sprintf(
- /* translators: 1: install status, 2: update status */
- _x( '%1$s, %2$s', 'Install/Update Status', 'tgmpa' ),
- $install_status,
- $update_status
- );
- }
- /**
- * Sort plugins by Required/Recommended type and by alphabetical plugin name within each type.
- *
- * @since 2.5.0
- *
- * @param array $items Prepared table items.
- * @return array Sorted table items.
- */
- public function sort_table_items( $items ) {
- $type = array();
- $name = array();
- foreach ( $items as $i => $plugin ) {
- $type[ $i ] = $plugin['type']; // Required / recommended.
- $name[ $i ] = $plugin['sanitized_plugin'];
- }
- array_multisort( $type, SORT_DESC, $name, SORT_ASC, $items );
- return $items;
- }
- /**
- * Get an associative array ( id => link ) of the views available on this table.
- *
- * @since 2.5.0
- *
- * @return array
- */
- public function get_views() {
- $status_links = array();
- foreach ( $this->view_totals as $type => $count ) {
- if ( $count < 1 ) {
- continue;
- }
- switch ( $type ) {
- case 'all':
- /* translators: 1: number of plugins. */
- $text = _nx( 'All <span class="count">(%s)</span>', 'All <span class="count">(%s)</span>', $count, 'plugins', 'tgmpa' );
- break;
- case 'install':
- /* translators: 1: number of plugins. */
- $text = _n( 'To Install <span class="count">(%s)</span>', 'To Install <span class="count">(%s)</span>', $count, 'tgmpa' );
- break;
- case 'update':
- /* translators: 1: number of plugins. */
- $text = _n( 'Update Available <span class="count">(%s)</span>', 'Update Available <span class="count">(%s)</span>', $count, 'tgmpa' );
- break;
- case 'activate':
- /* translators: 1: number of plugins. */
- $text = _n( 'To Activate <span class="count">(%s)</span>', 'To Activate <span class="count">(%s)</span>', $count, 'tgmpa' );
- break;
- default:
- $text = '';
- break;
- }
- if ( ! empty( $text ) ) {
- $status_links[ $type ] = sprintf(
- '<a href="%s"%s>%s</a>',
- esc_url( $this->tgmpa->get_tgmpa_status_url( $type ) ),
- ( $type === $this->view_context ) ? ' class="current"' : '',
- sprintf( $text, number_format_i18n( $count ) )
- );
- }
- }
- return $status_links;
- }
- /**
- * Create default columns to display important plugin information
- * like type, action and status.
- *
- * @since 2.2.0
- *
- * @param array $item Array of item data.
- * @param string $column_name The name of the column.
- * @return string
- */
- public function column_default( $item, $column_name ) {
- return $item[ $column_name ];
- }
- /**
- * Required for bulk installing.
- *
- * Adds a checkbox for each plugin.
- *
- * @since 2.2.0
- *
- * @param array $item Array of item data.
- * @return string The input checkbox with all necessary info.
- */
- public function column_cb( $item ) {
- return sprintf(
- '<input type="checkbox" name="%1$s[]" value="%2$s" id="%3$s" />',
- esc_attr( $this->_args['singular'] ),
- esc_attr( $item['slug'] ),
- esc_attr( $item['sanitized_plugin'] )
- );
- }
- /**
- * Create default title column along with the action links.
- *
- * @since 2.2.0
- *
- * @param array $item Array of item data.
- * @return string The plugin name and action links.
- */
- public function column_plugin( $item ) {
- return sprintf(
- '%1$s %2$s',
- $item['plugin'],
- $this->row_actions( $this->get_row_actions( $item ), true )
- );
- }
- /**
- * Create version information column.
- *
- * @since 2.5.0
- *
- * @param array $item Array of item data.
- * @return string HTML-formatted version information.
- */
- public function column_version( $item ) {
- $output = array();
- if ( $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
- $installed = ! empty( $item['installed_version'] ) ? $item['installed_version'] : _x( 'unknown', 'as in: "version nr unknown"', 'tgmpa' );
- $color = '';
- if ( ! empty( $item['minimum_version'] ) && $this->tgmpa->does_plugin_require_update( $item['slug'] ) ) {
- $color = ' color: #ff0000; font-weight: bold;';
- }
- $output[] = sprintf(
- '<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Installed version:', 'tgmpa' ) . '</p>',
- $color,
- $installed
- );
- }
- if ( ! empty( $item['minimum_version'] ) ) {
- $output[] = sprintf(
- '<p><span style="min-width: 32px; text-align: right; float: right;">%1$s</span>' . __( 'Minimum required version:', 'tgmpa' ) . '</p>',
- $item['minimum_version']
- );
- }
- if ( ! empty( $item['available_version'] ) ) {
- $color = '';
- if ( ! empty( $item['minimum_version'] ) && version_compare( $item['available_version'], $item['minimum_version'], '>=' ) ) {
- $color = ' color: #71C671; font-weight: bold;';
- }
- $output[] = sprintf(
- '<p><span style="min-width: 32px; text-align: right; float: right;%1$s">%2$s</span>' . __( 'Available version:', 'tgmpa' ) . '</p>',
- $color,
- $item['available_version']
- );
- }
- if ( empty( $output ) ) {
- return ' '; // Let's not break the table layout.
- } else {
- return implode( "\n", $output );
- }
- }
- /**
- * Sets default message within the plugins table if no plugins
- * are left for interaction.
- *
- * Hides the menu item to prevent the user from clicking and
- * getting a permissions error.
- *
- * @since 2.2.0
- */
- public function no_items() {
- echo esc_html__( 'No plugins to install, update or activate.', 'tgmpa' ) . ' <a href="' . esc_url( self_admin_url() ) . '"> ' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>';
- echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
- }
- /**
- * Output all the column information within the table.
- *
- * @since 2.2.0
- *
- * @return array $columns The column names.
- */
- public function get_columns() {
- $columns = array(
- 'cb' => '<input type="checkbox" />',
- 'plugin' => __( 'Plugin', 'tgmpa' ),
- 'source' => __( 'Source', 'tgmpa' ),
- 'type' => __( 'Type', 'tgmpa' ),
- );
- if ( 'all' === $this->view_context || 'update' === $this->view_context ) {
- $columns['version'] = __( 'Version', 'tgmpa' );
- $columns['status'] = __( 'Status', 'tgmpa' );
- }
- return apply_filters( 'tgmpa_table_columns', $columns );
- }
- /**
- * Get name of default primary column
- *
- * @since 2.5.0 / WP 4.3+ compatibility
- * @access protected
- *
- * @return string
- */
- protected function get_default_primary_column_name() {
- return 'plugin';
- }
- /**
- * Get the name of the primary column.
- *
- * @since 2.5.0 / WP 4.3+ compatibility
- * @access protected
- *
- * @return string The name of the primary column.
- */
- protected function get_primary_column_name() {
- if ( method_exists( 'WP_List_Table', 'get_primary_column_name' ) ) {
- return parent::get_primary_column_name();
- } else {
- return $this->get_default_primary_column_name();
- }
- }
- /**
- * Get the actions which are relevant for a specific plugin row.
- *
- * @since 2.5.0
- *
- * @param array $item Array of item data.
- * @return array Array with relevant action links.
- */
- protected function get_row_actions( $item ) {
- $actions = array();
- $action_links = array();
- // Display the 'Install' action link if the plugin is not yet available.
- if ( ! $this->tgmpa->is_plugin_installed( $item['slug'] ) ) {
- /* translators: %2$s: plugin name in screen reader markup */
- $actions['install'] = __( 'Install %2$s', 'tgmpa' );
- } else {
- // Display the 'Update' action link if an update is available and WP complies with plugin minimum.
- if ( false !== $this->tgmpa->does_plugin_have_update( $item['slug'] ) && $this->tgmpa->can_plugin_update( $item['slug'] ) ) {
- /* translators: %2$s: plugin name in screen reader markup */
- $actions['update'] = __( 'Update %2$s', 'tgmpa' );
- }
- // Display the 'Activate' action link, but only if the plugin meets the minimum version.
- if ( $this->tgmpa->can_plugin_activate( $item['slug'] ) ) {
- /* translators: %2$s: plugin name in screen reader markup */
- $actions['activate'] = __( 'Activate %2$s', 'tgmpa' );
- }
- }
- // Create the actual links.
- foreach ( $actions as $action => $text ) {
- $nonce_url = wp_nonce_url(
- add_query_arg(
- array(
- 'plugin' => urlencode( $item['slug'] ),
- 'tgmpa-' . $action => $action . '-plugin',
- ),
- $this->tgmpa->get_tgmpa_url()
- ),
- 'tgmpa-' . $action,
- 'tgmpa-nonce'
- );
- $action_links[ $action ] = sprintf(
- '<a href="%1$s">' . esc_html( $text ) . '</a>', // $text contains the second placeholder.
- esc_url( $nonce_url ),
- '<span class="screen-reader-text">' . esc_html( $item['sanitized_plugin'] ) . '</span>'
- );
- }
- $prefix = ( defined( 'WP_NETWORK_ADMIN' ) && WP_NETWORK_ADMIN ) ? 'network_admin_' : '';
- return apply_filters( "tgmpa_{$prefix}plugin_action_links", array_filter( $action_links ), $item['slug'], $item, $this->view_context );
- }
- /**
- * Generates content for a single row of the table.
- *
- * @since 2.5.0
- *
- * @param object $item The current item.
- */
- public function single_row( $item ) {
- parent::single_row( $item );
- /**
- * Fires after each specific row in the TGMPA Plugins list table.
- *
- * The dynamic portion of the hook name, `$item['slug']`, refers to the slug
- * for the plugin.
- *
- * @since 2.5.0
- */
- do_action( "tgmpa_after_plugin_row_{$item['slug']}", $item['slug'], $item, $this->view_context );
- }
- /**
- * Show the upgrade notice below a plugin row if there is one.
- *
- * @since 2.5.0
- *
- * @see /wp-admin/includes/update.php
- *
- * @param string $slug Plugin slug.
- * @param array $item The information available in this table row.
- * @return null Return early if upgrade notice is empty.
- */
- public function wp_plugin_update_row( $slug, $item ) {
- if ( empty( $item['upgrade_notice'] ) ) {
- return;
- }
- echo '
- <tr class="plugin-update-tr">
- <td colspan="', absint( $this->get_column_count() ), '" class="plugin-update colspanchange">
- <div class="update-message">',
- esc_html__( 'Upgrade message from the plugin author:', 'tgmpa' ),
- ' <strong>', wp_kses_data( $item['upgrade_notice'] ), '</strong>
- </div>
- </td>
- </tr>';
- }
- /**
- * Extra controls to be displayed between bulk actions and pagination.
- *
- * @since 2.5.0
- *
- * @param string $which 'top' or 'bottom' table navigation.
- */
- public function extra_tablenav( $which ) {
- if ( 'bottom' === $which ) {
- $this->tgmpa->show_tgmpa_version();
- }
- }
- /**
- * Defines the bulk actions for handling registered plugins.
- *
- * @since 2.2.0
- *
- * @return array $actions The bulk actions for the plugin install table.
- */
- public function get_bulk_actions() {
- $actions = array();
- if ( 'update' !== $this->view_context && 'activate' !== $this->view_context ) {
- if ( current_user_can( 'install_plugins' ) ) {
- $actions['tgmpa-bulk-install'] = __( 'Install', 'tgmpa' );
- }
- }
- if ( 'install' !== $this->view_context ) {
- if ( current_user_can( 'update_plugins' ) ) {
- $actions['tgmpa-bulk-update'] = __( 'Update', 'tgmpa' );
- }
- if ( current_user_can( 'activate_plugins' ) ) {
- $actions['tgmpa-bulk-activate'] = __( 'Activate', 'tgmpa' );
- }
- }
- return $actions;
- }
- /**
- * Processes bulk installation and activation actions.
- *
- * The bulk installation process looks for the $_POST information and passes that
- * through if a user has to use WP_Filesystem to enter their credentials.
- *
- * @since 2.2.0
- */
- public function process_bulk_actions() {
- // Bulk installation process.
- if ( 'tgmpa-bulk-install' === $this->current_action() || 'tgmpa-bulk-update' === $this->current_action() ) {
- check_admin_referer( 'bulk-' . $this->_args['plural'] );
- $install_type = 'install';
- if ( 'tgmpa-bulk-update' === $this->current_action() ) {
- $install_type = 'update';
- }
- $plugins_to_install = array();
- // Did user actually select any plugins to install/update ?
- if ( empty( $_POST['plugin'] ) ) {
- if ( 'install' === $install_type ) {
- $message = __( 'No plugins were selected to be installed. No action taken.', 'tgmpa' );
- } else {
- $message = __( 'No plugins were selected to be updated. No action taken.', 'tgmpa' );
- }
- echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
- return false;
- }
- if ( is_array( $_POST['plugin'] ) ) {
- $plugins_to_install = (array) $_POST['plugin'];
- } elseif ( is_string( $_POST['plugin'] ) ) {
- // Received via Filesystem page - un-flatten array (WP bug #19643).
- $plugins_to_install = explode( ',', $_POST['plugin'] );
- }
- // Sanitize the received input.
- $plugins_to_install = array_map( 'urldecode', $plugins_to_install );
- $plugins_to_install = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins_to_install );
- // Validate the received input.
- foreach ( $plugins_to_install as $key => $slug ) {
- // Check if the plugin was registered with TGMPA and remove if not.
- if ( ! isset( $this->tgmpa->plugins[ $slug ] ) ) {
- unset( $plugins_to_install[ $key ] );
- continue;
- }
- // For install: make sure this is a plugin we *can* install and not one already installed.
- if ( 'install' === $install_type && true === $this->tgmpa->is_plugin_installed( $slug ) ) {
- unset( $plugins_to_install[ $key ] );
- }
- // For updates: make sure this is a plugin we *can* update (update available and WP version ok).
- if ( 'update' === $install_type && false === $this->tgmpa->is_plugin_updatetable( $slug ) ) {
- unset( $plugins_to_install[ $key ] );
- }
- }
- // No need to proceed further if we have no plugins to handle.
- if ( empty( $plugins_to_install ) ) {
- if ( 'install' === $install_type ) {
- $message = __( 'No plugins are available to be installed at this time.', 'tgmpa' );
- } else {
- $message = __( 'No plugins are available to be updated at this time.', 'tgmpa' );
- }
- echo '<div id="message" class="error"><p>', esc_html( $message ), '</p></div>';
- return false;
- }
- // Pass all necessary information if WP_Filesystem is needed.
- $url = wp_nonce_url(
- $this->tgmpa->get_tgmpa_url(),
- 'bulk-' . $this->_args['plural']
- );
- // Give validated data back to $_POST which is the only place the filesystem looks for extra fields.
- $_POST['plugin'] = implode( ',', $plugins_to_install ); // Work around for WP bug #19643.
- $method = ''; // Leave blank so WP_Filesystem can populate it as necessary.
- $fields = array_keys( $_POST ); // Extra fields to pass to WP_Filesystem.
- if ( false === ( $creds = request_filesystem_credentials( esc_url_raw( $url ), $method, false, false, $fields ) ) ) {
- return true; // Stop the normal page form from displaying, credential request form will be shown.
- }
- // Now we have some credentials, setup WP_Filesystem.
- if ( ! WP_Filesystem( $creds ) ) {
- // Our credentials were no good, ask the user for them again.
- request_filesystem_credentials( esc_url_raw( $url ), $method, true, false, $fields );
- return true;
- }
- /* If we arrive here, we have the filesystem */
- // Store all information in arrays since we are processing a bulk installation.
- $names = array();
- $sources = array(); // Needed for installs.
- $file_paths = array(); // Needed for upgrades.
- $to_inject = array(); // Information to inject into the update_plugins transient.
- // Prepare the data for validated plugins for the install/upgrade.
- foreach ( $plugins_to_install as $slug ) {
- $name = $this->tgmpa->plugins[ $slug ]['name'];
- $source = $this->tgmpa->get_download_url( $slug );
- if ( ! empty( $name ) && ! empty( $source ) ) {
- $names[] = $name;
- switch ( $install_type ) {
- case 'install':
- $sources[] = $source;
- break;
- case 'update':
- $file_paths[] = $this->tgmpa->plugins[ $slug ]['file_path'];
- $to_inject[ $slug ] = $this->tgmpa->plugins[ $slug ];
- $to_inject[ $slug ]['source'] = $source;
- break;
- }
- }
- }
- unset( $slug, $name, $source );
- // Create a new instance of TGMPA_Bulk_Installer.
- $installer = new TGMPA_Bulk_Installer(
- new TGMPA_Bulk_Installer_Skin(
- array(
- 'url' => esc_url_raw( $this->tgmpa->get_tgmpa_url() ),
- 'nonce' => 'bulk-' . $this->_args['plural'],
- 'names' => $names,
- 'install_type' => $install_type,
- )
- )
- );
- // Wrap the install process with the appropriate HTML.
- echo '<div class="tgmpa">',
- '<h2 style="font-size: 23px; font-weight: 400; line-height: 29px; margin: 0; padding: 9px 15px 4px 0;">', esc_html( get_admin_page_title() ), '</h2>
- <div class="update-php" style="width: 100%; height: 98%; min-height: 850px; padding-top: 1px;">';
- // Process the bulk installation submissions.
- add_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1, 3 );
- if ( 'tgmpa-bulk-update' === $this->current_action() ) {
- // Inject our info into the update transient.
- $this->tgmpa->inject_update_info( $to_inject );
- $installer->bulk_upgrade( $file_paths );
- } else {
- $installer->bulk_install( $sources );
- }
- remove_filter( 'upgrader_source_selection', array( $this->tgmpa, 'maybe_adjust_source_dir' ), 1 );
- echo '</div></div>';
- return true;
- }
- // Bulk activation process.
- if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
- check_admin_referer( 'bulk-' . $this->_args['plural'] );
- // Did user actually select any plugins to activate ?
- if ( empty( $_POST['plugin'] ) ) {
- echo '<div id="message" class="error"><p>', esc_html__( 'No plugins were selected to be activated. No action taken.', 'tgmpa' ), '</p></div>';
- return false;
- }
- // Grab plugin data from $_POST.
- $plugins = array();
- if ( isset( $_POST['plugin'] ) ) {
- $plugins = array_map( 'urldecode', (array) $_POST['plugin'] );
- $plugins = array_map( array( $this->tgmpa, 'sanitize_key' ), $plugins );
- }
- $plugins_to_activate = array();
- $plugin_names = array();
- // Grab the file paths for the selected & inactive plugins from the registration array.
- foreach ( $plugins as $slug ) {
- if ( $this->tgmpa->can_plugin_activate( $slug ) ) {
- $plugins_to_activate[] = $this->tgmpa->plugins[ $slug ]['file_path'];
- $plugin_names[] = $this->tgmpa->plugins[ $slug ]['name'];
- }
- }
- unset( $slug );
- // Return early if there are no plugins to activate.
- if ( empty( $plugins_to_activate ) ) {
- echo '<div id="message" class="error"><p>', esc_html__( 'No plugins are available to be activated at this time.', 'tgmpa' ), '</p></div>';
- return false;
- }
- // Now we are good to go - let's start activating plugins.
- $activate = activate_plugins( $plugins_to_activate );
- if ( is_wp_error( $activate ) ) {
- echo '<div id="message" class="error"><p>', wp_kses_post( $activate->get_error_message() ), '</p></div>';
- } else {
- $count = count( $plugin_names ); // Count so we can use _n function.
- $plugin_names = array_map( array( 'TGMPA_Utils', 'wrap_in_strong' ), $plugin_names );
- $last_plugin = array_pop( $plugin_names ); // Pop off last name to prep for readability.
- $imploded = empty( $plugin_names ) ? $last_plugin : ( implode( ', ', $plugin_names ) . ' ' . esc_html_x( 'and', 'plugin A *and* plugin B', 'tgmpa' ) . ' ' . $last_plugin );
- printf( // WPCS: xss ok.
- '<div id="message" class="updated"><p>%1$s %2$s.</p></div>',
- esc_html( _n( 'The following plugin was activated successfully:', 'The following plugins were activated successfully:', $count, 'tgmpa' ) ),
- $imploded
- );
- // Update recently activated plugins option.
- $recent = (array) get_option( 'recently_activated' );
- foreach ( $plugins_to_activate as $plugin => $time ) {
- if ( isset( $recent[ $plugin ] ) ) {
- unset( $recent[ $plugin ] );
- }
- }
- update_option( 'recently_activated', $recent );
- }
- unset( $_POST ); // Reset the $_POST variable in case user wants to perform one action after another.
- return true;
- }
- return false;
- }
- /**
- * Prepares all of our information to be outputted into a usable table.
- *
- * @since 2.2.0
- */
- public function prepare_items() {
- $columns = $this->get_columns(); // Get all necessary column information.
- $hidden = array(); // No columns to hide, but we must set as an array.
- $sortable = array(); // No reason to make sortable columns.
- $primary = $this->get_primary_column_name(); // Column which has the row actions.
- $this->_column_headers = array( $columns, $hidden, $sortable, $primary ); // Get all necessary column headers.
- // Process our bulk activations here.
- if ( 'tgmpa-bulk-activate' === $this->current_action() ) {
- $this->process_bulk_actions();
- }
- // Store all of our plugin data into $items array so WP_List_Table can use it.
- $this->items = apply_filters( 'tgmpa_table_data_items', $this->_gather_plugin_data() );
- }
- /* *********** DEPRECATED METHODS *********** */
- /**
- * Retrieve plugin data, given the plugin name.
- *
- * @since 2.2.0
- * @deprecated 2.5.0 use {@see TGM_Plugin_Activation::_get_plugin_data_from_name()} instead.
- * @see TGM_Plugin_Activation::_get_plugin_data_from_name()
- *
- * @param string $name Name of the plugin, as it was registered.
- * @param string $data Optional. Array key of plugin data to return. Default is slug.
- * @return string|boolean Plugin slug if found, false otherwise.
- */
- protected function _get_plugin_data_from_name( $name, $data = 'slug' ) {
- _deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'TGM_Plugin_Activation::_get_plugin_data_from_name()' );
- return $this->tgmpa->_get_plugin_data_from_name( $name, $data );
- }
- }
- }
- if ( ! class_exists( 'TGM_Bulk_Installer' ) ) {
- /**
- * Hack: Prevent TGMPA v2.4.1- bulk installer class from being loaded if 2.4.1- is loaded after 2.5+.
- *
- * @since 2.5.2
- *
- * {@internal The TGMPA_Bulk_Installer class was originally called TGM_Bulk_Installer.
- * For more information, see that class.}}
- */
- class TGM_Bulk_Installer {
- }
- }
- if ( ! class_exists( 'TGM_Bulk_Installer_Skin' ) ) {
- /**
- * Hack: Prevent TGMPA v2.4.1- bulk installer skin class from being loaded if 2.4.1- is loaded after 2.5+.
- *
- * @since 2.5.2
- *
- * {@internal The TGMPA_Bulk_Installer_Skin class was originally called TGM_Bulk_Installer_Skin.
- * For more information, see that class.}}
- */
- class TGM_Bulk_Installer_Skin {
- }
- }
- /**
- * The WP_Upgrader file isn't always available. If it isn't available,
- * we load it here.
- *
- * We check to make sure no action or activation keys are set so that WordPress
- * does not try to re-include the class when processing upgrades or installs outside
- * of the class.
- *
- * @since 2.2.0
- */
- add_action( 'admin_init', 'tgmpa_load_bulk_installer' );
- if ( ! function_exists( 'tgmpa_load_bulk_installer' ) ) {
- /**
- * Load bulk installer
- */
- function tgmpa_load_bulk_installer() {
- // Silently fail if 2.5+ is loaded *after* an older version.
- if ( ! isset( $GLOBALS['tgmpa'] ) ) {
- return;
- }
- // Get TGMPA class instance.
- $tgmpa_instance = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
- if ( isset( $_GET['page'] ) && $tgmpa_instance->menu === $_GET['page'] ) {
- if ( ! class_exists( 'Plugin_Upgrader', false ) ) {
- require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
- }
- if ( ! class_exists( 'TGMPA_Bulk_Installer' ) ) {
- /**
- * Installer class to handle bulk plugin installations.
- *
- * Extends WP_Upgrader and customizes to suit the installation of multiple
- * plugins.
- *
- * @since 2.2.0
- *
- * {@internal Since 2.5.0 the class is an extension of Plugin_Upgrader rather than WP_Upgrader.}}
- * {@internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer to TGMPA_Bulk_Installer.
- * This was done to prevent backward compatibility issues with v2.3.6.}}
- *
- * @package TGM-Plugin-Activation
- * @author Thomas Griffin
- * @author Gary Jones
- */
- class TGMPA_Bulk_Installer extends Plugin_Upgrader {
- /**
- * Holds result of bulk plugin installation.
- *
- * @since 2.2.0
- *
- * @var string
- */
- public $result;
- /**
- * Flag to check if bulk installation is occurring or not.
- *
- * @since 2.2.0
- *
- * @var boolean
- */
- public $bulk = false;
- /**
- * TGMPA instance
- *
- * @since 2.5.0
- *
- * @var object
- */
- protected $tgmpa;
- /**
- * Whether or not the destination directory needs to be cleared ( = on update).
- *
- * @since 2.5.0
- *
- * @var bool
- */
- protected $clear_destination = false;
- /**
- * References parent constructor and sets defaults for class.
- *
- * @since 2.2.0
- *
- * @param \Bulk_Upgrader_Skin|null $skin Installer skin.
- */
- public function __construct( $skin = null ) {
- // Get TGMPA class instance.
- $this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
- parent::__construct( $skin );
- if ( isset( $this->skin->options['install_type'] ) && 'update' === $this->skin->options['install_type'] ) {
- $this->clear_destination = true;
- }
- if ( $this->tgmpa->is_automatic ) {
- $this->activate_strings();
- }
- add_action( 'upgrader_process_complete', array( $this->tgmpa, 'populate_file_path' ) );
- }
- /**
- * Sets the correct activation strings for the installer skin to use.
- *
- * @since 2.2.0
- */
- public function activate_strings() {
- $this->strings['activation_failed'] = __( 'Plugin activation failed.', 'tgmpa' );
- $this->strings['activation_success'] = __( 'Plugin activated successfully.', 'tgmpa' );
- }
- /**
- * Performs the actual installation of each plugin.
- *
- * @since 2.2.0
- *
- * @see WP_Upgrader::run()
- *
- * @param array $options The installation config options.
- * @return null|array Return early if error, array of installation data on success.
- */
- public function run( $options ) {
- $result = parent::run( $options );
- // Reset the strings in case we changed one during automatic activation.
- if ( $this->tgmpa->is_automatic ) {
- if ( 'update' === $this->skin->options['install_type'] ) {
- $this->upgrade_strings();
- } else {
- $this->install_strings();
- }
- }
- return $result;
- }
- /**
- * Processes the bulk installation of plugins.
- *
- * @since 2.2.0
- *
- * {@internal This is basically a near identical copy of the WP Core
- * Plugin_Upgrader::bulk_upgrade() method, with minor adjustments to deal with
- * new installs instead of upgrades.
- * For ease of future synchronizations, the adjustments are clearly commented, but no other
- * comments are added. Code style has been made to comply.}}
- *
- * @see Plugin_Upgrader::bulk_upgrade()
- * @see https://core.trac.wordpress.org/browser/tags/4.2.1/src/wp-admin/includes/class-wp-upgrader.php#L838
- * (@internal Last synced: Dec 31st 2015 against https://core.trac.wordpress.org/browser/trunk?rev=36134}}
- *
- * @param array $plugins The plugin sources needed for installation.
- * @param array $args Arbitrary passed extra arguments.
- * @return array|false Install confirmation messages on success, false on failure.
- */
- public function bulk_install( $plugins, $args = array() ) {
- // [TGMPA + ] Hook auto-activation in.
- add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
- $defaults = array(
- 'clear_update_cache' => true,
- );
- $parsed_args = wp_parse_args( $args, $defaults );
- $this->init();
- $this->bulk = true;
- $this->install_strings(); // [TGMPA + ] adjusted.
- /* [TGMPA - ] $current = get_site_transient( 'update_plugins' ); */
- /* [TGMPA - ] add_filter('upgrader_clear_destination', array($this, 'delete_old_plugin'), 10, 4); */
- $this->skin->header();
- // Connect to the Filesystem first.
- $res = $this->fs_connect( array( WP_CONTENT_DIR, WP_PLUGIN_DIR ) );
- if ( ! $res ) {
- $this->skin->footer();
- return false;
- }
- $this->skin->bulk_header();
- /*
- * Only start maintenance mode if:
- * - running Multisite and there are one or more plugins specified, OR
- * - a plugin with an update available is currently active.
- * @TODO: For multisite, maintenance mode should only kick in for individual sites if at all possible.
- */
- $maintenance = ( is_multisite() && ! empty( $plugins ) );
- /*
- [TGMPA - ]
- foreach ( $plugins as $plugin )
- $maintenance = $maintenance || ( is_plugin_active( $plugin ) && isset( $current->response[ $plugin] ) );
- */
- if ( $maintenance ) {
- $this->maintenance_mode( true );
- }
- $results = array();
- $this->update_count = count( $plugins );
- $this->update_current = 0;
- foreach ( $plugins as $plugin ) {
- $this->update_current++;
- /*
- [TGMPA - ]
- $this->skin->plugin_info = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin, false, true);
- if ( !isset( $current->response[ $plugin ] ) ) {
- $this->skin->set_result('up_to_date');
- $this->skin->before();
- $this->skin->feedback('up_to_date');
- $this->skin->after();
- $results[$plugin] = true;
- continue;
- }
- // Get the URL to the zip file.
- $r = $current->response[ $plugin ];
- $this->skin->plugin_active = is_plugin_active($plugin);
- */
- $result = $this->run(
- array(
- 'package' => $plugin, // [TGMPA + ] adjusted.
- 'destination' => WP_PLUGIN_DIR,
- 'clear_destination' => false, // [TGMPA + ] adjusted.
- 'clear_working' => true,
- 'is_multi' => true,
- 'hook_extra' => array(
- 'plugin' => $plugin,
- ),
- )
- );
- $results[ $plugin ] = $this->result;
- // Prevent credentials auth screen from displaying multiple times.
- if ( false === $result ) {
- break;
- }
- } //end foreach $plugins
- $this->maintenance_mode( false );
- /**
- * Fires when the bulk upgrader process is complete.
- *
- * @since WP 3.6.0 / TGMPA 2.5.0
- *
- * @param Plugin_Upgrader $this Plugin_Upgrader instance. In other contexts, $this, might
- * be a Theme_Upgrader or Core_Upgrade instance.
- * @param array $data {
- * Array of bulk item update data.
- *
- * @type string $action Type of action. Default 'update'.
- * @type string $type Type of update process. Accepts 'plugin', 'theme', or 'core'.
- * @type bool $bulk Whether the update process is a bulk update. Default true.
- * @type array $packages Array of plugin, theme, or core packages to update.
- * }
- */
- do_action( 'upgrader_process_complete', $this, array(
- 'action' => 'install', // [TGMPA + ] adjusted.
- 'type' => 'plugin',
- 'bulk' => true,
- 'plugins' => $plugins,
- ) );
- $this->skin->bulk_footer();
- $this->skin->footer();
- // Cleanup our hooks, in case something else does a upgrade on this connection.
- /* [TGMPA - ] remove_filter('upgrader_clear_destination', array($this, 'delete_old_plugin')); */
- // [TGMPA + ] Remove our auto-activation hook.
- remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
- // Force refresh of plugin update information.
- wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
- return $results;
- }
- /**
- * Handle a bulk upgrade request.
- *
- * @since 2.5.0
- *
- * @see Plugin_Upgrader::bulk_upgrade()
- *
- * @param array $plugins The local WP file_path's of the plugins which should be upgraded.
- * @param array $args Arbitrary passed extra arguments.
- * @return string|bool Install confirmation messages on success, false on failure.
- */
- public function bulk_upgrade( $plugins, $args = array() ) {
- add_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
- $result = parent::bulk_upgrade( $plugins, $args );
- remove_filter( 'upgrader_post_install', array( $this, 'auto_activate' ), 10 );
- return $result;
- }
- /**
- * Abuse a filter to auto-activate plugins after installation.
- *
- * Hooked into the 'upgrader_post_install' filter hook.
- *
- * @since 2.5.0
- *
- * @param bool $bool The value we need to give back (true).
- * @return bool
- */
- public function auto_activate( $bool ) {
- // Only process the activation of installed plugins if the automatic flag is set to true.
- if ( $this->tgmpa->is_automatic ) {
- // Flush plugins cache so the headers of the newly installed plugins will be read correctly.
- wp_clean_plugins_cache();
- // Get the installed plugin file.
- $plugin_info = $this->plugin_info();
- // Don't try to activate on upgrade of active plugin as WP will do this already.
- if ( ! is_plugin_active( $plugin_info ) ) {
- $activate = activate_plugin( $plugin_info );
- // Adjust the success string based on the activation result.
- $this->strings['process_success'] = $this->strings['process_success'] . "<br />\n";
- if ( is_wp_error( $activate ) ) {
- $this->skin->error( $activate );
- $this->strings['process_success'] .= $this->strings['activation_failed'];
- } else {
- $this->strings['process_success'] .= $this->strings['activation_success'];
- }
- }
- }
- return $bool;
- }
- }
- }
- if ( ! class_exists( 'TGMPA_Bulk_Installer_Skin' ) ) {
- /**
- * Installer skin to set strings for the bulk plugin installations..
- *
- * Extends Bulk_Upgrader_Skin and customizes to suit the installation of multiple
- * plugins.
- *
- * @since 2.2.0
- *
- * {@internal Since 2.5.2 the class has been renamed from TGM_Bulk_Installer_Skin to
- * TGMPA_Bulk_Installer_Skin.
- * This was done to prevent backward compatibility issues with v2.3.6.}}
- *
- * @see https://core.trac.wordpress.org/browser/trunk/src/wp-admin/includes/class-wp-upgrader-skins.php
- *
- * @package TGM-Plugin-Activation
- * @author Thomas Griffin
- * @author Gary Jones
- */
- class TGMPA_Bulk_Installer_Skin extends Bulk_Upgrader_Skin {
- /**
- * Holds plugin info for each individual plugin installation.
- *
- * @since 2.2.0
- *
- * @var array
- */
- public $plugin_info = array();
- /**
- * Holds names of plugins that are undergoing bulk installations.
- *
- * @since 2.2.0
- *
- * @var array
- */
- public $plugin_names = array();
- /**
- * Integer to use for iteration through each plugin installation.
- *
- * @since 2.2.0
- *
- * @var integer
- */
- public $i = 0;
- /**
- * TGMPA instance
- *
- * @since 2.5.0
- *
- * @var object
- */
- protected $tgmpa;
- /**
- * Constructor. Parses default args with new ones and extracts them for use.
- *
- * @since 2.2.0
- *
- * @param array $args Arguments to pass for use within the class.
- */
- public function __construct( $args = array() ) {
- // Get TGMPA class instance.
- $this->tgmpa = call_user_func( array( get_class( $GLOBALS['tgmpa'] ), 'get_instance' ) );
- // Parse default and new args.
- $defaults = array(
- 'url' => '',
- 'nonce' => '',
- 'names' => array(),
- 'install_type' => 'install',
- );
- $args = wp_parse_args( $args, $defaults );
- // Set plugin names to $this->plugin_names property.
- $this->plugin_names = $args['names'];
- // Extract the new args.
- parent::__construct( $args );
- }
- /**
- * Sets install skin strings for each individual plugin.
- *
- * Checks to see if the automatic activation flag is set and uses the
- * the proper strings accordingly.
- *
- * @since 2.2.0
- */
- public function add_strings() {
- if ( 'update' === $this->options['install_type'] ) {
- parent::add_strings();
- /* translators: 1: plugin name, 2: action number 3: total number of actions. */
- $this->upgrader->strings['skin_before_update_header'] = __( 'Updating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
- } else {
- /* translators: 1: plugin name, 2: error message. */
- $this->upgrader->strings['skin_update_failed_error'] = __( 'An error occurred while installing %1$s: <strong>%2$s</strong>.', 'tgmpa' );
- /* translators: 1: plugin name. */
- $this->upgrader->strings['skin_update_failed'] = __( 'The installation of %1$s failed.', 'tgmpa' );
- if ( $this->tgmpa->is_automatic ) {
- // Automatic activation strings.
- $this->upgrader->strings['skin_upgrade_start'] = __( 'The installation and activation process is starting. This process may take a while on some hosts, so please be patient.', 'tgmpa' );
- /* translators: 1: plugin name. */
- $this->upgrader->strings['skin_update_successful'] = __( '%1$s installed and activated successfully.', 'tgmpa' ) . ' <a href="#" class="hide-if-no-js" onclick="%2$s"><span>' . esc_html__( 'Show Details', 'tgmpa' ) . '</span><span class="hidden">' . esc_html__( 'Hide Details', 'tgmpa' ) . '</span>.</a>';
- $this->upgrader->strings['skin_upgrade_end'] = __( 'All installations and activations have been completed.', 'tgmpa' );
- /* translators: 1: plugin name, 2: action number 3: total number of actions. */
- $this->upgrader->strings['skin_before_update_header'] = __( 'Installing and Activating Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
- } else {
- // Default installation strings.
- $this->upgrader->strings['skin_upgrade_start'] = __( 'The installation process is starting. This process may take a while on some hosts, so please be patient.', 'tgmpa' );
- /* translators: 1: plugin name. */
- $this->upgrader->strings['skin_update_successful'] = esc_html__( '%1$s installed successfully.', 'tgmpa' ) . ' <a href="#" class="hide-if-no-js" onclick="%2$s"><span>' . esc_html__( 'Show Details', 'tgmpa' ) . '</span><span class="hidden">' . esc_html__( 'Hide Details', 'tgmpa' ) . '</span>.</a>';
- $this->upgrader->strings['skin_upgrade_end'] = __( 'All installations have been completed.', 'tgmpa' );
- /* translators: 1: plugin name, 2: action number 3: total number of actions. */
- $this->upgrader->strings['skin_before_update_header'] = __( 'Installing Plugin %1$s (%2$d/%3$d)', 'tgmpa' );
- }
- }
- }
- /**
- * Outputs the header strings and necessary JS before each plugin installation.
- *
- * @since 2.2.0
- *
- * @param string $title Unused in this implementation.
- */
- public function before( $title = '' ) {
- if ( empty( $title ) ) {
- $title = esc_html( $this->plugin_names[ $this->i ] );
- }
- parent::before( $title );
- }
- /**
- * Outputs the footer strings and necessary JS after each plugin installation.
- *
- * Checks for any errors and outputs them if they exist, else output
- * success strings.
- *
- * @since 2.2.0
- *
- * @param string $title Unused in this implementation.
- */
- public function after( $title = '' ) {
- if ( empty( $title ) ) {
- $title = esc_html( $this->plugin_names[ $this->i ] );
- }
- parent::after( $title );
- $this->i++;
- }
- /**
- * Outputs links after bulk plugin installation is complete.
- *
- * @since 2.2.0
- */
- public function bulk_footer() {
- // Serve up the string to say installations (and possibly activations) are complete.
- parent::bulk_footer();
- // Flush plugins cache so we can make sure that the installed plugins list is always up to date.
- wp_clean_plugins_cache();
- $this->tgmpa->show_tgmpa_version();
- // Display message based on if all plugins are now active or not.
- $update_actions = array();
- if ( $this->tgmpa->is_tgmpa_complete() ) {
- // All plugins are active, so we display the complete string and hide the menu to protect users.
- echo '<style type="text/css">#adminmenu .wp-submenu li.current { display: none !important; }</style>';
- $update_actions['dashboard'] = sprintf(
- esc_html( $this->tgmpa->strings['complete'] ),
- '<a href="' . esc_url( self_admin_url() ) . '">' . esc_html__( 'Return to the Dashboard', 'tgmpa' ) . '</a>'
- );
- } else {
- $update_actions['tgmpa_page'] = '<a href="' . esc_url( $this->tgmpa->get_tgmpa_url() ) . '" target="_parent">' . esc_html( $this->tgmpa->strings['return'] ) . '</a>';
- }
- /**
- * Filter the list of action links available following bulk plugin installs/updates.
- *
- * @since 2.5.0
- *
- * @param array $update_actions Array of plugin action links.
- * @param array $plugin_info Array of information for the last-handled plugin.
- */
- $update_actions = apply_filters( 'tgmpa_update_bulk_plugins_complete_actions', $update_actions, $this->plugin_info );
- if ( ! empty( $update_actions ) ) {
- $this->feedback( implode( ' | ', (array) $update_actions ) );
- }
- }
- /* *********** DEPRECATED METHODS *********** */
- /**
- * Flush header output buffer.
- *
- * @since 2.2.0
- * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
- * @see Bulk_Upgrader_Skin::flush_output()
- */
- public function before_flush_output() {
- _deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
- $this->flush_output();
- }
- /**
- * Flush footer output buffer and iterate $this->i to make sure the
- * installation strings reference the correct plugin.
- *
- * @since 2.2.0
- * @deprecated 2.5.0 use {@see Bulk_Upgrader_Skin::flush_output()} instead
- * @see Bulk_Upgrader_Skin::flush_output()
- */
- public function after_flush_output() {
- _deprecated_function( __FUNCTION__, 'TGMPA 2.5.0', 'Bulk_Upgrader_Skin::flush_output()' );
- $this->flush_output();
- $this->i++;
- }
- }
- }
- }
- }
- }
- if ( ! class_exists( 'TGMPA_Utils' ) ) {
- /**
- * Generic utilities for TGMPA.
- *
- * All methods are static, poor-dev name-spacing class wrapper.
- *
- * Class was called TGM_Utils in 2.5.0 but renamed TGMPA_Utils in 2.5.1 as this was conflicting with Soliloquy.
- *
- * @since 2.5.0
- *
- * @package TGM-Plugin-Activation
- * @author Juliette Reinders Folmer
- */
- class TGMPA_Utils {
- /**
- * Whether the PHP filter extension is enabled.
- *
- * @see http://php.net/book.filter
- *
- * @since 2.5.0
- *
- * @static
- *
- * @var bool $has_filters True is the extension is enabled.
- */
- public static $has_filters;
- /**
- * Wrap an arbitrary string in <em> tags. Meant to be used in combination with array_map().
- *
- * @since 2.5.0
- *
- * @static
- *
- * @param string $string Text to be wrapped.
- * @return string
- */
- public static function wrap_in_em( $string ) {
- return '<em>' . wp_kses_post( $string ) . '</em>';
- }
- /**
- * Wrap an arbitrary string in <strong> tags. Meant to be used in combination with array_map().
- *
- * @since 2.5.0
- *
- * @static
- *
- * @param string $string Text to be wrapped.
- * @return string
- */
- public static function wrap_in_strong( $string ) {
- return '<strong>' . wp_kses_post( $string ) . '</strong>';
- }
- /**
- * Helper function: Validate a value as boolean
- *
- * @since 2.5.0
- *
- * @static
- *
- * @param mixed $value Arbitrary value.
- * @return bool
- */
- public static function validate_bool( $value ) {
- if ( ! isset( self::$has_filters ) ) {
- self::$has_filters = extension_loaded( 'filter' );
- }
- if ( self::$has_filters ) {
- return filter_var( $value, FILTER_VALIDATE_BOOLEAN );
- } else {
- return self::emulate_filter_bool( $value );
- }
- }
- /**
- * Helper function: Cast a value to bool
- *
- * @since 2.5.0
- *
- * @static
- *
- * @param mixed $value Value to cast.
- * @return bool
- */
- protected static function emulate_filter_bool( $value ) {
- // @codingStandardsIgnoreStart
- static $true = array(
- '1',
- 'true', 'True', 'TRUE',
- 'y', 'Y',
- 'yes', 'Yes', 'YES',
- 'on', 'On', 'ON',
- );
- static $false = array(
- '0',
- 'false', 'False', 'FALSE',
- 'n', 'N',
- 'no', 'No', 'NO',
- 'off', 'Off', 'OFF',
- );
- // @codingStandardsIgnoreEnd
- if ( is_bool( $value ) ) {
- return $value;
- } elseif ( is_int( $value ) && ( 0 === $value || 1 === $value ) ) {
- return (bool) $value;
- } elseif ( ( is_float( $value ) && ! is_nan( $value ) ) && ( (float) 0 === $value || (float) 1 === $value ) ) {
- return (bool) $value;
- } elseif ( is_string( $value ) ) {
- $value = trim( $value );
- if ( in_array( $value, $true, true ) ) {
- return true;
- } elseif ( in_array( $value, $false, true ) ) {
- return false;
- } else {
- return false;
- }
- }
- return false;
- }
- } // End of class TGMPA_Utils
- } // End of class_exists wrapper
|