Documentation

O3PO_Public
in package

The public-facing functionality of the plugin.

Tags
subpackage

O3PO/public

author

Christian Gogolin o3po@quantum-journal.org

Table of Contents

Properties

$plugin_name  : string
The ID of this plugin.
$version  : string
The version of this plugin.

Methods

__construct()  : mixed
Initialize the class and set its properties.
add_open_graph_meta_tags_for_social_media()  : mixed
Add opne graph (OG) meta tags describing the respective page. This data is used by social networks to generate excerpts for sharing.
clean_newline_and_protect_from_search_string()  : mixed
Clean \newline and \protect from search queries to fix the title click feature for authors using those in their title
enable_mathjax()  : mixed
Enable MathJax on all public pages.
enqueue_scripts()  : mixed
Register the JavaScript for the public-facing side of the site.
enqueue_styles()  : mixed
Register the stylesheets for the public-facing side of the site.
extended_search_and_navigation_at_loop_start()  : mixed
Add search based extended navigation to the main page.
fix_custom_logo_html()  : mixed
Fix some invalid html generated by WordPress as part of the logo.
search_form_at_loop_start_on_search_page()  : mixed
Add a search form above the search results just before the loop starts.
secondary_journal_help_text()  : mixed
Add a help text for listing pages showing posts from the secondary journal just before the loop starts.

Properties

$plugin_name

The ID of this plugin.

private string $plugin_name

The ID of this plugin.

Tags
since
0.1.0
access

private

$version

The version of this plugin.

private string $version

The current version of this plugin.

Tags
since
0.1.0
access

private

Methods

__construct()

Initialize the class and set its properties.

public __construct(string $plugin_name, string $version) : mixed
Parameters
$plugin_name : string

The name of the plugin.

$version : string

The version of this plugin.

Tags
since
0.1.0

add_open_graph_meta_tags_for_social_media()

Add opne graph (OG) meta tags describing the respective page. This data is used by social networks to generate excerpts for sharing.

public add_open_graph_meta_tags_for_social_media() : mixed
Tags
since
0.1.0
access

public

clean_newline_and_protect_from_search_string()

Clean \newline and \protect from search queries to fix the title click feature for authors using those in their title

public clean_newline_and_protect_from_search_string(WP_Query $query_object) : mixed

To be added to the 'parse_query' action.

Parameters
$query_object : WP_Query

Query that lead to the current search.

Tags
since
0.4.0
access

public

enable_mathjax()

Enable MathJax on all public pages.

public enable_mathjax() : mixed
Tags
since
0.1.0
access

public

enqueue_scripts()

Register the JavaScript for the public-facing side of the site.

public enqueue_scripts() : mixed
Tags
since
0.1.0

enqueue_styles()

Register the stylesheets for the public-facing side of the site.

public enqueue_styles() : mixed
Tags
since
0.1.0

extended_search_and_navigation_at_loop_start()

Add search based extended navigation to the main page.

public extended_search_and_navigation_at_loop_start(string $query) : mixed

Add a search interface, some statistics about the number of publications and volumes, and links to the respective volume pand publication type pages to the main page just before the loop starts.

To be added to the 'loop_start' action.

Parameters
$query : string

Query that lead to the current loop.

Tags
since
0.1.0
access

public

fix_custom_logo_html()

Fix some invalid html generated by WordPress as part of the logo.

public fix_custom_logo_html() : mixed

To be added to the 'get_custom_logo' filter.

Tags
since
0.1.0
access

public

search_form_at_loop_start_on_search_page()

Add a search form above the search results just before the loop starts.

public search_form_at_loop_start_on_search_page(string $query) : mixed

To be added to the 'loop_start' action.

Parameters
$query : string

Query that lead to the current loop.

Tags
since
0.1.0
access

public

secondary_journal_help_text()

Add a help text for listing pages showing posts from the secondary journal just before the loop starts.

public secondary_journal_help_text(string $query) : mixed
Parameters
$query : string

Query that lead to the current loop.

Tags
since
0.1.0
access

public


        
On this page

Search results