Merge pull request #1222 from crstauf/help-source-name

Display name of source of Action Scheduler library in the Help pulldown.

Author: barryhughes

classes/ActionScheduler_AdminView.php

@@ -250,8 +250,19 @@ public function add_help_tabs() {
 			return;
 		}
 
-		$as_version = ActionScheduler_Versions::instance()->latest_version();
-		$as_source  = ActionScheduler_Versions::instance()->active_source();
+		$as_version       = ActionScheduler_Versions::instance()->latest_version();
+		$as_source        = ActionScheduler_Versions::instance()->active_source();
+		$as_source_path   = ActionScheduler_Versions::instance()->active_source_path();
+		$as_source_markup = sprintf( '<code>%s</code>', esc_html( $as_source_path ) );
+
+		if ( ! empty( $as_source ) ) {
+			$as_source_markup = sprintf(
+				'%s: <abbr title="%s">%s</abbr>',
+				ucfirst( $as_source['type'] ),
+				esc_attr( $as_source_path ),
+				esc_html( $as_source['name'] )
+			);
+		}
 
 		$screen->add_help_tab(
 			array(
@@ -267,7 +278,7 @@ public function add_help_tabs() {
 					'<p>' .
 						esc_html__( 'Action Scheduler is currently being loaded from the following location. This can be useful when debugging, or if requested by the support team.', 'action-scheduler' ) .
 					'</p>' .
-					'<p><code>' . esc_html( $as_source ) . '</code></p>' .
+					'<p>' . $as_source_markup . '</p>' .
 					'<h3>' . esc_html__( 'WP CLI', 'action-scheduler' ) . '</h3>' .
 					'<p>' .
 						sprintf(

classes/ActionScheduler_Versions.php

@@ -110,11 +110,77 @@ public static function initialize_latest_version() {
 	}
 
 	/**
-	 * Get directory of active source.
+	 * Returns information about the plugin or theme which contains the current active version
+	 * of Action Scheduler.
+	 *
+	 * If this cannot be determined, or if Action Scheduler is being loaded via some other
+	 * method, then it will return an empty array. Otherwise, if populated, the array will
+	 * look like the following:
+	 *
+	 *     [
+	 *         'type' => 'plugin', # or 'theme'
+	 *         'name' => 'Name',
+	 *     ]
+	 *
+	 * @return array
+	 */
+	public function active_source(): array {
+		$file         = __FILE__;
+		$dir          = __DIR__;
+		$plugins      = get_plugins();
+		$plugin_files = array_keys( $plugins );
+
+		foreach ( $plugin_files as $plugin_file ) {
+			$plugin_path = trailingslashit( WP_PLUGIN_DIR ) . dirname( $plugin_file );
+			$plugin_file = trailingslashit( WP_PLUGIN_DIR ) . $plugin_file;
+
+			if ( 0 !== strpos( dirname( $dir ), $plugin_path ) ) {
+				continue;
+			}
+
+			$plugin_data = get_plugin_data( $plugin_file );
+
+			if ( ! is_array( $plugin_data ) || empty( $plugin_data['Name'] ) ) {
+				continue;
+			}
+
+			return array(
+				'type' => 'plugin',
+				'name' => $plugin_data['Name'],
+			);
+		}
+
+		$themes = (array) search_theme_directories();
+
+		foreach ( $themes as $slug => $data ) {
+			$needle = trailingslashit( $data['theme_root'] ) . $slug . '/';
+
+			if ( 0 !== strpos( $file, $needle ) ) {
+				continue;
+			}
+
+			$theme = wp_get_theme( $slug );
+
+			if ( ! is_object( $theme ) || ! is_a( $theme, \WP_Theme::class ) ) {
+				continue;
+			}
+
+			return array(
+				'type' => 'theme',
+				// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+				'name' => $theme->Name,
+			);
+		}
+
+		return array();
+	}
+
+	/**
+	 * Returns the directory path for the currently active installation of Action Scheduler.
 	 *
 	 * @return string
 	 */
-	public function active_source() {
+	public function active_source_path(): string {
 		return trailingslashit( dirname( __DIR__ ) );
 	}
 }

classes/WP_CLI/System_Command.php

@@ -148,7 +148,7 @@ public function source( array $args, array $assoc_args ) {
 		$all      = (bool) get_flag_value( $assoc_args, 'all' );
 		$fullpath = (bool) get_flag_value( $assoc_args, 'fullpath' );
 		$versions = \ActionScheduler_Versions::instance();
-		$source   = $versions->active_source();
+		$source   = $versions->active_source_path();
 		$path     = $source;
 
 		if ( ! $fullpath ) {