Display Line Numbers snippet

Hi @germankiwi,

Thanks for bringing this to my attention – I don’t remember seeing the original post at all.

It looks like the introduction of namespaces in Code Snippets v3 is what caused this snippet to stop working. Here’s an updated version:

namespace Code_Snippets;

$render_callback = function () {
	// Default to 2 (where I put the code description)
	$line_number = $_POST['line_number'] ?? 2;
	$lines = '';

	/*
	* Show the results (when 'Show' button is pressed)
	*/
	if ( isset( $_POST['show'] ) ) {
		$all_snippets = get_snippets();

		foreach ( $all_snippets as $snippet ) {
			if ( $snippet->active ) {
				$lines .= sprintf(
					'<hr><p><a href="%s" target="blank">%s</a></p>%s',
					esc_url( code_snippets()->get_snippet_edit_url( $snippet->id ) ),
					esc_html( $snippet->display_name ),
					PHP_EOL
				);

				$code = explode( PHP_EOL, $snippet->code );

				if ( (int) $line_number <= count( $code ) ) {
					$lines .= '<pre><code>' . esc_html( trim( $code[ $line_number - 1 ] ) ) . '</code></pre>' . PHP_EOL;
				}
			}
		}
	}

	/*
	* Set the line number to show
	*/
	echo '
<div class="wrap">
	<h1>' . esc_html( get_admin_page_title() ) . '</h1>
	<p>This will display the contents of a given line number for all of your active snippets. You can use this to help identify which snippet is causing a particular PHP error on your website.</p>
	<p>For example, if you receive a PHP error similar to this, which mentions the <strong>snippet-ops.php</strong> file, it means one of your snippets is causing the error:</p>
	<p><code>Undefined variable: xyz in /wp-content/plugins/code-snippets/php/snippet-ops.php(446) : eval()\'d code on line N</code></p>
	<p>Then you can enter the line number from the error message into the field below, and look through the results to find which snippet contains the text that matches the cause of the error (eg. "xyz" in the above example).</p>
	<hr>
	<form method="post" action="">
		<p>Line number to show: <input type="text" name="line_number" value="' . esc_attr( $line_number ) . '">&nbsp;
		<input type="submit" name="show" value="Show"></p>
	</form>
	<h2>Results:</h2>
	' . $lines . '
</div>';
};

add_action( 'admin_menu', function () use ( $render_callback ) {
	add_submenu_page(
		'snippets',
		'Display Snippet Line Numbers',
		'Display Line Numbers',
		code_snippets()->get_cap(),
		'snippet-line-number',
		$render_callback
	);
}, 99 );

Hi @bungeshea,

Thanks so much for the quick reply and for providing an updated snippet! I just tested it and it works perfectly! ??

I have a question though: let’s say I enter a larger number for the “line number to show” field – for example, the number “30” – and let’s say I have loads of snippets that contain less than 30 lines, and just a few that contain more than 30 lines.

Is it possible for it to only return the snippets which actually contain 30+ lines, and to skip the ones that don’t?

Because currently it just lists every single snippet I have (over 100 of them), even though most of them don’t contain that many lines.

I hope that makes sense! ??

Absolutely! Apologies for taking so long to get back to you; I started working on an update but got sidetracked.

I’ve decided to upload the new snippet to our cloud platform, instead of needing to share another wall of code here: https://codesnippets.cloud/snippet/shea/snippet-line-numbers

Please let me know if you have any other suggestions for how it might be improved.

Thanks so much, @bungeshea – much appreciated!

However, I’m having trouble getting it to work. When I copy your snippet verbatim to my site, and I click the “Show” button on that subpage, it just gives me a blank, white page. Could you test it and see if it works for you?

Also, is it possible to set a different default value in the field, other than 0? In my previous version of this snippet (the one I have in my comment above), I had the default set to 2. But with your snippet, if I change the number 0 to the number 2 at the end of line 4 of your snippet, then it automatically performs a search of line 2 whenever the subpage is opened, rather than waiting for the Show button to be clicked.

That’s my bad @germankiwi – I changed the form to use GET instead of POST but forgot that doesn’t work super well on admin pages.

I’ve gone and added back in the default line number value. Hopefully the new version works properly!

https://codesnippets.cloud/snippet/shea/snippet-line-numbers

Thanks again @bungeshea – now it works perfectly!

In my opinion, you should consider adding this to the plugin itself – I think a lot of your users would find it very useful! ??

We’ll definitely consider a good way to integrate it! I do think having additional features like this as snippets isn’t too bad though, as it allows for greater customisation.