wp_doc_link_parse( string $content ): string[]

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$contentstring

Return value

string[]

Array of function names.

Performance profile

How much work a call to wp_doc_link_parse() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

4–38

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 87.

Plugin surface

1 hook

Third-party callbacks on 'documentation_ignore_functions' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_doc_link_parse() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while wp_doc_link_parse() runs, in this order:

1. 1
   apply_filters( documentation_ignore_functions )filterline 672 (+42 into the body)

   Filters the list of functions and classes to be ignored from the documentation lookup.

Uses · 1

• apply_filters()Calls the callback functions that have been added to a filter hook.

Source code

View on Trac ↗View on GitHub ↗

630function wp_doc_link_parse( $content ) {631	if ( ! is_string( $content ) || empty( $content ) ) {632		return array();633	}634 635	if ( ! function_exists( 'token_get_all' ) ) {636		return array();637	}638 639	$tokens           = token_get_all( $content );640	$count            = count( $tokens );641	$functions        = array();642	$ignore_functions = array();643 644	for ( $t = 0; $t < $count - 2; $t++ ) {645		if ( ! is_array( $tokens[ $t ] ) ) {646			continue;647		}648 649		if ( T_STRING === $tokens[ $t ][0] && ( '(' === $tokens[ $t + 1 ] || '(' === $tokens[ $t + 2 ] ) ) {650			// If it's a function or class defined locally, there's not going to be any docs available.651			if ( ( isset( $tokens[ $t - 2 ][1] ) && in_array( $tokens[ $t - 2 ][1], array( 'function', 'class' ), true ) )652				|| ( isset( $tokens[ $t - 2 ][0] ) && T_OBJECT_OPERATOR === $tokens[ $t - 1 ][0] )653			) {654				$ignore_functions[] = $tokens[ $t ][1];655			}656 657			// Add this to our stack of unique references.658			$functions[] = $tokens[ $t ][1];659		}660	}661 662	$functions = array_unique( $functions );663	sort( $functions );664 665	/**666	 * Filters the list of functions and classes to be ignored from the documentation lookup.667	 *668	 * @since 2.8.0669	 *670	 * @param string[] $ignore_functions Array of names of functions and classes to be ignored.671	 */672	$ignore_functions = apply_filters( 'documentation_ignore_functions', $ignore_functions );673 674	$ignore_functions = array_unique( $ignore_functions );675 676	$output = array();677 678	foreach ( $functions as $function ) {679		if ( in_array( $function, $ignore_functions, true ) ) {680			continue;681		}682 683		$output[] = $function;684	}685 686	return $output;687}

Changelog

Introduced in 2.8.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-admin/includes/misc.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.