1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404 |
- <?php
- /**
- * WordPress Plugin Administration API
- *
- * @package WordPress
- * @subpackage Administration
- */
- /**
- * Parses the plugin contents to retrieve plugin's metadata.
- *
- * All plugin headers must be on their own line. Plugin description must not have
- * any newlines, otherwise only parts of the description will be displayed.
- * The below is formatted for printing.
- *
- * /*
- * Plugin Name: Name of the plugin.
- * Plugin URI: The home page of the plugin.
- * Description: Plugin description.
- * Author: Plugin author's name.
- * Author URI: Link to the author's website.
- * Version: Plugin version.
- * Text Domain: Optional. Unique identifier, should be same as the one used in
- * load_plugin_textdomain().
- * Domain Path: Optional. Only useful if the translations are located in a
- * folder above the plugin's base path. For example, if .mo files are
- * located in the locale folder then Domain Path will be "/locale/" and
- * must have the first slash. Defaults to the base folder the plugin is
- * located in.
- * Network: Optional. Specify "Network: true" to require that a plugin is activated
- * across all sites in an installation. This will prevent a plugin from being
- * activated on a single site when Multisite is enabled.
- * Requires at least: Optional. Specify the minimum required WordPress version.
- * Requires PHP: Optional. Specify the minimum required PHP version.
- * * / # Remove the space to close comment.
- *
- * The first 8 KB of the file will be pulled in and if the plugin data is not
- * within that first 8 KB, then the plugin author should correct their plugin
- * and move the plugin data headers to the top.
- *
- * The plugin file is assumed to have permissions to allow for scripts to read
- * the file. This is not checked however and the file is only opened for
- * reading.
- *
- * @since 1.5.0
- * @since 5.3.0 Added support for `Requires at least` and `Requires PHP` headers.
- *
- * @param string $plugin_file Absolute path to the main plugin file.
- * @param bool $markup Optional. If the returned data should have HTML markup applied.
- * Default true.
- * @param bool $translate Optional. If the returned data should be translated. Default true.
- * @return array {
- * Plugin data. Values will be empty if not supplied by the plugin.
- *
- * @type string $Name Name of the plugin. Should be unique.
- * @type string $Title Title of the plugin and link to the plugin's site (if set).
- * @type string $Description Plugin description.
- * @type string $Author Author's name.
- * @type string $AuthorURI Author's website address (if set).
- * @type string $Version Plugin version.
- * @type string $TextDomain Plugin textdomain.
- * @type string $DomainPath Plugins relative directory path to .mo files.
- * @type bool $Network Whether the plugin can only be activated network-wide.
- * @type string $RequiresWP Minimum required version of WordPress.
- * @type string $RequiresPHP Minimum required version of PHP.
- * }
- */
- function get_plugin_data( $plugin_file, $markup = true, $translate = true ) {
- $default_headers = array(
- 'Name' => 'Plugin Name',
- 'PluginURI' => 'Plugin URI',
- 'Version' => 'Version',
- 'Description' => 'Description',
- 'Author' => 'Author',
- 'AuthorURI' => 'Author URI',
- 'TextDomain' => 'Text Domain',
- 'DomainPath' => 'Domain Path',
- 'Network' => 'Network',
- 'RequiresWP' => 'Requires at least',
- 'RequiresPHP' => 'Requires PHP',
- // Site Wide Only is deprecated in favor of Network.
- '_sitewide' => 'Site Wide Only',
- );
- $plugin_data = get_file_data( $plugin_file, $default_headers, 'plugin' );
- // Site Wide Only is the old header for Network.
- if ( ! $plugin_data['Network'] && $plugin_data['_sitewide'] ) {
- /* translators: 1: Site Wide Only: true, 2: Network: true */
- _deprecated_argument( __FUNCTION__, '3.0.0', sprintf( __( 'The %1$s plugin header is deprecated. Use %2$s instead.' ), '<code>Site Wide Only: true</code>', '<code>Network: true</code>' ) );
- $plugin_data['Network'] = $plugin_data['_sitewide'];
- }
- $plugin_data['Network'] = ( 'true' == strtolower( $plugin_data['Network'] ) );
- unset( $plugin_data['_sitewide'] );
- // If no text domain is defined fall back to the plugin slug.
- if ( ! $plugin_data['TextDomain'] ) {
- $plugin_slug = dirname( plugin_basename( $plugin_file ) );
- if ( '.' !== $plugin_slug && false === strpos( $plugin_slug, '/' ) ) {
- $plugin_data['TextDomain'] = $plugin_slug;
- }
- }
- if ( $markup || $translate ) {
- $plugin_data = _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup, $translate );
- } else {
- $plugin_data['Title'] = $plugin_data['Name'];
- $plugin_data['AuthorName'] = $plugin_data['Author'];
- }
- return $plugin_data;
- }
- /**
- * Sanitizes plugin data, optionally adds markup, optionally translates.
- *
- * @since 2.7.0
- *
- * @see get_plugin_data()
- *
- * @access private
- *
- * @param string $plugin_file Path to the main plugin file.
- * @param array $plugin_data An array of plugin data. See `get_plugin_data()`.
- * @param bool $markup Optional. If the returned data should have HTML markup applied.
- * Default true.
- * @param bool $translate Optional. If the returned data should be translated. Default true.
- * @return array {
- * Plugin data. Values will be empty if not supplied by the plugin.
- *
- * @type string $Name Name of the plugin. Should be unique.
- * @type string $Title Title of the plugin and link to the plugin's site (if set).
- * @type string $Description Plugin description.
- * @type string $Author Author's name.
- * @type string $AuthorURI Author's website address (if set).
- * @type string $Version Plugin version.
- * @type string $TextDomain Plugin textdomain.
- * @type string $DomainPath Plugins relative directory path to .mo files.
- * @type bool $Network Whether the plugin can only be activated network-wide.
- * }
- */
- function _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup = true, $translate = true ) {
- // Sanitize the plugin filename to a WP_PLUGIN_DIR relative path.
- $plugin_file = plugin_basename( $plugin_file );
- // Translate fields.
- if ( $translate ) {
- $textdomain = $plugin_data['TextDomain'];
- if ( $textdomain ) {
- if ( ! is_textdomain_loaded( $textdomain ) ) {
- if ( $plugin_data['DomainPath'] ) {
- load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) . $plugin_data['DomainPath'] );
- } else {
- load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) );
- }
- }
- } elseif ( 'hello.php' == basename( $plugin_file ) ) {
- $textdomain = 'default';
- }
- if ( $textdomain ) {
- foreach ( array( 'Name', 'PluginURI', 'Description', 'Author', 'AuthorURI', 'Version' ) as $field ) {
- // phpcs:ignore WordPress.WP.I18n.LowLevelTranslationFunction,WordPress.WP.I18n.NonSingularStringLiteralText,WordPress.WP.I18n.NonSingularStringLiteralDomain
- $plugin_data[ $field ] = translate( $plugin_data[ $field ], $textdomain );
- }
- }
- }
- // Sanitize fields.
- $allowed_tags_in_links = array(
- 'abbr' => array( 'title' => true ),
- 'acronym' => array( 'title' => true ),
- 'code' => true,
- 'em' => true,
- 'strong' => true,
- );
- $allowed_tags = $allowed_tags_in_links;
- $allowed_tags['a'] = array(
- 'href' => true,
- 'title' => true,
- );
- // Name is marked up inside <a> tags. Don't allow these.
- // Author is too, but some plugins have used <a> here (omitting Author URI).
- $plugin_data['Name'] = wp_kses( $plugin_data['Name'], $allowed_tags_in_links );
- $plugin_data['Author'] = wp_kses( $plugin_data['Author'], $allowed_tags );
- $plugin_data['Description'] = wp_kses( $plugin_data['Description'], $allowed_tags );
- $plugin_data['Version'] = wp_kses( $plugin_data['Version'], $allowed_tags );
- $plugin_data['PluginURI'] = esc_url( $plugin_data['PluginURI'] );
- $plugin_data['AuthorURI'] = esc_url( $plugin_data['AuthorURI'] );
- $plugin_data['Title'] = $plugin_data['Name'];
- $plugin_data['AuthorName'] = $plugin_data['Author'];
- // Apply markup.
- if ( $markup ) {
- if ( $plugin_data['PluginURI'] && $plugin_data['Name'] ) {
- $plugin_data['Title'] = '<a href="' . $plugin_data['PluginURI'] . '">' . $plugin_data['Name'] . '</a>';
- }
- if ( $plugin_data['AuthorURI'] && $plugin_data['Author'] ) {
- $plugin_data['Author'] = '<a href="' . $plugin_data['AuthorURI'] . '">' . $plugin_data['Author'] . '</a>';
- }
- $plugin_data['Description'] = wptexturize( $plugin_data['Description'] );
- if ( $plugin_data['Author'] ) {
- $plugin_data['Description'] .= sprintf(
- /* translators: %s: Plugin author. */
- ' <cite>' . __( 'By %s.' ) . '</cite>',
- $plugin_data['Author']
- );
- }
- }
- return $plugin_data;
- }
- /**
- * Get a list of a plugin's files.
- *
- * @since 2.8.0
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- * @return array List of files relative to the plugin root.
- */
- function get_plugin_files( $plugin ) {
- $plugin_file = WP_PLUGIN_DIR . '/' . $plugin;
- $dir = dirname( $plugin_file );
- $plugin_files = array( plugin_basename( $plugin_file ) );
- if ( is_dir( $dir ) && WP_PLUGIN_DIR !== $dir ) {
- /**
- * Filters the array of excluded directories and files while scanning the folder.
- *
- * @since 4.9.0
- *
- * @param string[] $exclusions Array of excluded directories and files.
- */
- $exclusions = (array) apply_filters( 'plugin_files_exclusions', array( 'CVS', 'node_modules', 'vendor', 'bower_components' ) );
- $list_files = list_files( $dir, 100, $exclusions );
- $list_files = array_map( 'plugin_basename', $list_files );
- $plugin_files = array_merge( $plugin_files, $list_files );
- $plugin_files = array_values( array_unique( $plugin_files ) );
- }
- return $plugin_files;
- }
- /**
- * Check the plugins directory and retrieve all plugin files with plugin data.
- *
- * WordPress only supports plugin files in the base plugins directory
- * (wp-content/plugins) and in one directory above the plugins directory
- * (wp-content/plugins/my-plugin). The file it looks for has the plugin data
- * and must be found in those two locations. It is recommended to keep your
- * plugin files in their own directories.
- *
- * The file with the plugin data is the file that will be included and therefore
- * needs to have the main execution for the plugin. This does not mean
- * everything must be contained in the file and it is recommended that the file
- * be split for maintainability. Keep everything in one file for extreme
- * optimization purposes.
- *
- * @since 1.5.0
- *
- * @param string $plugin_folder Optional. Relative path to single plugin folder.
- * @return array Key is the plugin file path and the value is an array of the plugin data.
- */
- function get_plugins( $plugin_folder = '' ) {
- $cache_plugins = wp_cache_get( 'plugins', 'plugins' );
- if ( ! $cache_plugins ) {
- $cache_plugins = array();
- }
- if ( isset( $cache_plugins[ $plugin_folder ] ) ) {
- return $cache_plugins[ $plugin_folder ];
- }
- $wp_plugins = array();
- $plugin_root = WP_PLUGIN_DIR;
- if ( ! empty( $plugin_folder ) ) {
- $plugin_root .= $plugin_folder;
- }
- // Files in wp-content/plugins directory.
- $plugins_dir = @ opendir( $plugin_root );
- $plugin_files = array();
- if ( $plugins_dir ) {
- while ( ( $file = readdir( $plugins_dir ) ) !== false ) {
- if ( substr( $file, 0, 1 ) == '.' ) {
- continue;
- }
- if ( is_dir( $plugin_root . '/' . $file ) ) {
- $plugins_subdir = @ opendir( $plugin_root . '/' . $file );
- if ( $plugins_subdir ) {
- while ( ( $subfile = readdir( $plugins_subdir ) ) !== false ) {
- if ( substr( $subfile, 0, 1 ) == '.' ) {
- continue;
- }
- if ( substr( $subfile, -4 ) == '.php' ) {
- $plugin_files[] = "$file/$subfile";
- }
- }
- closedir( $plugins_subdir );
- }
- } else {
- if ( substr( $file, -4 ) == '.php' ) {
- $plugin_files[] = $file;
- }
- }
- }
- closedir( $plugins_dir );
- }
- if ( empty( $plugin_files ) ) {
- return $wp_plugins;
- }
- foreach ( $plugin_files as $plugin_file ) {
- if ( ! is_readable( "$plugin_root/$plugin_file" ) ) {
- continue;
- }
- $plugin_data = get_plugin_data( "$plugin_root/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.
- if ( empty( $plugin_data['Name'] ) ) {
- continue;
- }
- $wp_plugins[ plugin_basename( $plugin_file ) ] = $plugin_data;
- }
- uasort( $wp_plugins, '_sort_uname_callback' );
- $cache_plugins[ $plugin_folder ] = $wp_plugins;
- wp_cache_set( 'plugins', $cache_plugins, 'plugins' );
- return $wp_plugins;
- }
- /**
- * Check the mu-plugins directory and retrieve all mu-plugin files with any plugin data.
- *
- * WordPress only includes mu-plugin files in the base mu-plugins directory (wp-content/mu-plugins).
- *
- * @since 3.0.0
- * @return array Key is the mu-plugin file path and the value is an array of the mu-plugin data.
- */
- function get_mu_plugins() {
- $wp_plugins = array();
- // Files in wp-content/mu-plugins directory.
- $plugin_files = array();
- if ( ! is_dir( WPMU_PLUGIN_DIR ) ) {
- return $wp_plugins;
- }
- $plugins_dir = @opendir( WPMU_PLUGIN_DIR );
- if ( $plugins_dir ) {
- while ( ( $file = readdir( $plugins_dir ) ) !== false ) {
- if ( substr( $file, -4 ) == '.php' ) {
- $plugin_files[] = $file;
- }
- }
- } else {
- return $wp_plugins;
- }
- closedir( $plugins_dir );
- if ( empty( $plugin_files ) ) {
- return $wp_plugins;
- }
- foreach ( $plugin_files as $plugin_file ) {
- if ( ! is_readable( WPMU_PLUGIN_DIR . "/$plugin_file" ) ) {
- continue;
- }
- $plugin_data = get_plugin_data( WPMU_PLUGIN_DIR . "/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.
- if ( empty( $plugin_data['Name'] ) ) {
- $plugin_data['Name'] = $plugin_file;
- }
- $wp_plugins[ $plugin_file ] = $plugin_data;
- }
- if ( isset( $wp_plugins['index.php'] ) && filesize( WPMU_PLUGIN_DIR . '/index.php' ) <= 30 ) { // silence is golden
- unset( $wp_plugins['index.php'] );
- }
- uasort( $wp_plugins, '_sort_uname_callback' );
- return $wp_plugins;
- }
- /**
- * Callback to sort array by a 'Name' key.
- *
- * @since 3.1.0
- *
- * @access private
- *
- * @param array $a array with 'Name' key.
- * @param array $b array with 'Name' key.
- * @return int Return 0 or 1 based on two string comparison.
- */
- function _sort_uname_callback( $a, $b ) {
- return strnatcasecmp( $a['Name'], $b['Name'] );
- }
- /**
- * Check the wp-content directory and retrieve all drop-ins with any plugin data.
- *
- * @since 3.0.0
- * @return array Key is the file path and the value is an array of the plugin data.
- */
- function get_dropins() {
- $dropins = array();
- $plugin_files = array();
- $_dropins = _get_dropins();
- // These exist in the wp-content directory.
- $plugins_dir = @opendir( WP_CONTENT_DIR );
- if ( $plugins_dir ) {
- while ( ( $file = readdir( $plugins_dir ) ) !== false ) {
- if ( isset( $_dropins[ $file ] ) ) {
- $plugin_files[] = $file;
- }
- }
- } else {
- return $dropins;
- }
- closedir( $plugins_dir );
- if ( empty( $plugin_files ) ) {
- return $dropins;
- }
- foreach ( $plugin_files as $plugin_file ) {
- if ( ! is_readable( WP_CONTENT_DIR . "/$plugin_file" ) ) {
- continue;
- }
- $plugin_data = get_plugin_data( WP_CONTENT_DIR . "/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.
- if ( empty( $plugin_data['Name'] ) ) {
- $plugin_data['Name'] = $plugin_file;
- }
- $dropins[ $plugin_file ] = $plugin_data;
- }
- uksort( $dropins, 'strnatcasecmp' );
- return $dropins;
- }
- /**
- * Returns drop-ins that WordPress uses.
- *
- * Includes Multisite drop-ins only when is_multisite()
- *
- * @since 3.0.0
- * @return array Key is file name. The value is an array, with the first value the
- * purpose of the drop-in and the second value the name of the constant that must be
- * true for the drop-in to be used, or true if no constant is required.
- */
- function _get_dropins() {
- $dropins = array(
- 'advanced-cache.php' => array( __( 'Advanced caching plugin.' ), 'WP_CACHE' ), // WP_CACHE
- 'db.php' => array( __( 'Custom database class.' ), true ), // auto on load
- 'db-error.php' => array( __( 'Custom database error message.' ), true ), // auto on error
- 'install.php' => array( __( 'Custom installation script.' ), true ), // auto on installation
- 'maintenance.php' => array( __( 'Custom maintenance message.' ), true ), // auto on maintenance
- 'object-cache.php' => array( __( 'External object cache.' ), true ), // auto on load
- 'php-error.php' => array( __( 'Custom PHP error message.' ), true ), // auto on error
- 'fatal-error-handler.php' => array( __( 'Custom PHP fatal error handler.' ), true ), // auto on error
- );
- if ( is_multisite() ) {
- $dropins['sunrise.php'] = array( __( 'Executed before Multisite is loaded.' ), 'SUNRISE' ); // SUNRISE
- $dropins['blog-deleted.php'] = array( __( 'Custom site deleted message.' ), true ); // auto on deleted blog
- $dropins['blog-inactive.php'] = array( __( 'Custom site inactive message.' ), true ); // auto on inactive blog
- $dropins['blog-suspended.php'] = array( __( 'Custom site suspended message.' ), true ); // auto on archived or spammed blog
- }
- return $dropins;
- }
- /**
- * Determines whether a plugin is active.
- *
- * Only plugins installed in the plugins/ folder can be active.
- *
- * Plugins in the mu-plugins/ folder can't be "activated," so this function will
- * return false for those plugins.
- *
- * For more information on this and similar theme functions, check out
- * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
- * Conditional Tags} article in the Theme Developer Handbook.
- *
- * @since 2.5.0
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- * @return bool True, if in the active plugins list. False, not in the list.
- */
- function is_plugin_active( $plugin ) {
- return in_array( $plugin, (array) get_option( 'active_plugins', array() ) ) || is_plugin_active_for_network( $plugin );
- }
- /**
- * Determines whether the plugin is inactive.
- *
- * Reverse of is_plugin_active(). Used as a callback.
- *
- * For more information on this and similar theme functions, check out
- * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
- * Conditional Tags} article in the Theme Developer Handbook.
- *
- * @since 3.1.0
- * @see is_plugin_active()
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- * @return bool True if inactive. False if active.
- */
- function is_plugin_inactive( $plugin ) {
- return ! is_plugin_active( $plugin );
- }
- /**
- * Determines whether the plugin is active for the entire network.
- *
- * Only plugins installed in the plugins/ folder can be active.
- *
- * Plugins in the mu-plugins/ folder can't be "activated," so this function will
- * return false for those plugins.
- *
- * For more information on this and similar theme functions, check out
- * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
- * Conditional Tags} article in the Theme Developer Handbook.
- *
- * @since 3.0.0
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- * @return bool True if active for the network, otherwise false.
- */
- function is_plugin_active_for_network( $plugin ) {
- if ( ! is_multisite() ) {
- return false;
- }
- $plugins = get_site_option( 'active_sitewide_plugins' );
- if ( isset( $plugins[ $plugin ] ) ) {
- return true;
- }
- return false;
- }
- /**
- * Checks for "Network: true" in the plugin header to see if this should
- * be activated only as a network wide plugin. The plugin would also work
- * when Multisite is not enabled.
- *
- * Checks for "Site Wide Only: true" for backward compatibility.
- *
- * @since 3.0.0
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- * @return bool True if plugin is network only, false otherwise.
- */
- function is_network_only_plugin( $plugin ) {
- $plugin_data = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin );
- if ( $plugin_data ) {
- return $plugin_data['Network'];
- }
- return false;
- }
- /**
- * Attempts activation of plugin in a "sandbox" and redirects on success.
- *
- * A plugin that is already activated will not attempt to be activated again.
- *
- * The way it works is by setting the redirection to the error before trying to
- * include the plugin file. If the plugin fails, then the redirection will not
- * be overwritten with the success message. Also, the options will not be
- * updated and the activation hook will not be called on plugin error.
- *
- * It should be noted that in no way the below code will actually prevent errors
- * within the file. The code should not be used elsewhere to replicate the
- * "sandbox", which uses redirection to work.
- * {@source 13 1}
- *
- * If any errors are found or text is outputted, then it will be captured to
- * ensure that the success redirection will update the error redirection.
- *
- * @since 2.5.0
- * @since 5.2.0 Test for WordPress version and PHP version compatibility.
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- * @param string $redirect Optional. URL to redirect to.
- * @param bool $network_wide Optional. Whether to enable the plugin for all sites in the network
- * or just the current site. Multisite only. Default false.
- * @param bool $silent Optional. Whether to prevent calling activation hooks. Default false.
- * @return WP_Error|null WP_Error on invalid file or null on success.
- */
- function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silent = false ) {
- $plugin = plugin_basename( trim( $plugin ) );
- if ( is_multisite() && ( $network_wide || is_network_only_plugin( $plugin ) ) ) {
- $network_wide = true;
- $current = get_site_option( 'active_sitewide_plugins', array() );
- $_GET['networkwide'] = 1; // Back compat for plugins looking for this value.
- } else {
- $current = get_option( 'active_plugins', array() );
- }
- $valid = validate_plugin( $plugin );
- if ( is_wp_error( $valid ) ) {
- return $valid;
- }
- $requirements = validate_plugin_requirements( $plugin );
- if ( is_wp_error( $requirements ) ) {
- return $requirements;
- }
- if ( ( $network_wide && ! isset( $current[ $plugin ] ) ) || ( ! $network_wide && ! in_array( $plugin, $current ) ) ) {
- if ( ! empty( $redirect ) ) {
- wp_redirect( add_query_arg( '_error_nonce', wp_create_nonce( 'plugin-activation-error_' . $plugin ), $redirect ) ); // we'll override this later if the plugin can be included without fatal error
- }
- ob_start();
- wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $plugin );
- $_wp_plugin_file = $plugin;
- if ( ! defined( 'WP_SANDBOX_SCRAPING' ) ) {
- define( 'WP_SANDBOX_SCRAPING', true );
- }
- include_once( WP_PLUGIN_DIR . '/' . $plugin );
- $plugin = $_wp_plugin_file; // Avoid stomping of the $plugin variable in a plugin.
- if ( ! $silent ) {
- /**
- * Fires before a plugin is activated.
- *
- * If a plugin is silently activated (such as during an update),
- * this hook does not fire.
- *
- * @since 2.9.0
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- * @param bool $network_wide Whether to enable the plugin for all sites in the network
- * or just the current site. Multisite only. Default is false.
- */
- do_action( 'activate_plugin', $plugin, $network_wide );
- /**
- * Fires as a specific plugin is being activated.
- *
- * This hook is the "activation" hook used internally by register_activation_hook().
- * The dynamic portion of the hook name, `$plugin`, refers to the plugin basename.
- *
- * If a plugin is silently activated (such as during an update), this hook does not fire.
- *
- * @since 2.0.0
- *
- * @param bool $network_wide Whether to enable the plugin for all sites in the network
- * or just the current site. Multisite only. Default is false.
- */
- do_action( "activate_{$plugin}", $network_wide );
- }
- if ( $network_wide ) {
- $current = get_site_option( 'active_sitewide_plugins', array() );
- $current[ $plugin ] = time();
- update_site_option( 'active_sitewide_plugins', $current );
- } else {
- $current = get_option( 'active_plugins', array() );
- $current[] = $plugin;
- sort( $current );
- update_option( 'active_plugins', $current );
- }
- if ( ! $silent ) {
- /**
- * Fires after a plugin has been activated.
- *
- * If a plugin is silently activated (such as during an update),
- * this hook does not fire.
- *
- * @since 2.9.0
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- * @param bool $network_wide Whether to enable the plugin for all sites in the network
- * or just the current site. Multisite only. Default is false.
- */
- do_action( 'activated_plugin', $plugin, $network_wide );
- }
- if ( ob_get_length() > 0 ) {
- $output = ob_get_clean();
- return new WP_Error( 'unexpected_output', __( 'The plugin generated unexpected output.' ), $output );
- }
- ob_end_clean();
- }
- return null;
- }
- /**
- * Deactivate a single plugin or multiple plugins.
- *
- * The deactivation hook is disabled by the plugin upgrader by using the $silent
- * parameter.
- *
- * @since 2.5.0
- *
- * @param string|array $plugins Single plugin or list of plugins to deactivate.
- * @param bool $silent Prevent calling deactivation hooks. Default is false.
- * @param mixed $network_wide Whether to deactivate the plugin for all sites in the network.
- * A value of null (the default) will deactivate plugins for both the site and the network.
- */
- function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {
- if ( is_multisite() ) {
- $network_current = get_site_option( 'active_sitewide_plugins', array() );
- }
- $current = get_option( 'active_plugins', array() );
- $do_blog = false;
- $do_network = false;
- foreach ( (array) $plugins as $plugin ) {
- $plugin = plugin_basename( trim( $plugin ) );
- if ( ! is_plugin_active( $plugin ) ) {
- continue;
- }
- $network_deactivating = false !== $network_wide && is_plugin_active_for_network( $plugin );
- if ( ! $silent ) {
- /**
- * Fires before a plugin is deactivated.
- *
- * If a plugin is silently deactivated (such as during an update),
- * this hook does not fire.
- *
- * @since 2.9.0
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
- * or just the current site. Multisite only. Default is false.
- */
- do_action( 'deactivate_plugin', $plugin, $network_deactivating );
- }
- if ( false !== $network_wide ) {
- if ( is_plugin_active_for_network( $plugin ) ) {
- $do_network = true;
- unset( $network_current[ $plugin ] );
- } elseif ( $network_wide ) {
- continue;
- }
- }
- if ( true !== $network_wide ) {
- $key = array_search( $plugin, $current );
- if ( false !== $key ) {
- $do_blog = true;
- unset( $current[ $key ] );
- }
- }
- if ( $do_blog && wp_is_recovery_mode() ) {
- list( $extension ) = explode( '/', $plugin );
- wp_paused_plugins()->delete( $extension );
- }
- if ( ! $silent ) {
- /**
- * Fires as a specific plugin is being deactivated.
- *
- * This hook is the "deactivation" hook used internally by register_deactivation_hook().
- * The dynamic portion of the hook name, `$plugin`, refers to the plugin basename.
- *
- * If a plugin is silently deactivated (such as during an update), this hook does not fire.
- *
- * @since 2.0.0
- *
- * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
- * or just the current site. Multisite only. Default is false.
- */
- do_action( "deactivate_{$plugin}", $network_deactivating );
- /**
- * Fires after a plugin is deactivated.
- *
- * If a plugin is silently deactivated (such as during an update),
- * this hook does not fire.
- *
- * @since 2.9.0
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network.
- * or just the current site. Multisite only. Default false.
- */
- do_action( 'deactivated_plugin', $plugin, $network_deactivating );
- }
- }
- if ( $do_blog ) {
- update_option( 'active_plugins', $current );
- }
- if ( $do_network ) {
- update_site_option( 'active_sitewide_plugins', $network_current );
- }
- }
- /**
- * Activate multiple plugins.
- *
- * When WP_Error is returned, it does not mean that one of the plugins had
- * errors. It means that one or more of the plugins file path was invalid.
- *
- * The execution will be halted as soon as one of the plugins has an error.
- *
- * @since 2.6.0
- *
- * @param string|array $plugins Single plugin or list of plugins to activate.
- * @param string $redirect Redirect to page after successful activation.
- * @param bool $network_wide Whether to enable the plugin for all sites in the network.
- * @param bool $silent Prevent calling activation hooks. Default is false.
- * @return bool|WP_Error True when finished or WP_Error if there were errors during a plugin activation.
- */
- function activate_plugins( $plugins, $redirect = '', $network_wide = false, $silent = false ) {
- if ( ! is_array( $plugins ) ) {
- $plugins = array( $plugins );
- }
- $errors = array();
- foreach ( $plugins as $plugin ) {
- if ( ! empty( $redirect ) ) {
- $redirect = add_query_arg( 'plugin', $plugin, $redirect );
- }
- $result = activate_plugin( $plugin, $redirect, $network_wide, $silent );
- if ( is_wp_error( $result ) ) {
- $errors[ $plugin ] = $result;
- }
- }
- if ( ! empty( $errors ) ) {
- return new WP_Error( 'plugins_invalid', __( 'One of the plugins is invalid.' ), $errors );
- }
- return true;
- }
- /**
- * Remove directory and files of a plugin for a list of plugins.
- *
- * @since 2.6.0
- *
- * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
- *
- * @param string[] $plugins List of plugin paths to delete, relative to the plugins directory.
- * @param string $deprecated Not used.
- * @return bool|null|WP_Error True on success, false if `$plugins` is empty, `WP_Error` on failure.
- * `null` if filesystem credentials are required to proceed.
- */
- function delete_plugins( $plugins, $deprecated = '' ) {
- global $wp_filesystem;
- if ( empty( $plugins ) ) {
- return false;
- }
- $checked = array();
- foreach ( $plugins as $plugin ) {
- $checked[] = 'checked[]=' . $plugin;
- }
- $url = wp_nonce_url( 'plugins.php?action=delete-selected&verify-delete=1&' . implode( '&', $checked ), 'bulk-plugins' );
- ob_start();
- $credentials = request_filesystem_credentials( $url );
- $data = ob_get_clean();
- if ( false === $credentials ) {
- if ( ! empty( $data ) ) {
- include_once( ABSPATH . 'wp-admin/admin-header.php' );
- echo $data;
- include( ABSPATH . 'wp-admin/admin-footer.php' );
- exit;
- }
- return;
- }
- if ( ! WP_Filesystem( $credentials ) ) {
- ob_start();
- request_filesystem_credentials( $url, '', true ); // Failed to connect, Error and request again.
- $data = ob_get_clean();
- if ( ! empty( $data ) ) {
- include_once( ABSPATH . 'wp-admin/admin-header.php' );
- echo $data;
- include( ABSPATH . 'wp-admin/admin-footer.php' );
- exit;
- }
- return;
- }
- if ( ! is_object( $wp_filesystem ) ) {
- return new WP_Error( 'fs_unavailable', __( 'Could not access filesystem.' ) );
- }
- if ( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) {
- return new WP_Error( 'fs_error', __( 'Filesystem error.' ), $wp_filesystem->errors );
- }
- // Get the base plugin folder.
- $plugins_dir = $wp_filesystem->wp_plugins_dir();
- if ( empty( $plugins_dir ) ) {
- return new WP_Error( 'fs_no_plugins_dir', __( 'Unable to locate WordPress plugin directory.' ) );
- }
- $plugins_dir = trailingslashit( $plugins_dir );
- $plugin_translations = wp_get_installed_translations( 'plugins' );
- $errors = array();
- foreach ( $plugins as $plugin_file ) {
- // Run Uninstall hook.
- if ( is_uninstallable_plugin( $plugin_file ) ) {
- uninstall_plugin( $plugin_file );
- }
- /**
- * Fires immediately before a plugin deletion attempt.
- *
- * @since 4.4.0
- *
- * @param string $plugin_file Path to the plugin file relative to the plugins directory.
- */
- do_action( 'delete_plugin', $plugin_file );
- $this_plugin_dir = trailingslashit( dirname( $plugins_dir . $plugin_file ) );
- // If plugin is in its own directory, recursively delete the directory.
- if ( strpos( $plugin_file, '/' ) && $this_plugin_dir != $plugins_dir ) { //base check on if plugin includes directory separator AND that it's not the root plugin folder
- $deleted = $wp_filesystem->delete( $this_plugin_dir, true );
- } else {
- $deleted = $wp_filesystem->delete( $plugins_dir . $plugin_file );
- }
- /**
- * Fires immediately after a plugin deletion attempt.
- *
- * @since 4.4.0
- *
- * @param string $plugin_file Path to the plugin file relative to the plugins directory.
- * @param bool $deleted Whether the plugin deletion was successful.
- */
- do_action( 'deleted_plugin', $plugin_file, $deleted );
- if ( ! $deleted ) {
- $errors[] = $plugin_file;
- continue;
- }
- // Remove language files, silently.
- $plugin_slug = dirname( $plugin_file );
- if ( '.' !== $plugin_slug && ! empty( $plugin_translations[ $plugin_slug ] ) ) {
- $translations = $plugin_translations[ $plugin_slug ];
- foreach ( $translations as $translation => $data ) {
- $wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.po' );
- $wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.mo' );
- $json_translation_files = glob( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '-*.json' );
- if ( $json_translation_files ) {
- array_map( array( $wp_filesystem, 'delete' ), $json_translation_files );
- }
- }
- }
- }
- // Remove deleted plugins from the plugin updates list.
- $current = get_site_transient( 'update_plugins' );
- if ( $current ) {
- // Don't remove the plugins that weren't deleted.
- $deleted = array_diff( $plugins, $errors );
- foreach ( $deleted as $plugin_file ) {
- unset( $current->response[ $plugin_file ] );
- }
- set_site_transient( 'update_plugins', $current );
- }
- if ( ! empty( $errors ) ) {
- if ( 1 === count( $errors ) ) {
- /* translators: %s: Plugin filename. */
- $message = __( 'Could not fully remove the plugin %s.' );
- } else {
- /* translators: %s: Comma-separated list of plugin filenames. */
- $message = __( 'Could not fully remove the plugins %s.' );
- }
- return new WP_Error( 'could_not_remove_plugin', sprintf( $message, implode( ', ', $errors ) ) );
- }
- return true;
- }
- /**
- * Validate active plugins
- *
- * Validate all active plugins, deactivates invalid and
- * returns an array of deactivated ones.
- *
- * @since 2.5.0
- * @return array invalid plugins, plugin as key, error as value
- */
- function validate_active_plugins() {
- $plugins = get_option( 'active_plugins', array() );
- // Validate vartype: array.
- if ( ! is_array( $plugins ) ) {
- update_option( 'active_plugins', array() );
- $plugins = array();
- }
- if ( is_multisite() && current_user_can( 'manage_network_plugins' ) ) {
- $network_plugins = (array) get_site_option( 'active_sitewide_plugins', array() );
- $plugins = array_merge( $plugins, array_keys( $network_plugins ) );
- }
- if ( empty( $plugins ) ) {
- return array();
- }
- $invalid = array();
- // Invalid plugins get deactivated.
- foreach ( $plugins as $plugin ) {
- $result = validate_plugin( $plugin );
- if ( is_wp_error( $result ) ) {
- $invalid[ $plugin ] = $result;
- deactivate_plugins( $plugin, true );
- }
- }
- return $invalid;
- }
- /**
- * Validate the plugin path.
- *
- * Checks that the main plugin file exists and is a valid plugin. See validate_file().
- *
- * @since 2.5.0
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- * @return WP_Error|int 0 on success, WP_Error on failure.
- */
- function validate_plugin( $plugin ) {
- if ( validate_file( $plugin ) ) {
- return new WP_Error( 'plugin_invalid', __( 'Invalid plugin path.' ) );
- }
- if ( ! file_exists( WP_PLUGIN_DIR . '/' . $plugin ) ) {
- return new WP_Error( 'plugin_not_found', __( 'Plugin file does not exist.' ) );
- }
- $installed_plugins = get_plugins();
- if ( ! isset( $installed_plugins[ $plugin ] ) ) {
- return new WP_Error( 'no_plugin_header', __( 'The plugin does not have a valid header.' ) );
- }
- return 0;
- }
- /**
- * Validate the plugin requirements for WP version and PHP version.
- *
- * @since 5.2.0
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- * @return true|WP_Error True if requirements are met, WP_Error on failure.
- */
- function validate_plugin_requirements( $plugin ) {
- $readme_file = WP_PLUGIN_DIR . '/' . dirname( $plugin ) . '/readme.txt';
- $plugin_data = array(
- 'requires' => '',
- 'requires_php' => '',
- );
- if ( file_exists( $readme_file ) ) {
- $plugin_data = get_file_data(
- $readme_file,
- array(
- 'requires' => 'Requires at least',
- 'requires_php' => 'Requires PHP',
- ),
- 'plugin'
- );
- }
- $plugin_data = array_merge( $plugin_data, get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin ) );
- // Check for headers in the plugin's PHP file, give precedence to the plugin headers.
- $plugin_data['requires'] = ! empty( $plugin_data['RequiresWP'] ) ? $plugin_data['RequiresWP'] : $plugin_data['requires'];
- $plugin_data['requires_php'] = ! empty( $plugin_data['RequiresPHP'] ) ? $plugin_data['RequiresPHP'] : $plugin_data['requires_php'];
- $plugin_data['wp_compatible'] = is_wp_version_compatible( $plugin_data['requires'] );
- $plugin_data['php_compatible'] = is_php_version_compatible( $plugin_data['requires_php'] );
- if ( ! $plugin_data['wp_compatible'] && ! $plugin_data['php_compatible'] ) {
- return new WP_Error(
- 'plugin_wp_php_incompatible',
- sprintf(
- /* translators: %s: Plugin name. */
- __( '<strong>Error:</strong> Current WordPress and PHP versions do not meet minimum requirements for %s.' ),
- $plugin_data['Name']
- )
- );
- } elseif ( ! $plugin_data['php_compatible'] ) {
- return new WP_Error(
- 'plugin_php_incompatible',
- sprintf(
- /* translators: %s: Plugin name. */
- __( '<strong>Error:</strong> Current PHP version does not meet minimum requirements for %s.' ),
- $plugin_data['Name']
- )
- );
- } elseif ( ! $plugin_data['wp_compatible'] ) {
- return new WP_Error(
- 'plugin_wp_incompatible',
- sprintf(
- /* translators: %s: Plugin name. */
- __( '<strong>Error:</strong> Current WordPress version does not meet minimum requirements for %s.' ),
- $plugin_data['Name']
- )
- );
- }
- return true;
- }
- /**
- * Whether the plugin can be uninstalled.
- *
- * @since 2.7.0
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- * @return bool Whether plugin can be uninstalled.
- */
- function is_uninstallable_plugin( $plugin ) {
- $file = plugin_basename( $plugin );
- $uninstallable_plugins = (array) get_option( 'uninstall_plugins' );
- if ( isset( $uninstallable_plugins[ $file ] ) || file_exists( WP_PLUGIN_DIR . '/' . dirname( $file ) . '/uninstall.php' ) ) {
- return true;
- }
- return false;
- }
- /**
- * Uninstall a single plugin.
- *
- * Calls the uninstall hook, if it is available.
- *
- * @since 2.7.0
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- * @return true True if a plugin's uninstall.php file has been found and included.
- */
- function uninstall_plugin( $plugin ) {
- $file = plugin_basename( $plugin );
- $uninstallable_plugins = (array) get_option( 'uninstall_plugins' );
- /**
- * Fires in uninstall_plugin() immediately before the plugin is uninstalled.
- *
- * @since 4.5.0
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- * @param array $uninstallable_plugins Uninstallable plugins.
- */
- do_action( 'pre_uninstall_plugin', $plugin, $uninstallable_plugins );
- if ( file_exists( WP_PLUGIN_DIR . '/' . dirname( $file ) . '/uninstall.php' ) ) {
- if ( isset( $uninstallable_plugins[ $file ] ) ) {
- unset( $uninstallable_plugins[ $file ] );
- update_option( 'uninstall_plugins', $uninstallable_plugins );
- }
- unset( $uninstallable_plugins );
- define( 'WP_UNINSTALL_PLUGIN', $file );
- wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $file );
- include( WP_PLUGIN_DIR . '/' . dirname( $file ) . '/uninstall.php' );
- return true;
- }
- if ( isset( $uninstallable_plugins[ $file ] ) ) {
- $callable = $uninstallable_plugins[ $file ];
- unset( $uninstallable_plugins[ $file ] );
- update_option( 'uninstall_plugins', $uninstallable_plugins );
- unset( $uninstallable_plugins );
- wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $file );
- include( WP_PLUGIN_DIR . '/' . $file );
- add_action( "uninstall_{$file}", $callable );
- /**
- * Fires in uninstall_plugin() once the plugin has been uninstalled.
- *
- * The action concatenates the 'uninstall_' prefix with the basename of the
- * plugin passed to uninstall_plugin() to create a dynamically-named action.
- *
- * @since 2.7.0
- */
- do_action( "uninstall_{$file}" );
- }
- }
- //
- // Menu
- //
- /**
- * Add a top-level menu page.
- *
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
- *
- * @since 1.5.0
- *
- * @global array $menu
- * @global array $admin_page_hooks
- * @global array $_registered_pages
- * @global array $_parent_pages
- *
- * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected.
- * @param string $menu_title The text to be used for the menu.
- * @param string $capability The capability required for this menu to be displayed to the user.
- * @param string $menu_slug The slug name to refer to this menu by. Should be unique for this menu page and only
- * include lowercase alphanumeric, dashes, and underscores characters to be compatible
- * with sanitize_key().
- * @param callable $function The function to be called to output the content for this page.
- * @param string $icon_url The URL to the icon to be used for this menu.
- * * Pass a base64-encoded SVG using a data URI, which will be colored to match
- * the color scheme. This should begin with 'data:image/svg+xml;base64,'.
- * * Pass the name of a Dashicons helper class to use a font icon,
- * e.g. 'dashicons-chart-pie'.
- * * Pass 'none' to leave div.wp-menu-image empty so an icon can be added via CSS.
- * @param int $position The position in the menu order this item should appear.
- * @return string The resulting page's hook_suffix.
- */
- function add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '', $position = null ) {
- global $menu, $admin_page_hooks, $_registered_pages, $_parent_pages;
- $menu_slug = plugin_basename( $menu_slug );
- $admin_page_hooks[ $menu_slug ] = sanitize_title( $menu_title );
- $hookname = get_plugin_page_hookname( $menu_slug, '' );
- if ( ! empty( $function ) && ! empty( $hookname ) && current_user_can( $capability ) ) {
- add_action( $hookname, $function );
- }
- if ( empty( $icon_url ) ) {
- $icon_url = 'dashicons-admin-generic';
- $icon_class = 'menu-icon-generic ';
- } else {
- $icon_url = set_url_scheme( $icon_url );
- $icon_class = '';
- }
- $new_menu = array( $menu_title, $capability, $menu_slug, $page_title, 'menu-top ' . $icon_class . $hookname, $hookname, $icon_url );
- if ( null === $position ) {
- $menu[] = $new_menu;
- } elseif ( isset( $menu[ "$position" ] ) ) {
- $position = $position + substr( base_convert( md5( $menu_slug . $menu_title ), 16, 10 ), -5 ) * 0.00001;
- $menu[ "$position" ] = $new_menu;
- } else {
- $menu[ $position ] = $new_menu;
- }
- $_registered_pages[ $hookname ] = true;
- // No parent as top level
- $_parent_pages[ $menu_slug ] = false;
- return $hookname;
- }
- /**
- * Add a submenu page.
- *
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
- *
- * @since 1.5.0
- * @since 5.3.0 Added the `$position` parameter.
- *
- * @global array $submenu
- * @global array $menu
- * @global array $_wp_real_parent_file
- * @global bool $_wp_submenu_nopriv
- * @global array $_registered_pages
- * @global array $_parent_pages
- *
- * @param string $parent_slug The slug name for the parent menu (or the file name of a standard
- * WordPress admin page).
- * @param string $page_title The text to be displayed in the title tags of the page when the menu
- * is selected.
- * @param string $menu_title The text to be used for the menu.
- * @param string $capability The capability required for this menu to be displayed to the user.
- * @param string $menu_slug The slug name to refer to this menu by. Should be unique for this menu
- * and only include lowercase alphanumeric, dashes, and underscores characters
- * to be compatible with sanitize_key().
- * @param callable $function The function to be called to output the content for this page.
- * @param int $position The position in the menu order this item should appear.
- * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
- */
- function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
- global $submenu, $menu, $_wp_real_parent_file, $_wp_submenu_nopriv,
- $_registered_pages, $_parent_pages;
- $menu_slug = plugin_basename( $menu_slug );
- $parent_slug = plugin_basename( $parent_slug );
- if ( isset( $_wp_real_parent_file[ $parent_slug ] ) ) {
- $parent_slug = $_wp_real_parent_file[ $parent_slug ];
- }
- if ( ! current_user_can( $capability ) ) {
- $_wp_submenu_nopriv[ $parent_slug ][ $menu_slug ] = true;
- return false;
- }
- /*
- * If the parent doesn't already have a submenu, add a link to the parent
- * as the first item in the submenu. If the submenu file is the same as the
- * parent file someone is trying to link back to the parent manually. In
- * this case, don't automatically add a link back to avoid duplication.
- */
- if ( ! isset( $submenu[ $parent_slug ] ) && $menu_slug != $parent_slug ) {
- foreach ( (array) $menu as $parent_menu ) {
- if ( $parent_menu[2] == $parent_slug && current_user_can( $parent_menu[1] ) ) {
- $submenu[ $parent_slug ][] = array_slice( $parent_menu, 0, 4 );
- }
- }
- }
- $new_sub_menu = array( $menu_title, $capability, $menu_slug, $page_title );
- if ( ! is_int( $position ) ) {
- if ( null !== $position ) {
- _doing_it_wrong(
- __FUNCTION__,
- sprintf(
- /* translators: %s: add_submenu_page() */
- __( 'The seventh parameter passed to %s should be an integer representing menu position.' ),
- '<code>add_submenu_page()</code>'
- ),
- '5.3.0'
- );
- }
- $submenu[ $parent_slug ][] = $new_sub_menu;
- } else {
- // If position is equal or higher than the number of items in the array, append the submenu.
- if ( $position >= count( $submenu[ $parent_slug ] ) ) {
- $submenu[ $parent_slug ][] = $new_sub_menu;
- } else {
- // Test for a negative position.
- $position = max( $position, 0 );
- if ( 0 === $position ) {
- // For negative or `0` positions, prepend the submenu.
- array_unshift( $submenu[ $parent_slug ], $new_sub_menu );
- } else {
- // Grab all of the items before the insertion point.
- $before_items = array_slice( $submenu[ $parent_slug ], 0, $position, true );
- // Grab all of the items after the insertion point.
- $after_items = array_slice( $submenu[ $parent_slug ], $position, null, true );
- // Add the new item.
- $before_items[] = $new_sub_menu;
- // Merge the items.
- $submenu[ $parent_slug ] = array_merge( $before_items, $after_items );
- }
- }
- }
- // Sort the parent array
- ksort( $submenu[ $parent_slug ] );
- $hookname = get_plugin_page_hookname( $menu_slug, $parent_slug );
- if ( ! empty( $function ) && ! empty( $hookname ) ) {
- add_action( $hookname, $function );
- }
- $_registered_pages[ $hookname ] = true;
- /*
- * Backward-compatibility for plugins using add_management_page().
- * See wp-admin/admin.php for redirect from edit.php to tools.php.
- */
- if ( 'tools.php' == $parent_slug ) {
- $_registered_pages[ get_plugin_page_hookname( $menu_slug, 'edit.php' ) ] = true;
- }
- // No parent as top level.
- $_parent_pages[ $menu_slug ] = $parent_slug;
- return $hookname;
- }
- /**
- * Add submenu page to the Tools main menu.
- *
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
- *
- * @since 1.5.0
- * @since 5.3.0 Added the `$position` parameter.
- *
- * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected.
- * @param string $menu_title The text to be used for the menu.
- * @param string $capability The capability required for this menu to be displayed to the user.
- * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu).
- * @param callable $function The function to be called to output the content for this page.
- * @param int $position The position in the menu order this item should appear.
- * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
- */
- function add_management_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
- return add_submenu_page( 'tools.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
- }
- /**
- * Add submenu page to the Settings main menu.
- *
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
- *
- * @since 1.5.0
- * @since 5.3.0 Added the `$position` parameter.
- *
- * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected.
- * @param string $menu_title The text to be used for the menu.
- * @param string $capability The capability required for this menu to be displayed to the user.
- * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu).
- * @param callable $function The function to be called to output the content for this page.
- * @param int $position The position in the menu order this item should appear.
- * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
- */
- function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
- return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
- }
- /**
- * Add submenu page to the Appearance main menu.
- *
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
- *
- * @since 2.0.0
- * @since 5.3.0 Added the `$position` parameter.
- *
- * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected.
- * @param string $menu_title The text to be used for the menu.
- * @param string $capability The capability required for this menu to be displayed to the user.
- * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu).
- * @param callable $function The function to be called to output the content for this page.
- * @param int $position The position in the menu order this item should appear.
- * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
- */
- function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
- return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
- }
- /**
- * Add submenu page to the Plugins main menu.
- *
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
- *
- * @since 3.0.0
- * @since 5.3.0 Added the `$position` parameter.
- *
- * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected.
- * @param string $menu_title The text to be used for the menu.
- * @param string $capability The capability required for this menu to be displayed to the user.
- * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu).
- * @param callable $function The function to be called to output the content for this page.
- * @param int $position The position in the menu order this item should appear.
- * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
- */
- function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
- return add_submenu_page( 'plugins.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
- }
- /**
- * Add submenu page to the Users/Profile main menu.
- *
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
- *
- * @since 2.1.3
- * @since 5.3.0 Added the `$position` parameter.
- *
- * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected.
- * @param string $menu_title The text to be used for the menu.
- * @param string $capability The capability required for this menu to be displayed to the user.
- * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu).
- * @param callable $function The function to be called to output the content for this page.
- * @param int $position The position in the menu order this item should appear.
- * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
- */
- function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
- if ( current_user_can( 'edit_users' ) ) {
- $parent = 'users.php';
- } else {
- $parent = 'profile.php';
- }
- return add_submenu_page( $parent, $page_title, $menu_title, $capability, $menu_slug, $function, $position );
- }
- /**
- * Add submenu page to the Dashboard main menu.
- *
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
- *
- * @since 2.7.0
- * @since 5.3.0 Added the `$position` parameter.
- *
- * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected.
- * @param string $menu_title The text to be used for the menu.
- * @param string $capability The capability required for this menu to be displayed to the user.
- * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu).
- * @param callable $function The function to be called to output the content for this page.
- * @param int $position The position in the menu order this item should appear.
- * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
- */
- function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
- return add_submenu_page( 'index.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
- }
- /**
- * Add submenu page to the Posts main menu.
- *
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
- *
- * @since 2.7.0
- * @since 5.3.0 Added the `$position` parameter.
- *
- * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected.
- * @param string $menu_title The text to be used for the menu.
- * @param string $capability The capability required for this menu to be displayed to the user.
- * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu).
- * @param callable $function The function to be called to output the content for this page.
- * @param int $position The position in the menu order this item should appear.
- * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
- */
- function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
- return add_submenu_page( 'edit.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
- }
- /**
- * Add submenu page to the Media main menu.
- *
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
- *
- * @since 2.7.0
- * @since 5.3.0 Added the `$position` parameter.
- *
- * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected.
- * @param string $menu_title The text to be used for the menu.
- * @param string $capability The capability required for this menu to be displayed to the user.
- * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu).
- * @param callable $function The function to be called to output the content for this page.
- * @param int $position The position in the menu order this item should appear.
- * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
- */
- function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
- return add_submenu_page( 'upload.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
- }
- /**
- * Add submenu page to the Links main menu.
- *
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
- *
- * @since 2.7.0
- * @since 5.3.0 Added the `$position` parameter.
- *
- * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected.
- * @param string $menu_title The text to be used for the menu.
- * @param string $capability The capability required for this menu to be displayed to the user.
- * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu).
- * @param callable $function The function to be called to output the content for this page.
- * @param int $position The position in the menu order this item should appear.
- * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
- */
- function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
- return add_submenu_page( 'link-manager.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
- }
- /**
- * Add submenu page to the Pages main menu.
- *
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
- *
- * @since 2.7.0
- * @since 5.3.0 Added the `$position` parameter.
- *
- * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected.
- * @param string $menu_title The text to be used for the menu.
- * @param string $capability The capability required for this menu to be displayed to the user.
- * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu).
- * @param callable $function The function to be called to output the content for this page.
- * @param int $position The position in the menu order this item should appear.
- * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
- */
- function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
- return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
- }
- /**
- * Add submenu page to the Comments main menu.
- *
- * This function takes a capability which will be used to determine whether
- * or not a page is included in the menu.
- *
- * The function which is hooked in to handle the output of the page must check
- * that the user has the required capability as well.
- *
- * @since 2.7.0
- * @since 5.3.0 Added the `$position` parameter.
- *
- * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected.
- * @param string $menu_title The text to be used for the menu.
- * @param string $capability The capability required for this menu to be displayed to the user.
- * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu).
- * @param callable $function The function to be called to output the content for this page.
- * @param int $position The position in the menu order this item should appear.
- * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
- */
- function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $position = null ) {
- return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function, $position );
- }
- /**
- * Remove a top-level admin menu.
- *
- * @since 3.1.0
- *
- * @global array $menu
- *
- * @param string $menu_slug The slug of the menu.
- * @return array|bool The removed menu on success, false if not found.
- */
- function remove_menu_page( $menu_slug ) {
- global $menu;
- foreach ( $menu as $i => $item ) {
- if ( $menu_slug == $item[2] ) {
- unset( $menu[ $i ] );
- return $item;
- }
- }
- return false;
- }
- /**
- * Remove an admin submenu.
- *
- * @since 3.1.0
- *
- * @global array $submenu
- *
- * @param string $menu_slug The slug for the parent menu.
- * @param string $submenu_slug The slug of the submenu.
- * @return array|bool The removed submenu on success, false if not found.
- */
- function remove_submenu_page( $menu_slug, $submenu_slug ) {
- global $submenu;
- if ( ! isset( $submenu[ $menu_slug ] ) ) {
- return false;
- }
- foreach ( $submenu[ $menu_slug ] as $i => $item ) {
- if ( $submenu_slug == $item[2] ) {
- unset( $submenu[ $menu_slug ][ $i ] );
- return $item;
- }
- }
- return false;
- }
- /**
- * Get the url to access a particular menu page based on the slug it was registered with.
- *
- * If the slug hasn't been registered properly no url will be returned
- *
- * @since 3.0.0
- *
- * @global array $_parent_pages
- *
- * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
- * @param bool $echo Whether or not to echo the url - default is true
- * @return string the url
- */
- function menu_page_url( $menu_slug, $echo = true ) {
- global $_parent_pages;
- if ( isset( $_parent_pages[ $menu_slug ] ) ) {
- $parent_slug = $_parent_pages[ $menu_slug ];
- if ( $parent_slug && ! isset( $_parent_pages[ $parent_slug ] ) ) {
- $url = admin_url( add_query_arg( 'page', $menu_slug, $parent_slug ) );
- } else {
- $url = admin_url( 'admin.php?page=' . $menu_slug );
- }
- } else {
- $url = '';
- }
- $url = esc_url( $url );
- if ( $echo ) {
- echo $url;
- }
- return $url;
- }
- //
- // Pluggable Menu Support -- Private
- //
- /**
- * @global string $parent_file
- * @global array $menu
- * @global array $submenu
- * @global string $pagenow
- * @global string $typenow
- * @global string $plugin_page
- * @global array $_wp_real_parent_file
- * @global array $_wp_menu_nopriv
- * @global array $_wp_submenu_nopriv
- *
- * @return string
- */
- function get_admin_page_parent( $parent = '' ) {
- global $parent_file, $menu, $submenu, $pagenow, $typenow,
- $plugin_page, $_wp_real_parent_file, $_wp_menu_nopriv, $_wp_submenu_nopriv;
- if ( ! empty( $parent ) && 'admin.php' != $parent ) {
- if ( isset( $_wp_real_parent_file[ $parent ] ) ) {
- $parent = $_wp_real_parent_file[ $parent ];
- }
- return $parent;
- }
- if ( $pagenow == 'admin.php' && isset( $plugin_page ) ) {
- foreach ( (array) $menu as $parent_menu ) {
- if ( $parent_menu[2] == $plugin_page ) {
- $parent_file = $plugin_page;
- if ( isset( $_wp_real_parent_file[ $parent_file ] ) ) {
- $parent_file = $_wp_real_parent_file[ $parent_file ];
- }
- return $parent_file;
- }
- }
- if ( isset( $_wp_menu_nopriv[ $plugin_page ] ) ) {
- $parent_file = $plugin_page;
- if ( isset( $_wp_real_parent_file[ $parent_file ] ) ) {
- $parent_file = $_wp_real_parent_file[ $parent_file ];
- }
- return $parent_file;
- }
- }
- if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[ $pagenow ][ $plugin_page ] ) ) {
- $parent_file = $pagenow;
- if ( isset( $_wp_real_parent_file[ $parent_file ] ) ) {
- $parent_file = $_wp_real_parent_file[ $parent_file ];
- }
- return $parent_file;
- }
- foreach ( array_keys( (array) $submenu ) as $parent ) {
- foreach ( $submenu[ $parent ] as $submenu_array ) {
- if ( isset( $_wp_real_parent_file[ $parent ] ) ) {
- $parent = $_wp_real_parent_file[ $parent ];
- }
- if ( ! empty( $typenow ) && ( $submenu_array[2] == "$pagenow?post_type=$typenow" ) ) {
- $parent_file = $parent;
- return $parent;
- } elseif ( $submenu_array[2] == $pagenow && empty( $typenow ) && ( empty( $parent_file ) || false === strpos( $parent_file, '?' ) ) ) {
- $parent_file = $parent;
- return $parent;
- } elseif ( isset( $plugin_page ) && ( $plugin_page == $submenu_array[2] ) ) {
- $parent_file = $parent;
- return $parent;
- }
- }
- }
- if ( empty( $parent_file ) ) {
- $parent_file = '';
- }
- return '';
- }
- /**
- * @global string $title
- * @global array $menu
- * @global array $submenu
- * @global string $pagenow
- * @global string $plugin_page
- * @global string $typenow
- *
- * @return string
- */
- function get_admin_page_title() {
- global $title, $menu, $submenu, $pagenow, $plugin_page, $typenow;
- if ( ! empty( $title ) ) {
- return $title;
- }
- $hook = get_plugin_page_hook( $plugin_page, $pagenow );
- $parent = get_admin_page_parent();
- $parent1 = $parent;
- if ( empty( $parent ) ) {
- foreach ( (array) $menu as $menu_array ) {
- if ( isset( $menu_array[3] ) ) {
- if ( $menu_array[2] == $pagenow ) {
- $title = $menu_array[3];
- return $menu_array[3];
- } elseif ( isset( $plugin_page ) && ( $plugin_page == $menu_array[2] ) && ( $hook == $menu_array[3] ) ) {
- $title = $menu_array[3];
- return $menu_array[3];
- }
- } else {
- $title = $menu_array[0];
- return $title;
- }
- }
- } else {
- foreach ( array_keys( $submenu ) as $parent ) {
- foreach ( $submenu[ $parent ] as $submenu_array ) {
- if ( isset( $plugin_page ) &&
- ( $plugin_page == $submenu_array[2] ) &&
- (
- ( $parent == $pagenow ) ||
- ( $parent == $plugin_page ) ||
- ( $plugin_page == $hook ) ||
- ( $pagenow == 'admin.php' && $parent1 != $submenu_array[2] ) ||
- ( ! empty( $typenow ) && $parent == $pagenow . '?post_type=' . $typenow )
- )
- ) {
- $title = $submenu_array[3];
- return $submenu_array[3];
- }
- if ( $submenu_array[2] != $pagenow || isset( $_GET['page'] ) ) { // not the current page
- continue;
- }
- if ( isset( $submenu_array[3] ) ) {
- $title = $submenu_array[3];
- return $submenu_array[3];
- } else {
- $title = $submenu_array[0];
- return $title;
- }
- }
- }
- if ( empty( $title ) ) {
- foreach ( $menu as $menu_array ) {
- if ( isset( $plugin_page ) &&
- ( $plugin_page == $menu_array[2] ) &&
- ( $pagenow == 'admin.php' ) &&
- ( $parent1 == $menu_array[2] ) ) {
- $title = $menu_array[3];
- return $menu_array[3];
- }
- }
- }
- }
- return $title;
- }
- /**
- * @since 2.3.0
- *
- * @param string $plugin_page The slug name of the plugin page.
- * @param string $parent_page The slug name for the parent menu (or the file name of a standard
- * WordPress admin page).
- * @return string|null Hook attached to the plugin page, null otherwise.
- */
- function get_plugin_page_hook( $plugin_page, $parent_page ) {
- $hook = get_plugin_page_hookname( $plugin_page, $parent_page );
- if ( has_action( $hook ) ) {
- return $hook;
- } else {
- return null;
- }
- }
- /**
- * @global array $admin_page_hooks
- *
- * @param string $plugin_page The slug name of the plugin page.
- * @param string $parent_page The slug name for the parent menu (or the file name of a standard
- * WordPress admin page).
- * @return string Hook name for the plugin page.
- */
- function get_plugin_page_hookname( $plugin_page, $parent_page ) {
- global $admin_page_hooks;
- $parent = get_admin_page_parent( $parent_page );
- $page_type = 'admin';
- if ( empty( $parent_page ) || 'admin.php' == $parent_page || isset( $admin_page_hooks[ $plugin_page ] ) ) {
- if ( isset( $admin_page_hooks[ $plugin_page ] ) ) {
- $page_type = 'toplevel';
- } elseif ( isset( $admin_page_hooks[ $parent ] ) ) {
- $page_type = $admin_page_hooks[ $parent ];
- }
- } elseif ( isset( $admin_page_hooks[ $parent ] ) ) {
- $page_type = $admin_page_hooks[ $parent ];
- }
- $plugin_name = preg_replace( '!\.php!', '', $plugin_page );
- return $page_type . '_page_' . $plugin_name;
- }
- /**
- * @global string $pagenow
- * @global array $menu
- * @global array $submenu
- * @global array $_wp_menu_nopriv
- * @global array $_wp_submenu_nopriv
- * @global string $plugin_page
- * @global array $_registered_pages
- *
- * @return bool Whether the current user can access the current admin page.
- */
- function user_can_access_admin_page() {
- global $pagenow, $menu, $submenu, $_wp_menu_nopriv, $_wp_submenu_nopriv,
- $plugin_page, $_registered_pages;
- $parent = get_admin_page_parent();
- if ( ! isset( $plugin_page ) && isset( $_wp_submenu_nopriv[ $parent ][ $pagenow ] ) ) {
- return false;
- }
- if ( isset( $plugin_page ) ) {
- if ( isset( $_wp_submenu_nopriv[ $parent ][ $plugin_page ] ) ) {
- return false;
- }
- $hookname = get_plugin_page_hookname( $plugin_page, $parent );
- if ( ! isset( $_registered_pages[ $hookname ] ) ) {
- return false;
- }
- }
- if ( empty( $parent ) ) {
- if ( isset( $_wp_menu_nopriv[ $pagenow ] ) ) {
- return false;
- }
- if ( isset( $_wp_submenu_nopriv[ $pagenow ][ $pagenow ] ) ) {
- return false;
- }
- if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[ $pagenow ][ $plugin_page ] ) ) {
- return false;
- }
- if ( isset( $plugin_page ) && isset( $_wp_menu_nopriv[ $plugin_page ] ) ) {
- return false;
- }
- foreach ( array_keys( $_wp_submenu_nopriv ) as $key ) {
- if ( isset( $_wp_submenu_nopriv[ $key ][ $pagenow ] ) ) {
- return false;
- }
- if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[ $key ][ $plugin_page ] ) ) {
- return false;
- }
- }
- return true;
- }
- if ( isset( $plugin_page ) && ( $plugin_page == $parent ) && isset( $_wp_menu_nopriv[ $plugin_page ] ) ) {
- return false;
- }
- if ( isset( $submenu[ $parent ] ) ) {
- foreach ( $submenu[ $parent ] as $submenu_array ) {
- if ( isset( $plugin_page ) && ( $submenu_array[2] == $plugin_page ) ) {
- if ( current_user_can( $submenu_array[1] ) ) {
- return true;
- } else {
- return false;
- }
- } elseif ( $submenu_array[2] == $pagenow ) {
- if ( current_user_can( $submenu_array[1] ) ) {
- return true;
- } else {
- return false;
- }
- }
- }
- }
- foreach ( $menu as $menu_array ) {
- if ( $menu_array[2] == $parent ) {
- if ( current_user_can( $menu_array[1] ) ) {
- return true;
- } else {
- return false;
- }
- }
- }
- return true;
- }
- /* Whitelist functions */
- /**
- * Refreshes the value of the options whitelist available via the 'whitelist_options' hook.
- *
- * See the {@see 'whitelist_options'} filter.
- *
- * @since 2.7.0
- *
- * @global array $new_whitelist_options
- *
- * @param array $options
- * @return array
- */
- function option_update_filter( $options ) {
- global $new_whitelist_options;
- if ( is_array( $new_whitelist_options ) ) {
- $options = add_option_whitelist( $new_whitelist_options, $options );
- }
- return $options;
- }
- /**
- * Adds an array of options to the options whitelist.
- *
- * @since 2.7.0
- *
- * @global array $whitelist_options
- *
- * @param array $new_options
- * @param string|array $options
- * @return array
- */
- function add_option_whitelist( $new_options, $options = '' ) {
- if ( $options == '' ) {
- global $whitelist_options;
- } else {
- $whitelist_options = $options;
- }
- foreach ( $new_options as $page => $keys ) {
- foreach ( $keys as $key ) {
- if ( ! isset( $whitelist_options[ $page ] ) || ! is_array( $whitelist_options[ $page ] ) ) {
- $whitelist_options[ $page ] = array();
- $whitelist_options[ $page ][] = $key;
- } else {
- $pos = array_search( $key, $whitelist_options[ $page ] );
- if ( $pos === false ) {
- $whitelist_options[ $page ][] = $key;
- }
- }
- }
- }
- return $whitelist_options;
- }
- /**
- * Removes a list of options from the options whitelist.
- *
- * @since 2.7.0
- *
- * @global array $whitelist_options
- *
- * @param array $del_options
- * @param string|array $options
- * @return array
- */
- function remove_option_whitelist( $del_options, $options = '' ) {
- if ( $options == '' ) {
- global $whitelist_options;
- } else {
- $whitelist_options = $options;
- }
- foreach ( $del_options as $page => $keys ) {
- foreach ( $keys as $key ) {
- if ( isset( $whitelist_options[ $page ] ) && is_array( $whitelist_options[ $page ] ) ) {
- $pos = array_search( $key, $whitelist_options[ $page ] );
- if ( $pos !== false ) {
- unset( $whitelist_options[ $page ][ $pos ] );
- }
- }
- }
- }
- return $whitelist_options;
- }
- /**
- * Output nonce, action, and option_page fields for a settings page.
- *
- * @since 2.7.0
- *
- * @param string $option_group A settings group name. This should match the group name used in register_setting().
- */
- function settings_fields( $option_group ) {
- echo "<input type='hidden' name='option_page' value='" . esc_attr( $option_group ) . "' />";
- echo '<input type="hidden" name="action" value="update" />';
- wp_nonce_field( "$option_group-options" );
- }
- /**
- * Clears the Plugins cache used by get_plugins() and by default, the Plugin Update cache.
- *
- * @since 3.7.0
- *
- * @param bool $clear_update_cache Whether to clear the Plugin updates cache
- */
- function wp_clean_plugins_cache( $clear_update_cache = true ) {
- if ( $clear_update_cache ) {
- delete_site_transient( 'update_plugins' );
- }
- wp_cache_delete( 'plugins', 'plugins' );
- }
- /**
- * Load a given plugin attempt to generate errors.
- *
- * @since 3.0.0
- * @since 4.4.0 Function was moved into the `wp-admin/includes/plugin.php` file.
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- */
- function plugin_sandbox_scrape( $plugin ) {
- if ( ! defined( 'WP_SANDBOX_SCRAPING' ) ) {
- define( 'WP_SANDBOX_SCRAPING', true );
- }
- wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $plugin );
- include( WP_PLUGIN_DIR . '/' . $plugin );
- }
- /**
- * Helper function for adding content to the Privacy Policy Guide.
- *
- * Plugins and themes should suggest text for inclusion in the site's privacy policy.
- * The suggested text should contain information about any functionality that affects user privacy,
- * and will be shown on the Privacy Policy Guide screen.
- *
- * A plugin or theme can use this function multiple times as long as it will help to better present
- * the suggested policy content. For example modular plugins such as WooCommerse or Jetpack
- * can add or remove suggested content depending on the modules/extensions that are enabled.
- * For more information see the Plugin Handbook:
- * https://developer.wordpress.org/plugins/privacy/suggesting-text-for-the-site-privacy-policy/.
- *
- * Intended for use with the `'admin_init'` action.
- *
- * @since 4.9.6
- *
- * @param string $plugin_name The name of the plugin or theme that is suggesting content for the site's privacy policy.
- * @param string $policy_text The suggested content for inclusion in the policy.
- */
- function wp_add_privacy_policy_content( $plugin_name, $policy_text ) {
- if ( ! is_admin() ) {
- _doing_it_wrong(
- __FUNCTION__,
- sprintf(
- /* translators: %s: admin_init */
- __( 'The suggested privacy policy content should be added only in wp-admin by using the %s (or later) action.' ),
- '<code>admin_init</code>'
- ),
- '4.9.7'
- );
- return;
- } elseif ( ! doing_action( 'admin_init' ) && ! did_action( 'admin_init' ) ) {
- _doing_it_wrong(
- __FUNCTION__,
- sprintf(
- /* translators: %s: admin_init */
- __( 'The suggested privacy policy content should be added by using the %s (or later) action. Please see the inline documentation.' ),
- '<code>admin_init</code>'
- ),
- '4.9.7'
- );
- return;
- }
- if ( ! class_exists( 'WP_Privacy_Policy_Content' ) ) {
- require_once( ABSPATH . 'wp-admin/includes/class-wp-privacy-policy-content.php' );
- }
- WP_Privacy_Policy_Content::add( $plugin_name, $policy_text );
- }
- /**
- * Determines whether a plugin is technically active but was paused while
- * loading.
- *
- * For more information on this and similar theme functions, check out
- * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
- * Conditional Tags} article in the Theme Developer Handbook.
- *
- * @since 5.2.0
- *
- * @param string $plugin Path to the plugin file relative to the plugins directory.
- * @return bool True, if in the list of paused plugins. False, not in the list.
- */
- function is_plugin_paused( $plugin ) {
- if ( ! isset( $GLOBALS['_paused_plugins'] ) ) {
- return false;
- }
- if ( ! is_plugin_active( $plugin ) ) {
- return false;
- }
- list( $plugin ) = explode( '/', $plugin );
- return array_key_exists( $plugin, $GLOBALS['_paused_plugins'] );
- }
- /**
- * Gets the error that was recorded for a paused plugin.
- *
- * @since 5.2.0
- *
- * @param string $plugin Path to the plugin file relative to the plugins
- * directory.
- * @return array|false Array of error information as it was returned by
- * `error_get_last()`, or false if none was recorded.
- */
- function wp_get_plugin_error( $plugin ) {
- if ( ! isset( $GLOBALS['_paused_plugins'] ) ) {
- return false;
- }
- list( $plugin ) = explode( '/', $plugin );
- if ( ! array_key_exists( $plugin, $GLOBALS['_paused_plugins'] ) ) {
- return false;
- }
- return $GLOBALS['_paused_plugins'][ $plugin ];
- }
- /**
- * Tries to resume a single plugin.
- *
- * If a redirect was provided, we first ensure the plugin does not throw fatal
- * errors anymore.
- *
- * The way it works is by setting the redirection to the error before trying to
- * include the plugin file. If the plugin fails, then the redirection will not
- * be overwritten with the success message and the plugin will not be resumed.
- *
- * @since 5.2.0
- *
- * @param string $plugin Single plugin to resume.
- * @param string $redirect Optional. URL to redirect to. Default empty string.
- * @return bool|WP_Error True on success, false if `$plugin` was not paused,
- * `WP_Error` on failure.
- */
- function resume_plugin( $plugin, $redirect = '' ) {
- /*
- * We'll override this later if the plugin could be resumed without
- * creating a fatal error.
- */
- if ( ! empty( $redirect ) ) {
- wp_redirect(
- add_query_arg(
- '_error_nonce',
- wp_create_nonce( 'plugin-resume-error_' . $plugin ),
- $redirect
- )
- );
- // Load the plugin to test whether it throws a fatal error.
- ob_start();
- plugin_sandbox_scrape( $plugin );
- ob_clean();
- }
- list( $extension ) = explode( '/', $plugin );
- $result = wp_paused_plugins()->delete( $extension );
- if ( ! $result ) {
- return new WP_Error(
- 'could_not_resume_plugin',
- __( 'Could not resume the plugin.' )
- );
- }
- return true;
- }
- /**
- * Renders an admin notice in case some plugins have been paused due to errors.
- *
- * @since 5.2.0
- */
- function paused_plugins_notice() {
- if ( 'plugins.php' === $GLOBALS['pagenow'] ) {
- return;
- }
- if ( ! current_user_can( 'resume_plugins' ) ) {
- return;
- }
- if ( ! isset( $GLOBALS['_paused_plugins'] ) || empty( $GLOBALS['_paused_plugins'] ) ) {
- return;
- }
- printf(
- '<div class="notice notice-error"><p><strong>%s</strong><br>%s</p><p><a href="%s">%s</a></p></div>',
- __( 'One or more plugins failed to load properly.' ),
- __( 'You can find more details and make changes on the Plugins screen.' ),
- esc_url( admin_url( 'plugins.php?plugin_status=paused' ) ),
- __( 'Go to the Plugins screen' )
- );
- }
|