Documentation

class Reference{}

Details

  • Reference
  • class
  • Active
  • 1.0.0
  • Row

Properties

public $cache array
['from_post' => [], 'to_post' => [], 'redirection' => [] ]
Row
Local cache excluded from database

protected $cache_status_codes_option string
empty string
The place in the DB where we temporarily cache status code results for a scan

protected $from_how string
empty string
Row
How is it referenced (url, id, post)

protected $from_is_external bool
false
Is it a link from an external website beyond the multisite network?

protected $from_is_full bool
false
Is the original URL a full URL?

protected $from_is_public bool
false
Can it be accessed publicly?

protected $from_is_relative bool
false
Is the original URL a relative URL?

protected $from_post_id int
0
Row
Post ID of the source using this reference

protected $from_post_type string
empty string
Row
post, term, user

protected $from_relative string
empty string
The relative version of the URL

protected $from_url string
empty string
Original URL provided

protected $from_url_base string
empty string
The base version of the full URL

protected $from_url_full string
empty string
The full version of the original URL

protected $from_where string
empty string
Row
The context of where the reference is located (content, menu, featured image, post meta, redirect)

protected $from_where_key string
empty string
Row
the post meta key, term meta key, user meta key, or other specific reference related to from_where

protected $id int
0
Row
Unique ID in the database entry

protected $load_only bool
false
Controls whether it only loads the data given to the object on construct

protected $redirection_id int
0
Row
The unique ID of the redirection rule in the database

protected $redirection_site_id int
0
Row
The blog_id of the site where the redirection rule exists

protected $redirection_url string
empty string
Row
The URL that the redirect is sending the user to

protected $set_full_urls bool
true
Controls whether the full url properties are set during the construct of the object

protected $set_post_id bool
true
Controls whether the post IDs are found and set for the object during construct

protected $set_public bool
true
Controls whether the public properties are set during the construct of the object

protected $set_redirection bool
true
Controls whether the redirection data is retrieved and set during construct

protected $set_relative bool
true
Controls whether the relative url properties are set during the construct of the object

protected $set_status bool
true
Controls whether the status properties are set during object construct

protected $to_anchor_text string
empty string
Row
The anchor text used in the link

protected $to_block_name string
empty string
Row
The name of the block being used

protected $to_is_external bool
false
Is it a link to an external website beyond the multisite network?

protected $to_is_full bool
false
Is the original to URL a full URL?

protected $to_is_mail bool
false
Is it a mail link?

protected $to_is_public bool
false
Can the to reference be accessed publicly?

protected $to_is_relative bool
false
Is the original to URL a relative URL?

protected $to_is_tel bool
false
Is it a telephone number?

protected $to_post_id int
0
Row
Post ID of the reference

protected $to_post_type string
empty string
Row
// If in network, the post_type of the destination

protected $to_relative string
empty string
The relative version of the URL

protected $to_site_id int
0
Row
Multisite blog_id of the reference

protected $to_type string
empty string
Row
Describes what type of reference this is (link, image, block, redirect)

protected $to_url string
empty string
Row
Original URL provided

protected $to_url_absolute string
empty string
Row
The absolute version of the URL (not including the anchor link)

protected $to_url_base string
empty string
The base version of the to full URL

protected $to_url_full string
empty string
Row
The full version of the original URL

protected $to_url_status int
-1
Row
The status code of the original URL (Full version)

protected $to_url_status_date string
empty string
Row
The date the status code was determined

If you notice any incorrect or missing information on this page, please let us know.