Class EPL_Author

EPL_Author Class

Package: EPL\Classes\AuthorMeta
Copyright: Copyright (c) 2022, Merv Barrett
License: GNU Public License
Since: 1.3.0
Located at lib/includes/class-epl-author.php

Methods summary

`public`	# `__construct( string $author_id )` Get things started Get things started Parameters `$author_id` The author WordPress user ID. Since 1.3.0 3.5.15 Added website (url)
`public boolean\|mixed`	# `__get( string $property )` Get the global property object Get the global property object Parameters `$property` Name of the property to retrieve. Returns boolean\|mixed $return Array of values. Since 1.3.0
`public`	# `get_author_name( )` Author Name Author Name Since 1.3.0
`public`	# `get_email( )` Get Email Get Email Since 3.2.0
`protected string`	# `esc_profile_url( string $url )` Escape a social/contact profile URL for use in an href attribute. Escape a social/contact profile URL for use in an href attribute. Non http(s) schemes used by the contact methods (mailto, skype, tel) are whitelisted explicitly, everything else falls back to the WordPress allowed protocol list. Values that sanitise away to nothing are returned as an empty string so the caller can skip rendering the link entirely. Parameters `$url` The raw profile URL. Returns string Since 3.5.25
`protected string`	# `get_icon_title( string $prefix, string $suffix )` Build an escaped title attribute for a contact icon. Build an escaped title attribute for a contact icon. Parameters `$prefix` Leading label, eg. "Follow". `$suffix` Trailing label, eg. "on Facebook". Returns string Since 3.5.25
`public mixed\|string\|`	# `get_email_html( string $html = '', string $style = 'i' )` Author Email html Box Author Email html Box Parameters `$html` String of html. `$style` Option of returntype. Returns mixed\|string\| Since 1.3.0 3.5.25 Escaped the href and title attributes.
`public`	# `get_website( )` Get website Get website Since 3.5.15
`public mixed\|string\|`	# `get_website_html( string $html = '', string $style = 'i' )` Author website html Box Author website html Box Parameters `$html` String of html. `$style` Option of returntype. Returns mixed\|string\| Since 3.5.15 3.5.25 Escaped the href and title attributes.
`public`	# `get_twitter( )` Get Twitter Get Twitter Since 3.2.0
`public`	# `get_instagram( )` Get Instagram Get Instagram Since 3.3.0
`public`	# `get_youtube( )` Get YouTube Get YouTube Since 3.3.0
`public`	# `get_pinterest( )` Get Pinterest Get Pinterest Since 3.3.0
`public mixed\|string\|`	# `get_twitter_html( string $html = '', string $style = 'i' )` Author Twitter html Box Author Twitter html Box Parameters `$html` String of html. `$style` Option of returntype. Returns mixed\|string\| Since 1.3.0 3.5.0 Switched to Twitter X icon. 3.5.25 Escaped the href and title attributes.
`public mixed\|string\|`	# `get_instagram_html( string $html = '', string $style = 'i' )` Author Instagram html Box Author Instagram html Box Parameters `$html` String of html. `$style` Option of returntype. Returns mixed\|string\| Since 3.3.0 3.5.25 Escaped the href and title attributes.
`public mixed\|string\|`	# `get_youtube_html( string $html = '', string $style = 'i' )` Author YouTube html Box Author YouTube html Box Parameters `$html` String of html. `$style` Option of returntype. Returns mixed\|string\| Since 3.3.0 3.5.25 Escaped the href and title attributes.
`public mixed\|string\|`	# `get_pinterest_html( string $html = '', string $style = 'i' )` Author Pinterest html Box Author Pinterest html Box Parameters `$html` String of html. `$style` Option of returntype. Returns mixed\|string\| Since 3.3.0 3.5.25 Escaped the href and title attributes. Fixed the SVG variant linking to Instagram.
`public`	# `get_google( )` Get Google Get Google Since 3.2.0 3.3.0 Depreciated as Google Plus no longer exists.
`public mixed\|string\|`	# `get_google_html( string $html = '', string $style = 'i' )` Author Google html Box Author Google html Box Parameters `$html` String of html. `$style` Option of returntype. Returns mixed\|string\| Since 1.3.0 3.3.0 Depreciated as Google Plus no longer exists. 3.5.25 Escaped the href and title attributes.
`public`	# `get_facebook( )` Get Facebook Get Facebook Since 3.2.0
`public mixed\|string\|`	# `get_facebook_html( string $html = '', string $style = 'i' )` Author Facebook html Box Author Facebook html Box Parameters `$html` String of html. `$style` Option of returntype. Returns mixed\|string\| Since 1.3.0 3.5.25 Escaped the href and title attributes.
`public`	# `get_linkedin( )` Get linkedin Get linkedin Since 3.2.0
`public mixed\|string\|`	# `get_linkedin_html( string $html = '', string $style = 'i' )` Author LinkedIn html Box Author LinkedIn html Box Parameters `$html` String of html. `$style` Option of returntype. Returns mixed\|string\| Since 1.3.0 3.5.25 Escaped the href and title attributes.
`public`	# `get_skype( )` Get skype Get skype Since 3.2.0
`public mixed\|string\|`	# `get_skype_html( string $html = '', string $style = 'i' )` Author Skype html Box Author Skype html Box Parameters `$html` String of html. `$style` Option of returntype. Returns mixed\|string\| Since 1.3.0 3.5.25 Escaped the href and title attributes.
`public mixed\|`	# `get_video_html( string $html = '' )` Author video html Box Author video html Box Parameters `$html` String of video embed. Returns mixed\| Since 1.3.0 3.5.25 The profile video URL is sanitised before it is embedded.
`public`	# `get_description( )` Get description Get description Since 3.2.0
`public mixed\|`	# `get_description_html( string $html = '' )` Author description html Author description html Parameters `$html` String of html output. Returns mixed\| Since 1.3.0 3.5.25 The bio is run through wp_kses_post() and the permalink through esc_url().
`public`	# `get_author_mobile( )` Author mobile Author mobile Since 1.3.0
`public`	# `get_author_office_phone( )` Author office phone Author office phone Since 3.3.0
`public`	# `get_author_id( )` Author ID Author ID Since 1.3.0
`public`	# `get_author_slogan( )` Author Slogan Author Slogan Since 1.3.0
`public`	# `get_author_position( )` Author Position Author Position Since 1.3.0
`public`	# `get_author_contact_form( )` Author Contact Form Author Contact Form Since 1.3.0

Properties summary

`public string`	`$author_id` The user ID The user ID Since 1.3.0	#
`public string`	`$name` The username The username Since 1.3.0	#
`public string`	`$mobile` The user mobile phone number The user mobile phone number Since 1.3.0	#
`public string`	`$office_phone` The user office phone number The user office phone number Since 3.3.0	#
`public string`	`$website` The user website The user website Since 3.5.15	#
`public string`	`$facebook` The user Facebook URL The user Facebook URL Since 1.3.0	#
`public string`	`$linkedin` The user LinkedIn URL The user LinkedIn URL Since 1.3.0	#
`public string`	`$google` The user Google Plus URL The user Google Plus URL Since 1.3.0	#
`public string`	`$twitter` The user Twitter URL The user Twitter URL Since 1.3.0	#
`public string`	`$instagram` The user Instagram URL The user Instagram URL Since 3.3.0	#
`public string`	`$pinterest` The user Pinterest URL The user Pinterest URL Since 3.3.0	#
`public string`	`$youtube` The user YouTube URL The user YouTube URL Since 3.3.0	#
`public string`	`$email` The user email address The user email address Since 1.3.0	#
`public string`	`$skype` The user Skype name The user Skype name Since 1.3.0	#
`public string`	`$slogan` The user text slogan The user text slogan Since 1.3.0	#
`public string`	`$position` The user position The user position Since 1.3.0	#
`public string`	`$video` The user video profile The user video profile Since 1.3.0	#
`public string`	`$contact_form` The user contact form shortcode The user contact form shortcode Since 1.3.0	#
`public string`	`$description` The user bio The user bio Since 1.3.0	#

Packages

Classes

Class EPL_Author

Methods summary

Parameters

Since

Parameters

Returns

Since

Since

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Since

Parameters

Returns

Since

Since

Since

Since

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Since

Parameters

Returns

Since

Since

Parameters

Returns

Since

Since

Parameters

Returns

Since

Since

Parameters

Returns

Since

Parameters

Returns

Since

Since

Parameters

Returns

Since

Since

Since

Since

Since

Since

Since

Properties summary

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since