xfn_check( string $xfn_relationship, string $xfn_value = '', mixed $deprecated = '' )
- Since
- 1.0.1
- Source
wp-admin/includes/meta-boxes.php:1261
Compatibility
- WordPress
- since 1.0.1
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$xfn_relationshipstring- XFN relationship category. Possible values are: 'friendship', 'physical', 'professional', 'geographical', 'family', 'romantic', 'identity'.
$xfn_valuestringoptional- The XFN value to mark as checked if it matches the current link's relationship.
Default empty string.Default:'' $deprecatedmixedoptional- Deprecated. Not used.Default:
''
Performance profile
How much work a call to xfn_check() 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
- Trivial
- Scaling
- Constant
- Instructions
- 19–58
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 58.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- regexregular expression over the whole input
preg_split()called directly - hookthird-party callbacks
do_action()one call below xfn_check()
Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 8 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost xfn_check() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($deprecated) | 19–36 | preg_split() |
!empty($deprecated) | 23–40 | _deprecated_argument(), preg_split() |
empty($deprecated) && $xfn_value === "" | 32–42 | preg_split(), array_intersect() |
!empty($deprecated) && $xfn_value === "" | 36–46 | _deprecated_argument(), preg_split(), array_intersect() |
empty($deprecated) && $xfn_value === "" | 37–48 | preg_split(), array_intersect(), array_intersect() |
!empty($deprecated) && $xfn_value === "" | 41–52 | _deprecated_argument(), preg_split(), array_intersect(), array_intersect() |
empty($deprecated) && $xfn_value === "" && $xfn_relationship === "family" && $xfn_relationship === "friendship" && $xfn_relationship === "geographical" | 42–54 | preg_split(), array_intersect(), array_intersect(), array_intersect() |
!empty($deprecated) && $xfn_value === "" && $xfn_relationship === "family" && $xfn_relationship === "friendship" && $xfn_relationship === "geographical" | 46–58 | _deprecated_argument(), preg_split(), array_intersect(), array_intersect(), array_intersect() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 58 | 19–58 | 13 | |
| 8.5 | 58 | 19–58 | 13 | |
| 8.4 | 58 | 19–58 | 13 | 6 fewer instructions than PHP 8.3 |
| 8.3 | 64 | 19–64 | 13 | |
| 8.2 | 64 | 19–64 | 13 | |
| 8.1 | 64 | 19–64 | 13 | |
| 7.4 | 64 | 19–64 | 13 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 1
- _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
Used by · 1
- link_xfn_meta_box()Displays XFN form fields.
Source code
function xfn_check( $xfn_relationship, $xfn_value = '', $deprecated = '' ) { global $link; if ( ! empty( $deprecated ) ) { _deprecated_argument( __FUNCTION__, '2.5.0' ); // Never implemented. } $link_rel = $link->link_rel ?? ''; $link_rels = preg_split( '/\s+/', $link_rel ); // Mark the specified value as checked if it matches the current link's relationship. if ( '' !== $xfn_value && in_array( $xfn_value, $link_rels, true ) ) { echo ' checked="checked"'; } if ( '' === $xfn_value ) { // Mark the 'none' value as checked if the current link does not match the specified relationship. if ( 'family' === $xfn_relationship && ! array_intersect( $link_rels, array( 'child', 'parent', 'sibling', 'spouse', 'kin' ) ) ) { echo ' checked="checked"'; } if ( 'friendship' === $xfn_relationship && ! array_intersect( $link_rels, array( 'friend', 'acquaintance', 'contact' ) ) ) { echo ' checked="checked"'; } if ( 'geographical' === $xfn_relationship && ! array_intersect( $link_rels, array( 'co-resident', 'neighbor' ) ) ) { echo ' checked="checked"'; } // Mark the 'me' value as checked if it matches the current link's relationship. if ( 'identity' === $xfn_relationship && in_array( 'me', $link_rels, true ) ) { echo ' checked="checked"'; } }}Changelog
Introduced in 1.0.1. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-admin/includes/meta-boxes.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.